Querying the Model List

Updated on 2022-09-15 GMT+08:00

View PDF

Function

This API is used to query the list of physical and logical models based on the business category ID.

URI

GET /v2/{project_id}/design/workspaces

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
workspace_type	No	String	Enumeration values: THIRD_NF DIMENSION
dw_type	No	String	Data connection type

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
id	Long	ID
name	String	Workspace name Maximum: 250
description	String	Maximum: 600
is_physical	Boolean	Whether the table is a physical table Default: true
frequent	Boolean	Whether the workspace is frequently used Default: true
top	Boolean	Hierarchical governance Default: true
level	String	Data governance level Enumeration values: SDI DWI DWR DM
dw_type	String	Data connection type
create_time	String	Creation time
update_time	String	Update time
create_by	String	Creator
update_by	String	User who updated the workspace
type	String	Workspace types Enumeration values: THIRD_NF DIMENSION
biz_catalog_ids	String	IDs of business catalogs, including l1Ids, l2Ids, and l3Ids
databases	Array of strings	Array of database names

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code, for example, DS.000 which indicates that the request was successfully processed.
error_msg	String	Error message
data	Object	Returned data

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code, for example, DS.000 which indicates that the request was successfully processed.
error_msg	String	Error message
data	Object	Returned data

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code, for example, DS.000 which indicates that the request was successfully processed.
error_msg	String	Error message
data	Object	Returned data

Example Requests

None

Example Responses

Status code: 200

The operation succeeds. The WorkspaceVO array and the total number of models are returned.

{
  "id" : "1014218815216717824",
  "name" : "test",
  "description" : "abc",
  "is_physical" : true,
  "frequent" : false,
  "top" : true,
  "level" : "SDI",
  "dw_type" : "DLI",
  "create_time" : "2022-08-30T17:03:28.822+08:00",
  "update_time" : "2022-08-30T17:03:28.822+08:00",
  "create_by" : "abc",
  "update_by" : "abc",
  "type" : "THIRD_NF",
  "biz_catalog_ids" : null,
  "databases" : null
}