Obtaining the Quality Job List
Function
This API is used to obtain the list of quality jobs.
URI
GET /v2/{project_id}/quality/quality-tasks
| 
        Parameter  | 
      
        Mandatory  | 
      
        Type  | 
      
        Description  | 
     
|---|---|---|---|
| 
        project_id  | 
      
        Yes  | 
      
        String  | 
      
        Project ID. Execution results of only the tasks that belong to this project can be obtained.  | 
     
| 
        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: 
  | 
     
| 
        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  | 
     
Request Parameters
| 
        Parameter  | 
      
        Mandatory  | 
      
        Type  | 
      
        Description  | 
     
|---|---|---|---|
| 
        workspace  | 
      
        Yes  | 
      
        String  | 
      
        Workspace information  | 
     
| 
        X-Auth-Token  | 
      
        Yes  | 
      
        String  | 
      
        token  | 
     
Response Parameters
Status code: 200
| 
        Parameter  | 
      
        Type  | 
      
        Description  | 
     
|---|---|---|
| 
        count  | 
      
        Long  | 
      
        Total number of records  | 
     
| 
        resources  | 
      
        Array of QualityTaskOverviewVO objects  | 
      
        Number of records on each page  | 
     
| 
        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
| 
        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  | 
      
        Response. If the operation is successful, InstanceVO is returned.  | 
     
| 
        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.