ワークフロージョブ実行結果取得

Prev Next
Get
/api/pipeline_jobs/{pipeline_job_id}

ワークフロージョブを指定してワークフロージョブ実行結果を取得します。

Security
API Key: ApiKeyAuth
Header parameter nameAuthorization

認証キーとなるAPI KEYをAuthorization: Token {{API KEY}}の形式でヘッダーにセットします。
API KEYがabc123の場合は、Authorization: Token abc123とします。
API KEYの作成方法は、TROCCO API KEYの作成を参照ください。

Path parameters
pipeline_job_id
integer (int64) Required

ワークフロージョブIDを指定します。
TROCCO画面からIDを確認する場合は、API実行時に指定する各種パラメーターの確認方法を参照ください。

Example123
Responses
200

ワークフロージョブの実行結果を返します。

object
id
integer (int64)

ワークフロージョブIDです。

Example123
pipeline_definition_id
integer (int64)

ワークフロー定義IDです。

Example321
name
string

ワークフロー定義名です。

Examplesample-pipeline-definition-name
status
string

ワークフロージョブのステータスです。

  • queued - 実行待機
  • setting_up - 実行準備
  • executing - 実行中
  • interrupting - 実行中断
  • succeeded - 実行完了(成功)
  • error - 実行完了(エラー)
  • canceled - 実行完了(キャンセル)
  • skipped - 実行完了(スキップ)
  • retry_waiting - 実行完了(エラー)からリトライ開始するまでの待ち状態(リトライ回数が設定されている場合のみ)
Valid values[ "queued", "setting_up", "executing", "interrupting", "succeeded", "error", "canceled", "skipped", "retry_waiting" ]
Examplesucceeded
started_at
string | null

ワークフロージョブのステータスが実行中になった日時です。タイムゾーンはJST 日本時間(GMT+9)です。

Example2023-05-18T17:16:20.000+09:00
finished_at
string | null

ワークフロージョブのステータスが実行完了になった日時です。タイムゾーンはJST 日本時間(GMT+9)です。

Example2023-05-18T17:20:20.000+09:00
context_time
string

ワークフロー設定でカスタム変数 時刻・日付(キューイング時)をご利用の場合、この日時を元に展開されます。
タイムゾーンはJST 日本時間(GMT+9)です。

Example2023-05-18T17:10:20.000+09:00
created_at
string

ワークフロージョブの作成日時です。タイムゾーンはJST 日本時間(GMT+9)です。

Example2023-05-18T17:15:20.000+09:00
400

Bad request.
不正なリクエストです。

401

Not authenticated.
認証エラーです。API KEYをご確認ください。

404

Not found.
要求したリソースが見つかりません。