Skip to main content

ジョブエンドポイント

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

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

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

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

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

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

注記

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

パラメーター

  • jobId (文字列): 必須です。詳細を表示するジョブIDを入力します。

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

リクエストの例: cURL

curl -X GET --header 'Accept: application/json' --header 'Authorization: Bearer 'BearerTokenGoesHere' 'http://localhost/webapi/v3/jobs/635a4be7d27400005f001fec'

オブジェクト関係

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

Postmanリクエスト

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