Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Obtaining the Check List Based on the Task Type
Updated on 2026-02-03 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

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:ProjectId

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

task_id

Yes

String

Definition :

Task ID, returned by the API for creating a check task. Each code check task, branch task, or incremental task generated through an API has a unique ID. Obtain the ID by calling the API used to . id indicates the task ID.

Constraints:

N/A

Value range:

N/A

Default value:

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

check_type

No

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

Value range:

1-2147483647

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

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

result

CheckListResult object

Definition:

Response for obtaining the check list.

Value range:

N/A
Table 4 CheckListResult

Parameter

Type

Description

total

Integer

Definition:

Total number of check list.

Value range:

≥0

list

Array of CheckResultInfo objects

Definition:

Check details.

Value range:

N/A
Table 5 CheckResultInfo

Parameter

Type

Description

taskId

String

Definition :

Task ID, returned by the API for creating a check task. Each code check task, branch task, or incremental task generated through an API has a unique ID. Obtain the ID by calling the API used to . id indicates the task ID.
NOTE:
0 characters.

Value range:

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 execution status.

Value range:

  • quering: initial state.

  • running: The task is running.

  • success: check successful.

  • failed: check failed.

  • aborted: task aborted.

Status code: 400

Table 6 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 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

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

Bad Request

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

Status code: 401

Unauthorized

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

Status Codes

Status Code

Description

200

Request succeeded!

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.

Parent Topic: Task Management