ジョブエンドポイント
ジョブエンドポイントとパラメーター
オブジェクト関係に関する詳細とAPIでの使用方法については、オブジェクト関係 のセクションを参照してください。
ジョブの詳細については、ジョブ: 管理者インターフェースのヘルプページを参照してください。
すべてのジョブに関する詳細を取得する
すべてのジョブとその現在の状態に関する詳細を取得するには、GET {baseURL}/v3/jobsエンドポイントを使用します。さまざまなパラメーターを使用して、表示するジョブをフィルタリングします。
注記
このエンドポイントを使用できるのは管理者のみです。
パラメーター
sortField (文字列): オプションです。許可されている次の値で結果を並べ替えます:
CreateDate、AppName、CompletionDateTime、Priority、Status。direction (文字列): オプションです。昇順または降順で並べ替えます。許可される値は、
ascまたはdescです。offset (文字列): オプションです。ページングのオフセットを入力します。
limit (文字列): オプションです。ページングの制限を入力します。
priorities (文字列): オプションです。ジョブの優先度別にフィルタリングするには、
Low(低)、Medium(中)、High(高)、Critical(重大)、Numeric Values(数値)のいずれか1つ以上の値を入力します。statuses (文字列): オプションです。ステータス別にフィルタリングするには、
Queued(待機中)、Initializing(初期化中)、Running(実行中)、Complete(完了)のいずれか1つ以上の値を入力します。users (文字列): オプションです。ユーザー別にフィルタリングするには、有効な
userId(ユーザーID)を入力します。allUsers = trueの場合にのみフィルタリングします。allUsers (ブール型): オプションです。すべてのユーザーを含めるには、
trueを選択します。workflowNames (文字列): オプションです。ワークフロー名でフィルタリングするには、
workflowNameを1つ以上入力します。completedBefore (文字列): オプションです。指定された日付より前に完了したジョブを返します。指定された日付に完了したジョブは除外されます。入力形式はyyyy-MM-ddです。
completedAfter (文字列): オプションです。指定された日付より後に完了したジョブを返します。指定された日付に完了したジョブは除外されます。入力形式はyyyy-MM-ddです。
curl -X 'GET' \ 'http://localhost/webapi/v3/jobs' \ -H 'accept: application/json' \ -H 'authorization: Bearer BearerTokenGoesHere'
200: OK
{ "data": [ { "jobId": "68dd3292c97fddfcc003adcb", "status": "Completed", "workflowName": "Workflow1.yxmd", "workflowId": "68dd32922a719467662d27c7", "submittedBy": "Jane Doe", "startTime": "2025-10-01T13:54:26Z", "queueTime": "2025-10-01T13:54:26Z", "executionTime": "00:00:02", "priority": "6" }, { "jobId": "68dd3336c97fddfcc003add2", "status": "Completed", "workflowName": "Workflow1", "workflowId": "68dd32922a719467662d27c7", "submittedBy": "Jane Doe", "startTime": "2025-10-01T13:57:10Z", "queueTime": "2025-10-01T13:57:10Z", "executionTime": "00:00:02", "priority": "Low" } ], "pagination": { "currentPage": 1, "pageSize": 50, "totalItems": 3, "totalPages": 1, "hasNextPage": false, "hasPreviousPage": false } }401: Unauthorized (権限がありません)
特定のジョブに関する詳細を取得する
既存のジョブとその現在の状態に関する詳細を取得するには、GET {baseURL}/v3/jobs/{jobId} エンドポイントを使用し ます。さまざまなパラメーターを使用して、表示するジョブをフィルタリングします。
注記
アプリワークフローのみ使用できます。
ユーザーは自分が実行したジョブや、コレクションを介して共有されたスケジュールで実行されたジョブを見ることができます。
パラメーター
jobId (文字列): 必須です。詳細を表示するジョブIDを入力します。
includeMessages (ブール型): オプションです。値を指定しないこともできます。値は「true」と「false」から選択できます。このパラメーターを「false」に設定すると、縮小表示されたオブジェクトが返されます。指定しない場合、「true」の値が使用されます。
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 -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 -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 エンドポイントを使用します。このエンドポイントの詳細については、ワークフローエンドポイント のヘルプページを参照してください。
Postmanリクエスト
Postmanリクエストの詳細については、Postmanの使用方法ヘルプページを参照してください。