Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ Repository/ Obtaining the Mode Information of the Code Navigation Function
Updated on 2026-05-12 GMT+08:00

Obtaining the Mode Information of the Code Navigation Function

Function

Obtain pattern information for the code navigation function, including the most recent index creation time, the number of files with the largest statistics, etc.

Debugging

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

Authorization Information

No identity policy-based permission required for calling this API.

URI

GET https://{hostURL}/v4/repositories/{repository_id}/repository/nav/schema

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

repository_id

Yes

Integer

Definition

You can call the API used to query all repositories of the user to query the project list to obtain the repository ID.

Constraints

N/A

Default Value

N/A

Value range:

1~2147483647

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. You can obtain the token by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Constraints

N/A

Range

A string that can contain 1 to 100,000 characters.

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

result

String

Definition

Result identifier.

Constraints

N/A

message

String

Definition

Result message.

Constraints

N/A

schema

SchemaDto object

Definition

Code navigation mode information.

Table 4 SchemaDto

Parameter

Type

Description

version

String

Definition

Code navigation version.

Constraints

N/A

Default value:

N/A

maximum_file_size

Integer

Definition

Maximum file size.

Constraints

N/A

Default value:

0

maximum_line_length

Integer

Definition

Maximum number of lines.

Constraints

N/A

Default value:

0

maximum_truncate_line

Integer

Definition

Each line supports a maximum number of characters. Any excess will be truncated.

Constraints

N/A

Default value:

0

create_at

String

Definition

Index creation time.

Constraints

N/A

Default value:

N/A

update_at

String

Definition

Index update time.

Constraints

N/A

Default value:

N/A

rebuild_at

String

Definition

Index rebuilding time.

Constraints

N/A

Default value:

N/A

last_build_at

String

Definition

Latest index building time.

Constraints

N/A

Default value:

N/A

build_times

Integer

Definition

Number of index buildings.

Constraints

N/A

Default value:

0

query_times

Integer

Definition

Number of requests.

Constraints

N/A

Default value:

0

outline_times

Integer

Definition

Number of index outline requests.

Constraints

N/A

Default value:

0

Example Requests

GET https://{endpoint}/v4/repositories/123/repository/nav/schema

Example Responses

Status code: 200

OK

{
  "result" : "0",
  "message" : "",
  "schema" : {
    "version" : "VERSION 1.5",
    "maximum_file_size" : 358400,
    "maximum_line_length" : 4096,
    "maximum_truncate_line" : 1000,
    "create_at" : "2026-01-08T16:29:52+08:00",
    "update_at" : "",
    "rebuild_at" : "",
    "last_build_at" : "2026-01-08T16:29:52+08:00",
    "build_times" : 0,
    "query_times" : 0,
    "outline_times" : 0
  }
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.