Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ File/ Obtaining the Upper-level Tree Structure of the Current File
Updated on 2026-01-27 GMT+08:00
View PDF
Share

Obtaining the Upper-level Tree Structure of the Current File

Function

This API is used to obtain the upper-level tree structure of the current file.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

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

codeartsrepo:repository:getRepository

Read

-

-

-

-

URI

GET https://{hostURL}/v4/repositories/{repository_id}/repository/upper-files-tree

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

repository_id

Yes

Integer

Definition

You can query the project list to obtain the repository ID by calling the API used to query user's all repositories.

Constraints

N/A

Default Value

N/A

Value range:

1~2147483647
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

file_path

No

String

Definition

File path.

Range

1–10,000 characters.

ref_name

No

String

Definition:

Branch or tag name.

Constraints:

Do not start with hyphen (-), period (.) refs, heads, refs, or remotes. Do not end with . / .lock. Spaces and the following characters are not supported: [ \ < ~ ^ : ? * ! ( ) ' " |

Value range:

1 to 200 characters.

Default value:

Default branch of the repository.

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

1–100,000 characters.

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

[items]

Array of TreeDto objects

Obtain the upper-level tree structure of the current file.
Table 5 TreeDto

Parameter

Type

Description

id

String

Definition

Commit ID.

Range

N/A

name

String

Definition

File name.

Range

N/A

type

String

Definition

File structure.

Range

  • commit: sub-module.

  • tree: directory.

  • blob: file

Enumeration values:

  • commit

  • tree

  • blob

path

String

Definition

File path.

Range

N/A

level

Integer

Definition

Current directory level.

Range

N/A

isShownDropDown

Boolean

Definition

Whether to drop down.

Range

  • false: no.

  • true: yes.

folder

Boolean

Definition

Whether a file is collapsed.

Range

  • false: no.

  • true: collapsed.

children

Array of TreeDto objects

Sub-node.

submodule_link

String

Definition

Submodule connection.

Range

N/A

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Example Requests

GET https://{endpoint}/v4/repositories/2112029050/repository/upper-files-tree

Example Responses

Status code: 200

File source tracing information.

[ {
  "id" : "39f26b16fdff0242abc4ac3022cb0f1f88c6a523",
  "name" : "123",
  "type" : "tree",
  "path" : "123",
  "level" : -1,
  "isShownDropDown" : false,
  "folder" : false,
  "children" : null,
  "submodule_link" : null
}, {
  "id" : "624c18a4353c2789ada229459ae1aa2f47f3d2dc",
  "name" : "1234",
  "type" : "tree",
  "path" : "1234",
  "level" : -1,
  "isShownDropDown" : false,
  "folder" : false,
  "children" : null,
  "submodule_link" : null
} ]

Status code: 401

Unauthorized

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

Status code: 403

Bad Request

{
  "error_code" : "CH.004403",
  "error_msg" : "Insufficient permissions. Apply for the required permissions and try again."
}

Status Codes

Status Code

Description

200

File source tracing information.

401

Unauthorized

403

Bad Request

Error Codes

See Error Codes.

Parent topic: File