trocco API仕様について
- 28 Oct 2022
- 1 分で読み終わります
-
印刷
-
ダークライト
trocco API仕様について
- 更新日 28 Oct 2022
- 1 分で読み終わります
-
印刷
-
ダークライト
概要
APIを用いて、troccoの一部機能を利用することができます。
APIキーの発行
- troccoトップ画面の右上にある設定からAPI KEYの設定をクリックし、API KEY一覧画面を開きます。
- 右上の新規作成よりAPIキーを発行します。
認証方法
APIキーをAuthorizationヘッダーに指定することで認証します。
例
$ curl -X POST https://trocco.io/api/jobs?job_definition_id=<転送設定ID>
-H "Authorization: Token <APIキー>"
ジョブの実行API
POST /api/jobs
パラメータ
パラメータ名 | タイプ | 説明 |
---|---|---|
job_definition_id | int | 必須パラメータです。 転送設定IDを指定してください。 |
context_time | String | 転送設定でカスタム変数**時刻・日付(キューイング時)**を利用する場合、展開される日時を指定できます。 YYYY-MM-DD HH:MM:SSのような形を指定してください。 例:2019-11-18 00:00:00 タイムゾーンはJST 日本時間(GMT+9)です。 未指定の場合、APIリクエストの日時が利用されます。 |
custom_variables | Array of Custom Variable<name, value> |
カスタム変数を指定できます。 name:カスタム変数名(例: value:カスタム変数の値 |
レスポンス
項目名 | タイプ | 説明 |
---|---|---|
id | int | ジョブのIDになります。 |
job_definition_id | int | 転送設定のIDになります。 |
job_definition_name | String | 転送設定の名称になります。 |
status | String | ジョブのステータスになります。 ステータスには以下が存在します。 ・queued …実行待ち状態 ・setting_up …実行準備状態 ・executing …実行中状態 ・interrupting …実行中断状態 ・succeeded …実行完了(成功)状態 ・error …実行完了(エラー)状態 ・canceled …実行完了(キャンセル)状態 ・skipped …実行完了(スキップ)状態 |
created_at | timestamp | 転送ジョブの作成日時になります。 |
例
$ curl -X POST https://trocco.io/api/jobs?job_definition_id=<転送設定ID>
-H "Authorization: Token <APIキー>"
-d "context_time=<展開時刻>"
-d "custom_variables[][name]=$ad_id$"
-d "custom_variables[][value]=A0000"
ジョブのステータス確認API
GET /api/jobs/<ジョブID>
レスポンス
項目名 | タイプ | 説明 |
---|---|---|
id | int | ジョブのIDになります。 |
job_definition_id | int | 転送設定のIDになります。 |
job_definition_name | String | 転送設定の名称になります。 |
status | String | ジョブのステータスになります。 ステータスには以下が存在します。 ・queued …実行待ち状態 ・setting_up …実行準備状態 ・executing …実行中状態 ・interrupting …実行中断状態 ・succeeded …実行完了(成功)状態 ・error …実行完了(エラー)状態 ・canceled …実行完了(キャンセル)状態 ・skipped …実行完了(スキップ)状態 |
started_at | timestamp | 転送ジョブの転送開始日時になります。 ※ジョブが未完了なときはレスポンスにまれません。 |
finished_at | timestamp | 転送ジョブの転送終了日時になります。 ※ジョブが未完了なときはレスポンスに含まれません。 |
created_at | timestamp | 転送ジョブの作成日時になります。 |
例
$ curl -X GET https://trocco.io/api/jobs/<ジョブID>
-H "Authorization: Token <APIキー>"
ワークフロージョブの実行API
POST /api/pipeline_jobs
パラメータ
パラメータ名 | タイプ | 説明 |
---|---|---|
pipeline_definition_id | int | 必須パラメータです。 ワークフロー定義IDを指定してください。 |
context_time | String | 転送設定でカスタム変数**時刻・日付(キューイング時)**をご利用の場合、展開される日時を指定できます。 YYYY-MM-DD HH:MM:SSのような形で指定してください。 例:2019-11-18 00:00:00 タイムゾーンはJST 日本時間(GMT+9)です。 未指定の場合、APIリクエストの日時が利用されます。 |
レスポンス
項目名 | タイプ | 説明 |
---|---|---|
id | int | ジョブのIDになります。 |
pipeline_definition_id | int | データマート定義のIDになります。 |
name | String | データマート定義の名称になります。 |
status | String | ジョブのステータスになります。 ステータスには以下が存在します。 ・queued …実行待ち状態 ・setting_up …実行準備状態 ・executing …実行中状態 ・interrupting …実行中断状態 ・succeeded …実行完了(成功)状態 ・error …実行完了(エラー)状態 ・canceled …実行完了(キャンセル)状態 ・skipped …実行完了(スキップ)状態 |
created_at | timestamp | ワークフロージョブの作成日時になります。 |
started_at | timestamp | ワークフロージョブの開始日時になります。 |
finished_at | timestamp | ワークフロージョブの完了日時になります。 |
context_time | timestamp | ワークフロー設定でカスタム変数**時刻・日付(キューイング時)**をご利用の場合、この日時を元に展開されます。 |
例
$ curl -X POST https://trocco.io/api/pipeline_jobs?pipeline_definition_id=<ワークフロー設定ID>
-H "Authorization: Token <APIキー>"
-d "context_time=<展開時刻>"
ワークフロージョブのステータス確認API
GET /api/pipeline_jobs/<ジョブID>
レスポンス
項目名 | タイプ | 説明 |
---|---|---|
id | int | ジョブのIDになります。 |
pipeline_definition_id | int | データマート定義のIDになります。 |
name | String | データマート定義の名称になります。 |
status | String | ジョブのステータスになります。 ステータスには以下が存在します。 ・queued …実行待ち状態 ・setting_up …実行準備状態 ・executing …実行中状態 ・interrupting …実行中断状態 ・succeeded …実行完了(成功)状態 ・error …実行完了(エラー)状態 ・canceled …実行完了(キャンセル)状態 ・skipped …実行完了(スキップ)状態 |
created_at | timestamp | ワークフロージョブの作成日時になります。 |
started_at | timestamp | ワークフロージョブの開始日時になります。 |
finished_at | timestamp | ワークフロージョブの完了日時になります。 |
context_time | timestamp | ワークフロー設定でカスタム変数**時刻・日付(キューイング時)**をご利用の場合、この日時を元に展開されます。 |
例
$ curl -X POST https://trocco.io/api/pipeline_jobs?pipeline_definition_id=<ワークフロー設定ID>
-H "Authorization: Token <APIキー>"
-d "context_time=<展開時刻>"
この記事は役に立ちましたか?