Obtaining the Comparison Job List

This API is used to obtain the list of comparison jobs.

GET /v2/{project_id}/quality/consistency-tasks

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. Execution results of only the tasks that belong to this project can be obtained.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
category_id	No	Long	Catalog ID
name	No	String	name
schedule_status	No	String	Scheduling status. The value can be UNKNOWN (unknown), NOT_START (not started), SCHEDULING (scheduling), FINISH_SUCCESS (completed properly), KILL (manually stopped), or RUNNING_EXCEPTION (scheduling failed). Enumeration values: UNKNOWN NOT_START SCHEDULING FINISH_SUCCESS KILL RUNNING_EXCEPTION
start_time	No	Long	Start time of the last query period. The value is a 13-digit timestamp accurate to millisecond.
end_time	No	Long	End time of the last query period. The value is a 13-digit timestamp accurate to millisecond.
creator	No	String	Creator
limit	No	Long	Pagination limit. The maximum value is 100. Minimum: 0 Maximum: 100 Default: 10
offset	No	Long	Pagination offset. The minimum value is 0. Minimum: 0 Default: 0

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
workspace	Yes	String	Workspace information
X-Auth-Token	Yes	String	token

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
count	Long	Total number of records
resources	Array of QualityTaskOverviewVO_2 objects	Number of records on each page

**Table 5** QualityTaskOverviewVO_2
Parameter	Type	Description
id	Long	id
name	String	name
category_id	Long	Catalog ID
schedule_status	String	Scheduling status. The value can be UNKNOWN (unknown), NOT_START (not started), SCHEDULING (scheduling), FINISH_SUCCESS (completed properly), KILL (manually stopped), or RUNNING_EXCEPTION (scheduling failed).
schedule_period	String	Scheduling period. The value can be MINUTE, HOUR, DAY, or WEEK.
schedule_interval	String	Scheduling interval. When the scheduling period is minute, hour, or day, a numeric string is returned. When the scheduling period is week, certain days of a week such as MONDAY,THURSDAY are returned.
create_time	Long	Creation time. The value is a 13-digit timestamp accurate to millisecond.
last_run_time	Long	Last running time. The value is a 13-digit timestamp accurate to millisecond.
creator	String	Creator

Status code: 400

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

Status code: 500

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

None

None

Status Code	Description
200	Response. If the operation is successful, InstanceVO is returned.
400	BadRequest
500	INTERNAL SERVER ERROR

Parent topic: Comparison Job 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