Post
/api/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
job_definition_id
integer (int64) Required
転送設定IDを指定します。
TROCCO画面からIDを確認する場合は、API実行時に指定する各種パラメーターの確認方法を参照ください。
Example123
Body parameters
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
manual_resource_enhancement
string | null
※このパラメーターはプロフェッショナルプランでのみご利用いただけます。
ジョブ実行時に利用するリソースサイズを指定できます。指定しなかった場合、転送設定側で指定されているリソースサイズが適用されます。
また、コネクタによって指定できる値が異なります。
- 通常のコネクタ:
medium,large,xlarge - 一部例外的なコネクタ:
custom_spec,xlarge
指定できる各値のスペックや、一部例外的なコネクタの種類など、詳しくはリソース増強オプションの種類およびスペックを参照ください。
Valid values[
"medium",
"custom_spec",
"large",
"xlarge"
]
Responses
200
実行した転送ジョブのステータスを返します。
object
id
integer (int64)
転送ジョブIDです。
Example123
job_definition_id
integer (int64)
転送設定IDです。
Example321
job_definition_name
string
転送設定名です。
Examplesample-job-definition-name
status
string
転送ジョブのステータスです。
queued- 実行待機setting_up- 実行準備executing- 実行中interrupting- 実行中断succeeded- 実行完了（成功）error- 実行完了（エラー）canceled- 実行完了（キャンセル）skipped- 実行完了（スキップ）timeout- 実行完了（タイムアウト）
Valid values[
"queued",
"setting_up",
"executing",
"interrupting",
"succeeded",
"error",
"canceled",
"skipped",
"timeout"
]
Examplequeued
created_at
string
転送ジョブの作成日時です。タイムゾーンはJST 日本時間（GMT+9）です。
Example2023-05-19T19:14:00.000+09:00
400
Bad request.
不正なリクエストです。
401
Not authenticated.
認証エラーです。API KEYをご確認ください。
404
Not found.
要求したリソースが見つかりません。