Contents x
    ワークフロー一覧取得
      • Print
      • PDF
      Contents

      ワークフロー一覧取得

        • Print
        • PDF
        Article summary

        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についてを参照ください。

        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

        ワークフロー名

        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

        権限がありません。

        Was this article helpful?
        What's Next