ジョブエンドポイント

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

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

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

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

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

注記

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

ユーザーは自分が実行したジョブや、コレクションを介して共有されたスケジュールで実行されたジョブを見ることができます。

パラメーター

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'

レスポンスの例

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

特定のジョブに関するメッセージを取得する

特定のジョブに関するメッセージを取得するには、GET {baseURL}/v3/jobs/{jobId}/messagesエンドポイントを使用します。

注記

このエンドポイントを使用できるのは管理者のみです。

パラメーター

jobId (文字列): 必須です。メッセージを表示するジョブIDを入力します。

リクエストの例: cURL

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

レスポンスの例

200: OK

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

401: Unauthorized
404: NotFound

特定のジョブをキャンセルする

特定のジョブをキャンセルするには、DELETE {baseURL}/v3/jobs/{jobId}エンドポイントを使用します。ジョブのステータスが「待機中」または「実行中」である必要があります。

実行中のジョブをキャンセルすると、そのジョブはキャンセルされます。待機中のジョブをキャンセルすると、そのジョブは削除されます。

注記

管理者は任意のジョブをキャンセルできます。

他のロールのユーザーは、自分が作成、トリガー、またはスケジュールしたジョブをキャンセルできます。これには、コレクションを介して共有されたジョブも含まれます(所有者としてジョブを所有していない場合でも)。

パラメーター

jobId (文字列): 必須です。キャンセルするジョブIDを入力します。

リクエストの例: cURL

curl -X 'DELETE' \
  'http://localhost/webapi/v3/jobs/678f97baa15300008c0039fc' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

レスポンスの例

200: OK
- 実行中のジョブをキャンセルしたときの応答:
  { "message": "Cancelled Successfully." }
- 待機中のジョブをキャンセルしたときの応答:
  { "message": "Deleted Successfully." }
400: BadRequest
- ジョブの状態が「待機中」でも「実行中」でもないときの応答:
  { "message": "This job is not in 'Queued' or 'Running' state." }
- API呼び出しを行うユーザーにジョブをキャンセルする権限がないときの応答:
  { "message": "You do not have permission to cancel this job." }
401: Unauthorized
404: NotFound

オブジェクト関係

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

Postmanリクエスト

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

ジョブエンドポイント