Obtaining the Catalog List
Function
This API is used to obtain the catalog list.
URI
GET /v2/{project_id}/quality/categories
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
project id |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
workspace |
Yes |
String |
Workspace information |
|
accept |
Yes |
String |
application/json |
|
X-Auth-Token |
Yes |
String |
token |
Response Parameters
Status code: 200
|
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 |
|
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
|
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
|
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 |
Example Requests
None
Example Responses
None
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Success |
|
400 |
BadRequest |
|
500 |
INTERNAL SERVER ERROR |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
