Press CTRL+K to open search

データマートジョブ実行結果取得

Prev Next
Get
/api/datamart_jobs/{datamart_job_id}

データマートジョブを指定して、データマートジョブの実行結果を取得します。
データマートジョブの実行ログは本APIでは返却しません。

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
datamart_job_id
integer (int64) Required

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

Example123
Responses
200

データマートジョブの実行結果を返します。

Expand All
object
id
integer (int64)

データマートジョブIDです。

Example123
datamart_definition_id
integer (int64)

データマート定義IDです。

Example45
datamart_definition_name
string

データマート定義名です。

Examplesample-datamart-definition-name
status
string

データマートジョブのステータスです。転送ジョブと異なりtimeoutを持ちません。

  • queued - 実行待機
  • setting_up - 実行準備
  • executing - 実行中
  • interrupting - 実行中断
  • succeeded - 実行完了（成功）
  • error - 実行完了（エラー）
  • canceled - 実行完了（キャンセル）
  • skipped - 実行完了（スキップ）
Valid values[ "queued", "setting_up", "executing", "interrupting", "succeeded", "error", "canceled", "skipped" ]
Examplesucceeded
executor_type
string

データマートジョブの実行タイプです。

  • api - API実行
  • manual - 手動実行
  • scheduler - スケジュール実行
  • job_dependency - ジョブ依存実行
  • workflow - ワークフロー実行
Valid values[ "api", "manual", "scheduler", "job_dependency", "workflow" ]
Examplescheduler
pipeline_job_id
integer (int64) | null

ワークフロー経由で実行された場合の、親となるワークフロージョブIDです。
ワークフロー経由の実行でない場合はnullです。

Example987
context_time
string | null

カスタム変数 時刻・日付（キューイング時） の展開基準日時です。タイムゾーンはJST 日本時間（GMT+9）です。

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

データマートジョブ実行時に指定されたメモです。

Example定期実行の補足メモ
transfer_record
integer (int64) | null

出力されたレコード数です。

Example1200
executed_query
string | null

実際に実行された、カスタム変数展開後のクエリです。
クエリが64KBを超える場合は64KBで切り詰められ、末尾に[Query truncated]が付与されます。

ExampleINSERT INTO `project.dataset.table` SELECT ... WHERE date = '2023-05-19'
overwrite_lookback_period
object | null

データマートジョブ実行時に上書き指定された振り返り期間です。
上書き指定がない場合はnullです。

mode
string

振り返り期間の上書き方法です。

  • all - 全期間で上書きする。from / to / unit はnullです
  • range - 範囲を指定して上書きする
Valid values[ "all", "range" ]
Examplerange
from
integer | null

振り返り期間の開始（現在からさかのぼる単位数）です。
modeがallの場合、または開始を指定しなかった場合はnullです。

Example3
to
integer | null

振り返り期間の終了（現在からさかのぼる単位数）です。
modeがallの場合、または終了を指定しなかった場合はnullです。

Example1
unit
string | null

振り返り期間の単位です。modeがallの場合はnullです。

  • days - 日
  • hours - 時間
Valid values[ "days", "hours" ]
Exampledays
queued_up_at
string | null

データマートジョブのステータスが実行待機になった日時です。タイムゾーンはJST 日本時間（GMT+9）です。

Example2023-05-19T19:14:10.000+09:00
setting_up_at
string | null

データマートジョブのステータスが実行準備になった日時です。タイムゾーンはJST 日本時間（GMT+9）です。

Example2023-05-19T19:14:30.000+09:00
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
400

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

401

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

403

Forbidden.
API KEYが不正か、基本機能の利用が許可されていないユーザーです。

404

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