Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Obtaining All Files in the Code Repository
Updated on 2026-08-10 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Obtaining All Files in the Code Repository

Function

This API is used to query the directory tree of a task by task ID and file path. The file name (directory name), full path of the file (directory), whether the node is a leaf node, and file ignoring status are returned.

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/tasks/{task_id}/all-files

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

file_path

No

String

Definition:

Target path of the build tree.

** Constraints: **

N/A

Range

N/A

** Default value: **

N/A

get_son

No

String

Definition

Whether the returned result is a node or a tree.

Constraints

N/A

Range

true: tree

false: node

Default value

false

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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

data

Array of RepoTreeNode objects

Definition:

File tree node list of the code repository.

Value range:

N/A

total

Integer

Definition:

Number of bugs.

Range:

0-2147483647
Table 5 RepoTreeNode

Parameter

Type

Description

name

String

Definition:

Node name.

Range:

N/A

file_path

String

Definition:

File path.

Range:

N/A

is_leaf

Boolean

Definition:

Whether a node is a leaf node.

Range:

N/A

checkbox_status

String

Definition

Whether the file ignore check box is selected.

Range

  • unchecked: not selected

  • all: all selected.

  • half: partially selected.

sons

Array of RepoTreeNode objects

Node list.

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 all files in the code repository of the code check task whose task ID is 897acf5exxx48a5013cd.

GET https://{endpoint}/v4/tasks/897acf5exxx48a5013cd/all-files

Example Responses

Status code: 200

Request succeeded.

{
  "data" : [ {
    "name" : ".gitignore",
    "file_path" : ".gitignore",
    "is_leaf" : true,
    "checkbox_status" : "unchecked",
    "sons" : [ ]
  } ],
  "total" : 1
}

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