Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Obtaining the Check List Based on the Task Type

Updated on 2026-08-10 GMT+08:00

Obtaining the Check List Based on the Task Type

Function

This API is used to query the task list by task ID and task type with pagination. You can query the branch tasks, tag tasks, MR tasks, and commit tasks under a task.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
codeartscheck:task:get	Read	task *	-	-	-
codeartscheck:task:get	Read	-	codeartscheck:ProjectId	-	-

URI

GET /v4/task/{task_id}/check-list

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
task_id	Yes	String	Definition : Task ID, which is the return value of the API used to create a check task. Each check task, its brach tasks, and incremental tasks created through APIs have a unique task ID. Obtain the ID by calling the API used to query the task list. id indicates the task ID. Constraints: N/A. Value range: 1 to 32 characters. Default value: N/A.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
check_type	Yes	String	Definition: Task type. Constraints: N/A Value range: branch: branch task. tag: tag task. cr: change request task. mr: merge request task. Default value: branch.
page	Yes	Integer	Definition Page number. Constraints N/A Range 1–100000 Default Value N/A
page_size	Yes	Integer	Definition: Page size. Constraints: N/A Value range: 1–200 Default value: 200
search	No	String	Definition: Search keyword. Constraints: If check_type is set to branch, the branch name can be searched. If check_type is set to tag, the tag name can be searched. If check_type is set to cr or mr, search is not supported. Value range: N/A Default value: N/A
time_start	No	String	Definition: Check start time. Use UTC time in format "yyyy-MM-ddTHH:mm:ssZ". For example, 2020-09-25T12:05:00Z. Constraints: If check_type is set to branch or tag, time-based filtering is not supported. If check_type is set to cr or mr, time-based filtering is supported. Value range: N/A Default value: N/A
time_end	No	String	Definition: Check end time. Use UTC time in format "yyyy-MM-ddTHH:mm:ssZ". For example, 2020-09-25T12:05:00Z. Constraints: If check_type is set to branch or tag, time-based filtering is not supported. If check_type is set to cr or mr, time-based filtering is supported. Value range: N/A Default value: N/A

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. Obtain one by calling the IAM API Obtaining a User Token. The value of X-Subject-Token in the response header is a token. Constraints N/A Range The length is the value of [1-100000]. Default Value N/A
Content-Type	Yes	String	Definition Encoding format. Constraints N/A Range N/A Default Value application/json: The return value is in JSON format for any input value.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
result	CheckListResult object	Definition Response for obtaining the check list.

**Table 5** CheckListResult
Parameter	Type	Description
total	Integer	Definition: Total number of check list. Value range: ≥0
list	Array of CheckResultInfo objects	Definition Check details.

**Table 6** CheckResultInfo
Parameter	Type	Description
taskId	String	Definition : Task ID, which is the return value of the API used to create a check task. Each check task, its brach tasks, and incremental tasks created through APIs have a unique task ID. Obtain the ID by calling the API used to query the task list. id indicates the task ID. Value range: 1 to 32 characters.
branchName	String	Definition: Branch name. Value range: NOTE: 0 characters.
isDefault	Boolean	Definition: Default branch or not. Value range: true and false
status	String	Definition Task status. Range quering: initial state. running: task running. success: check succeeded. failed: check failed. aborted: task aborted. null: no status obtained.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Value range: N/A
error_msg	String	Definition: Error message. Value range: N/A

Status code: 401

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Value range: N/A
error_msg	String	Definition: Error message. Value range: N/A

Example Requests

Query the branch check records for task ID aeuxxlgh on the master branch. The first page is displayed, and 10 records are displayed on each page.

GET https://{endpoint}/v4/task/aeuxxlgh/check-list?check_type=branch&page=1&page_size=10&search=master

Example Responses

Status code: 200

Request succeeded.

{
  "result" : {
    "total" : 3,
    "list" : [ {
      "taskId" : null,
      "branchName" : "dev",
      "isDefault" : false,
      "status" : null
    }, {
      "taskId" : "63f5fb89cc9a4855967947935b74cd61",
      "branchName" : "master",
      "isDefault" : true,
      "status" : "success"
    }, {
      "taskId" : null,
      "branchName" : "test",
      "isDefault" : false,
      "status" : null
    } ]
  }
}

Status code: 400

A request error occurred.

{
  "error_code" : "CC.xxxxxxxx.400",
  "error_msg" : "Verify request parameter failed. Check whether the request parameters are correct."
}

Status code: 401

The permission is insufficient.

{
  "error_code" : "CC.00000003",
  "error_msg" : "Authentication information expired."
}

Status Codes

Status Code	Description
200	Request succeeded.
400	A request error occurred.
401	The permission is insufficient.

Error Codes

See Error Codes.

Parent Topic: Task Management

Previous topic: Cloning Tasks Asynchronously in Batches

Next topic: Creating a Check Task (Version 3)