IDでジョブを取得

ジョブを取得します。ステータスの確認に役立ちます。

GET https://{tenantDomain}/api/v2/jobs/{id}

Go

Go

package example

import (
    context "context"

    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    client.Jobs.Get(
        context.TODO(),
        "id",
    )
}

200

{
  "id": "job_0000000000000001",
  "status": "pending",
  "type": "users_import",
  "connection_id": "con_0000000000000001",
  "created_at": "<string>",
  "location": "<string>",
  "percentage_done": 123,
  "status_details": "<string>",
  "summary": {
    "failed": 0,
    "inserted": 0,
    "total": 0,
    "updated": 0
  },
  "time_left_seconds": 123
}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

パスパラメータ

id · string · 必須

ジョブの ID。

レスポンス

200

application/json

ジョブを正常に取得しました。

id · string · デフォルト: job_0000000000000001 · 必須

このジョブのID。

status · string · デフォルト: pending · 必須

このジョブのステータス。

type · string · デフォルト: users_import · 必須

このジョブの種類。

connection_id · string · デフォルト: con_0000000000000001

このジョブで使用される接続のconnection_id。

created_at · string

このジョブが作成された日時。

format · enum<string>

ファイルの形式。json または csv である必要があります。

利用可能なオプション: json, csv

location · string

このジョブの結果をダウンロードするためのURL。

percentage_done · integer

このジョブの完了率。

status_details · string

ステータスの詳細。

summary · object

ジョブ実行の概要。

Show child attributes

time_left_seconds · integer

ジョブが完了するまでの推定残り時間。