Get
/api/labels
ラベル一覧を取得します。
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
limit
integer (int64)
取得するラベルの最大件数
Maximum200
Default50
cursor
string
取得するラベル一覧の最初のレコードを示すページネーションカーソル
レスポンスに含まれるnext_cursorをセットすると、後続のラベル一覧を取得できます。
ExampleeyJpZCI6MjF9
datamart_definition_id
integer (int64)
データマート定義のIDを指定します。データマート定義に付いているラベルだけを返します。
(他のID指定パラメータと一緒に使えません)
Example123
job_definition_id
転送設定定義のID（配列可能）を指定します。転送設定定義に付いているラベルだけを返します。
(他のID指定パラメータと一緒に使えません)
Example123
job_definition_bulk_id
integer (int64)
マネージド転送設定定義のIDを指定します。マネージド転送設定定義に付いているラベルだけを返します。
(他のID指定パラメータと一緒に使えません)
Example123
pipeline_definition_id
ワークフロー定義のID（配列可能）を指定します。ワークフロー定義に付いているラベルだけを返します。
(他のID指定パラメータと一緒に使えません)
Example123
Responses
200
ラベル一覧を返します。
object
items
Array of object
object
id
integer (int64)
ラベルIDです
Example1
name
string
ラベル名です。
Examplefavorite
description
string | null
メモです。
Exampleお気に入り
color
string
ラベルの色です。
Example#e86115
created_at
string
ラベル作成日時です。
Example2023-08-23T03:00:00.000+09:00
updated_at
string
ラベルの更新日時です。
Example2023-08-23T03:00:00.000+09:00
next_cursor
string
後続のページネーションリクエストの取得開始レコードを示すカーソル値です。
400
/api系の共通エラーレスポンス
object
message
string
Example不正なリクエストです。
401
認証エラー
object
message
string
Exampleアカウント登録もしくはログインしてください。
404
指定したIDが存在しません。