Obtaining the Catalog List

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

View PDF

This API is used to obtain the catalog list.

GET /v2/{project_id}/quality/categories

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	project id

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
workspace	Yes	String	Workspace information
accept	Yes	String	application/json
X-Auth-Token	Yes	String	token

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
id	Long	Catalog ID. The ID of the root catalog is 0.
name	String	Name
type	String	Type. The value can be built_in or user-defined.
pid	String	Parent catalog ID
sub_categories	Array of SubCategoryDetailVO objects	Sub-catalog

**Table 4** SubCategoryDetailVO
Parameter	Type	Description
id	Long	Catalog ID. The ID of the root catalog is 0.
name	String	Name
type	String	Type. The value can be built_in or user-defined.
pid	String	Parent catalog ID
sub_categories	Object	Sub-catalog

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code, for example, DQC.0000 which indicates that the request was successfully processed.
error_msg	String	Error message

Status code: 500

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code, for example, DQC.0000 which indicates that the request was successfully processed.
error_msg	String	Error message

None

None

Parent topic: Catalog APIs

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel