Skip to content

Get Simplified List of Workspaces in Same Organization



POST /api/v1/workspace/same_org/list

Overview

Get a simplified information list of workspaces under the same organization as the workspace to which the current DF-API-KEY belongs.

Body Request Parameters

Parameter Name Type Required Description
workspaceUUIDs array Optional, filter by workspace UUID list; empty array is equivalent to not passing; number should not exceed SameOrgTraceQuerySet.maxWorkspaceCount, maximum length of a single UUID is 128
Nullable: True
pageSize integer Optional, number of items per page, default 20, default maximum 100, controlled by SameOrgTraceQuerySet.workspaceListPageSizeMax configuration
Nullable: True
beforeWorkspaceId integer Optional, nextBeforeWorkspaceId returned from the previous page; when passed, only records with Workspace.id less than this value are returned
Nullable: True

Parameter Additional Notes

This interface is not controlled by SameOrgTraceQuerySet.enable and is only used to assist in selecting target workspaces for same-organization trace queries.

  • workspaceId is only used for pagination in this interface.
  • Subsequent trace queries should use workspaceUUID.
  • This interface does not execute DQL queries, nor does it replace Kodo's final same-organization validation.

Response

{
    "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"
}