Querying the Catalog List

Function

This API is used to query the catalog list.

URI

GET /v2/{project_id}/design/biz/catalogs

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
name	No	String	Fuzzy query by name or code
create_by	No	String	Creator
owner	No	String	Query by owner
begin_time	No	String	Left boundary for a time filter. This parameter must be used together with end_time.
end_time	No	String	Right boundary for a time filter. This parameter must be used together with begin_time.
limit	No	Integer	Number of records to be queried, that is, Y records. The value ranges from 1 to 100. The default value is 50. Maximum: 100 Default: 50
offset	No	Integer	Query offset, that is, X data records are skipped. The value must be 0 or an integer multiple of limit. If the value does not meet the requirements, it will be rounded down. The default value is 0. Default: 0

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
name	String	Workflow name Maximum: 600
description	String	Description Maximum: 2000
guid	String	Asset ID
owner	String	Owner Maximum: 4000
parent_id	Long	Parent catalog ID. If there is no parent catalog, the current catalog is the root catalog.
prev_id	Long	ID of the previous node. If there is no previous node, the current node is the first node.
next_id	Long	ID of the next node. If there is no next node, the current node is the last node.
id	Long	This parameter is left empty during creation and is mandatory during update.
qualified_id	String	Authentication ID, which is automatically generated
create_by	String	Creator
update_by	String	User who updated the business catalog
create_time	String	Creation time
update_time	String	Update time
bizmetric_num	Integer	Number of business metrics, which is not transferred to the front end
children_num	Integer	Number of sub-processes, excluding those of sub-processes
children	Array of BizCatalogVO objects	Sub-catalog

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

Status code: 404

**Table 7** 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 BizCatalogVO array and the total number of catalogs are returned.

{
  "id" : "887366192090767360",
  "description" : "demo",
  "name" : "demo",
  "owner" : "ei_dlg",
  "parent_id" : "776737281791897600",
  "prev_id" : "885913975320207360"
}

Status Codes

Status Code	Description
200	The operation succeeds. The BizCatalogVO array and the total number of catalogs are returned.
400	BadRequest
401	Unauthorized
403	Forbidden
404	Not Found