Contents x
    リソースグループ一覧取得
      • Print
      • PDF
      Contents

      リソースグループ一覧取得

        • Print
        • PDF
        Article summary

        Get
        /api/resource_groups
        Security
        API Key
        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

        Example1
        name
        string

        リソースグループ名

        Exampleサンプルリソースグループ
        description
        string | null

        リソースグループの説明

        Exampleこれはサンプルリソースグループの説明です。
        teams
        Array of object

        チーム一覧

        Example[ { "id": 1, "role": "administrator" } ]
        object
        id
        integer (int64)

        チームID

        Example1
        role
        string

        ロール

        Valid values[ "administrator", "editor", "operator", "viewer" ]
        Exampleadministrator
        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をご確認ください。

        Was this article helpful?
        What's Next