trocco APIリファレンス

TROCCO APIリファレンス

Print
Share
PDF

TROCCO APIリファレンス

Print
Share
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

概要

TROCCOは、TROCCO APIを提供しています。
TROCCO APIを用いることで、TROCCOの機能を利用できます。

制約

APIコール制限

TROCCO APIは以下のコール数制限を設けています。

最大10,000コール/1日
最大100コール/15分

プラン上の制約

TROCCO APIは、Advancedプラン以上の契約アカウントでのみ、ご利用いただけます。

TROCCO API エンドポイント一覧

機能	処理内容	メソッド	エンドポイント
転送設定（転送ジョブ）	転送ジョブ実行	`POST`	`/api/jobs`
転送設定（転送ジョブ）	転送ジョブ実行結果取得	`GET`	`/api/jobs/{job_id}`
転送設定（転送ジョブ）	転送ジョブ一覧取得	`GET`	`/api/job_definitions/{job_definition_id}/jobs`
ワークフロー	ワークフロージョブ実行	`POST`	`/api/pipeline_jobs`
ワークフロー	ワークフロージョブ実行結果取得	`GET`	`/api/pipeline_jobs/{pipeline_job_id}`
データマート定義	[ベータ版]データマート定義一覧取得	`GET`	`/api/datamart_definitions`
データマート定義	[ベータ版]データマート定義作成	`POST`	`/api/datamart_definitions`
データマート定義	[ベータ版]データマート定義詳細取得	`GET`	`/api/datamart_definitions/{datamart_definition_id}`
データマート定義	[ベータ版]データマート定義更新	`PATCH`	`/api/datamart_definitions/{datamart_definition_id}`
データマート定義	[ベータ版]データマート定義削除	`DELETE`	`/api/datamart_definitions/{datamart_definition_id}`
データマートジョブ	データマートジョブ実行	`POST`	`/api/datamart_jobs`
ユーザー	ユーザー一覧取得	`GET`	`/api/users`
ユーザー	ユーザー作成	`POST`	`/api/users`
ユーザー	ユーザー詳細取得	`GET`	`/api/users/{user_id}`
ユーザー	ユーザー更新	`PATCH`	`/api/users/{user_id}`
ユーザー	ユーザー削除	`DELETE`	`/api/users/{user_id}`

データマート定義に関するAPI

データマート定義に関するAPIエンドポイントは、β版でのご提供となっています。
正式版リリース時には、仕様が変更される可能性があります。

TROCCO API KEYの作成

TROCCO APIを利用するには、事前にTROCCO上でTROCCO API KEYを作成する必要があります。

サイドメニューの外部連携>TROCCO API KEYをクリックします。TROCCO API KEY一覧画面が表示されます。
新規作成>保存をクリックします。TROCCO API KEYが作成されます。
この際、画面上に表示される値をメモしてください。API実行時に利用します。

TROCCO API KEYの管理主体

TROCCO API KEYはアカウントではなく、ユーザーごとに管理されます。
したがって、自身が作成したTROCCO API KEYは、基本的に(*)他ユーザーには閲覧されることはありません。
なお、ユーザーが削除された場合は、そのユーザーが作成したTROCCO API KEYも削除されます。

* 例外的に、アカウント特権管理者のみ、アカウント内に作成されたすべてのTROCCO API KEYを閲覧・編集・削除できます。

API実行時に指定する各種パラメーターの確認方法

各種設定・ジョブのID

TROCCO APIの実行対象となるTROCCOの各種設定やジョブのID（例：job_definition_idやjob_id）は、それぞれの詳細画面のURL末尾より確認できます。
以下は転送設定ID（job_definition_id）および転送ジョブID（job_id）の確認方法の例です。

転送設定ID（`job_definition_id`）

転送ジョブID（`job_id`）

タイムゾーン（`time_zone`）

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

Was this article helpful?

What's Next

転送ジョブ実行

Table of contents

概要
制約
TROCCO API エンドポイント一覧
TROCCO API KEYの作成
API実行時に指定する各種パラメーターの確認方法