trocco APIについて

概要

troccoの以下の機能をAPIを用いて実行できます。

• 転送ジョブの実行
• 転送ジョブのステータス確認
• ワークフロージョブの実行
• ワークフロージョブのステータス確認

制約

事前準備

APIキーの発行

1. troccoトップ画面の右上にある設定からAPI KEYの設定をクリックし、API KEY一覧画面を開きます。

2. 右上の新規作成よりAPIキーを発行します。
   発行されたAPIキーは各種エンドポイントのリクエストヘッダーで指定していただきます。

APIベースURL

https://trocco.io/api

APIエンドポイント

転送ジョブの実行
POST /jobs

リクエスト

サンプル
※{と}で囲まれた箇所が設定値となります。コマンド実行時は{と}は含めないでください。

curl 'https://trocco.io/api/jobs?job_definition_id={JOB_DEFINITION_ID}' \
-X POST \
-H 'Authorization:Token {API_KEY}' \
-d 'context_time={YYYY-MM-DD HH:MM:SS}' \
-d 'time_zone=Asia/Tokyo' \
-d 'custom_variables[][name]=${VARIABLE_NAME}$' \
-d 'custom_variables[][value]={VARIABLE_VALUE}'

レスポンス

サンプル

{
  "id":12345,
  "job_definition_id":54321,
  "job_definition_name":"sample-job-definition-name",
  "status":"queued",
  "created_at":"2023-05-19T19:14:00.000+09:00"
}

転送ジョブのステータス確認
GET /jobs/{job_id}

リクエスト

サンプル
※{と}で囲まれた箇所が設定値となります。コマンド実行時は{と}は含めないでください。

curl 'https://trocco.io/api/jobs/{JOB_ID}' \
-X GET \
-H 'Authorization:Token {API KEY}'

レスポンス

サンプル

{
  "id":12345,
  "job_definition_id":54321,
  "job_definition_name":"sample-job-definition-name",
  "status":"succeeded",
  "started_at":"2023-05-19T19:15:00.000+09:00",
  "finished_at":"2023-05-19T19:20:00.000+09:00",
  "created_at":"2023-05-19T19:14:00.000+09:00"
}

ワークフロージョブの実行
POST /pipeline_jobs

リクエスト

サンプル
※{と}で囲まれた箇所が設定値となります。コマンド実行時は{と}は含めないでください。

curl 'https://trocco.io/api/pipeline_jobs?pipeline_definition_id={PIPELINE_DEFINITION_ID}' \
-X POST \
-H 'Authorization:Token {API_KEY}' \
-d 'context_time={YYYY-MM-DD HH:MM:SS}' \
-d 'time_zone=Asia/Tokyo'

レスポンス

サンプル

{
  "id":12345,
  "pipeline_definition_id":54321,
  "name":"sample-pipeline-definition-name",
  "status":"queued",
  "started_at":null,
  "finished_at":null,
  "context_time":"2023-05-18T17:10:20.000+09:00",
  "created_at":"2023-05-18T17:15:20.000+09:00"
}

ワークフロージョブのステータス確認
GET /pipeline_jobs/{pipeline_job_id}

リクエスト

サンプル
※{と}で囲まれた箇所が設定値となります。コマンド実行時は{と}は含めないでください。

curl 'https://trocco.io/api/pipeline_jobs/{PIPELINE_JOB_ID}' \
-X GET \
-H 'Authorization:Token {API_KEY}'

レスポンス

サンプル

{
  "id":12345,
  "pipeline_definition_id":54321,
  "name":"sample-pipeline-definition-name",
  "status":"succeeded",
  "started_at":"2023-05-18T17:16:20.000+09:00",
  "finished_at":"2023-05-18T17:20:20.000+09:00",
  "context_time":"2023-05-18T17:10:20.000+09:00",
  "created_at":"2023-05-18T17:15:20.000+09:00"
}

ユースケース

複数のカスタム変数を指定する

カスタム変数は、array型のパラメータ（custom_variables）に、変数名（name）と値（value）を指定します。
特定の変数名に対する値は、変数名の直後に指定する必要があります。
したがって、カスタム変数を複数指定する場合は、対となる変数名と値を続けて指定し、それを繰り返します。

下記のサンプルは、カスタム変数名name1の値にvalue1を、カスタム変数名name2の値にvalue2を指定しています。

curl 'https://trocco.io/api/jobs?job_definition_id={JOB_DEFINITION_ID}' \
-X POST \
-H 'Authorization:Token {API KEY}' \
-d 'custom_variables[][name]=$name1$' \ 
-d 'custom_variables[][value]=value1' \
-d 'custom_variables[][name]=$name2$' \
-d 'custom_variables[][value]=value2'

各種IDの確認方法

転送設定IDの確認方法

転送設定詳細画面のURL末尾および画面内で確認いただけます。

転送ジョブIDの確認方法

転送ジョブ詳細画面のURL末尾および画面内で確認いただけます。

ワークフロー定義IDの確認方法

ワークフロー定義詳細画面のURL末尾および画面内で確認いただけます。

ワークフロージョブIDの確認方法

ワークフロージョブ詳細画面のURL末尾および画面内で確認いただけます。

タイムゾーンについて

time_zoneで指定可能な値は、下記「指定できるタイムゾーン一覧」を参照ください。
たとえば、太平洋標準時で2023年8月1日12時をcontext_timeとして展開したい場合は、time_zoneにAmerica/Los_Angeles、context_timeに2023-08-01 12:00:00を指定ください。

また、サマータイムを採用しているタイムゾーンでは夏季に標準時間とずれが発生する点、ご留意ください。