ジョブエンドポイント

ジョブエンドポイントとパラメーター

特定のジョブに関する詳細を取得する

Retrieve Messages of a Specific Job

オブジェクト関係に関する詳細とAPIでの使用方法については、オブジェクト関係のセクションを参照してください。

ジョブの詳細については、ジョブ: Admin (管理者)インターフェースのヘルプページを参照してください。

特定のジョブに関する詳細を取得する

既存のジョブとその現在の状態に関する詳細を取得するには、 GET {baseURL}/v3/jobs/{jobId} エンドポイントを使用します。さまざまなパラメーターを使用して、表示するジョブをフィルタリングします。

注記

アプリワークフローのみ使用できます。

Users are able to see jobs run by them and jobs run on schedules shared via Collections.

パラメーター

jobId (文字列): 必須です。詳細を表示するジョブIDを入力します。
includeMessages (ブール型): オプションです。値を指定しないこともできます。値は「true」と「false」から選択できます。このパラメーターを「false」に設定すると、縮小表示されたオブジェクトが返されます。指定しない場合、「true」の値が使用されます。

リクエストの例: cURL

curl -X 'GET' \
  'http://localhost/webapi/v3/jobs/66ebd18d3d6200007e000d8c?includeMessages=true' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

Response Example

200: OK

{
  "id": "string",
  "appId": "string",
  "createDateTime": "2024-09-19T10:02:54.589Z",
  "status": "string",
  "disposition": "string",
  "outputs": [
    {
      "id": "string",
      "availableFormats": [
        "string"
      ],
      "fileName": "string"
    }
  ],
  "messages": [
    {
      "status": 0,
      "text": "string",
      "toolId": 0
    }
  ],
  "priority": "Default",
  "workerTag": "string",
  "runWithE2": true
}

401: Unauthorized
404: NotFound

Retrieve Messages of a Specific Job

To retrieve all messages of a specific job, use the GET {baseURL}/v3/jobs/{jobId}/messages endpoint.

注記

Only Curators can use this endpoint.

Parameters

jobId (string): Required. Enter the Job ID for which you want to display messages.

Request Example: cURL

curl -X 'GET' \
  'http://localhost/webapi/v3/jobs/66ebd18d3d6200007e000d8c/messages' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

Response Example

200: OK

{
  "status": 0,
  "text": "string",
  "toolId": 0
}

401: Unauthorized
404: NotFound

オブジェクト関係

特定のジョブに関する情報を取得するには、 jobId が必要になります。このjobIdを取得するには、 GET {baseURL}/v3/workflows/{workflowId}/jobs エンドポイントを使用します。このエンドポイントの詳細については、ワークフローエンドポイントのヘルプページを参照してください。ワークフローエンドポイント

Postmanリクエスト

Postmanリクエストの詳細については、「 Postmanの使用方法」ヘルプページを参照してください。

このセクションの内容:

ジョブエンドポイント