ワークフロージョブ実行

Prev Next
Post
/api/pipeline_jobs

ワークフロー定義を指定してワークフロージョブを実行します。

Security
API Key: ApiKeyAuth
Header parameter nameAuthorization

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

Query parameters
pipeline_definition_id
integer (int64) Required

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

Example123
Body parameters
Expand All
object
context_time
string

転送設定でカスタム変数 時刻・日付（キューイング時） を利用する場合、展開される日時を指定します。
未指定の場合、APIリクエストが送信された日時が展開されます。タイムゾーンにはtime_zoneの値が使用されます。

Example2023-05-19 00:00:00
time_zone
string

タイムゾーンを指定します。
context_timeで指定する日時に適用されます。指定できる値は、タイムゾーン（time_zone）を参照ください。

Default"Asia/Tokyo"
ExampleEtc/UTC
custom_variables
Array of object
object
name
string

カスタム変数の変数名を指定します。変数名を$で囲ってください。
複数のカスタム変数を指定することができます。

Example$companyId$
value
string

直前に指定したカスタム変数に展開する値を指定します。
複数のカスタム変数を指定することができます。

Examplec-12345
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" ]
Examplequeued
started_at
string | null

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

Example2023-05-19T19:15:00.000+09:00
finished_at
string | null

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

Example2023-05-19T19:20:00.000+09:00
created_at
string

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

Example2023-05-19T19:14:00.000+09:00
context_time
string

ワークフロー定義でカスタム変数 時刻・日付（キューイング時） を利用する場合、展開される日時です。
未指定の場合、APIリクエストが送信された日時が展開されます。

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

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

401

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

404

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