コンテンツにスキップ

同一組織内のワークスペース簡略リストを取得する¶

POST /api/v1/workspace/same_org/list

概要¶

現在の DF-API-KEY が属するワークスペースと同一組織内のワークスペース簡略情報リストを取得します。

Body リクエストパラメーター¶

パラメーター名	型	必須	説明
workspaceUUIDs	array		任意。ワークスペース UUID リストでフィルタリングします。空配列は未指定と同等です。件数は SameOrgTraceQuerySet.maxWorkspaceCount を超えず、単一 UUID の最大長は 128 です。空を許可: True
pageSize	integer		任意。1 ページあたりの件数。デフォルトは 20、最大デフォルトは 100 で、SameOrgTraceQuerySet.workspaceListPageSizeMax 設定により制御されます。空を許可: True
beforeWorkspaceId	integer		任意。前のページが返す nextBeforeWorkspaceId を指定します。渡された場合、Workspace.id がその値より小さいレコードのみを返します。空を許可: True

パラメーター補足説明¶

本インターフェースは SameOrgTraceQuerySet.enable の制御を受けません。同一組織内の trace クエリ対象ワークスペースを選択するための補助のみを目的とします。

workspaceId は本インターフェースのページネーションのみに使用されます。
以降の trace クエリでは workspaceUUID を使用してください。
本インターフェースは DQL クエリを実行せず、Kodo の最終的な同一組織検証も代替しません。

レスポンス¶

{
    "code": 200,
    "content": {
        "data": [
            {
                "workspaceId": 12345,
                "workspaceUUID": "wksp_x",
                "workspaceName": "Demo Workspace",
                "versionType": "pay"
            }
        ],
        "pageInfo": {
            "pageSize": 20,
            "hasMore": true,
            "nextBeforeWorkspaceId": 12345
        }
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}