Obtaining Job Catalogs

Function

This API is used to obtain job directories.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/quality/categories

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain it, see Project ID and Account ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Number of records on each page. The maximum value is 100.
offset	No	Integer	Paging offset

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
workspace	Yes	String	DataArts Studio workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID.
accept	Yes	String	application/json
X-Auth-Token	Yes	String	IAM token. For details about how to obtain the token, see Authentication.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
[items]	Array of CategoryDetailVO objects	List of custom items

**Table 5** CategoryDetailVO
Parameter	Type	Description
id	Long	Directory ID. The ID of the root directory is 0.
name	String	Name
type	String	Type. The value can be built_in or user-defined.
pid	String	Parent directory ID
sub_categories	Array of SubCategoryDetailVO objects	Subdirectories

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

Status code: 400

**Table 7** 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 8** 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

Example Requests

None

Example Responses

Status code: 200

Success

[ {
  "name" : "All",
  "id" : 0,
  "type" : "built_in",
  "pid" : "-1",
  "sub_categories" : [ {
    "name" : "qwe",
    "id" : 1012384968858652700,
    "type" : "user-defined",
    "pid" : "0",
    "sub_categories" : [ {
      "id" : 1,
      "name" : "name"
    } ]
  } ]
} ]