ワークフロー一覧取得

Prev Next
Get
/api/pipeline_definitions

ワークフロー一覧を取得します。

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
Responses
200

ワークフロー一覧を返します。

Expand All
object
items
Array of object
object
id
integer (int64)

ワークフローID

name
string

ワークフロー名

description
string | null

メモ

created_at
string

ワークフロー定義の作成日時です。タイムゾーンはJST 日本時間（GMT+9）です。

Example2023-08-23T03:00:00.000+09:00
updated_at
string

ワークフロー定義の更新日時です。タイムゾーンはJST 日本時間（GMT+9）です。

Example2023-08-23T03:00:00.000+09:00
resource_group_id
integer (int64) | null

リソースグループIDです。

Example1
created_by
object | null

作成者の情報です。

id
integer (int64)

ユーザーIDです。

Example1
email
string

メールアドレスです。

Exampleuser@example.com
labels
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
schedules
Array of object

スケジュール一覧です。

object
frequency
string

スケジュールの頻度です。
hourly: 毎時
daily: 毎日
weekly: 毎週
monthly: 毎月

Valid values[ "hourly", "daily", "weekly", "monthly" ]
minute
integer (int64)

分の値を示します。

hour
integer (int64)

時間の値を示します。

day
integer (int64)

日にちの値を示します。

day_of_week
integer (int64)

曜日の値を示します。

time_zone
string

日時のタイムゾーンです。

ExampleEtc/UTC
notifications
Array of object

通知一覧です。

object
destination_type
string

通知先です。

Valid values[ "slack", "email" ]
slack_channel_id
integer (int64)

slack channel IDです。
destination_typeがslackのとき必須です。

email_id
integer (int64)

Email IDです。
destination_typeがemailのとき必須です。

notification_type
string

通知タイプです。
job: ジョブ実行(終了/エラー)通知
exec_time: 実行時間経過通知

Valid values[ "job", "exec_time" ]
notify_when
string

通知条件です。
jobタイプのとき必須です。

Valid values[ "finished", "failed" ]
message
string

通知内容です。

minutes
integer (int64)

実行時間の閾値（分）
exec_timeタイプのとき必須です。

environment
object | null

環境

id
integer (int64)

環境ID

Example1
name
string

環境名

Example本番環境
environment_group
object

環境グループ

id
integer (int64)

環境グループID

Example1
name
string

環境グループ名

Exampleサンプル環境グループ
created_at
string

環境グループの作成日時

Example2023-08-23T03:00:00.000+09:00
updated_at
string

環境グループの更新日時

Example2023-08-23T03:00:00.000+09:00
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

後続のページネーションリクエストの取得開始レコードを示すカーソル値です。

401

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

403

権限がありません。