Help Center/ CodeArts Check/ API Reference/ APIs/ AI-assisted Analysis/ Viewing the Source Code File Where the Issue Is Located
Updated on 2026-02-03 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Viewing the Source Code File Where the Issue Is Located

Function

This API is used to view the source code file where the issue is located in the code repository.

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

Read

task *

-

-

-

-

codeartscheck:ProjectId

URI

GET /v1/defects/file-content

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition :

You can obtain the 32-character UUID by calling the API used to query the project list.

Constraints:

N/A

Value range:

32-character UUID.

Default value:

N/A

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:

1 to 32 characters.

Default value:

N/A

job_id

No

String

Definition

Execution record ID, that is, the unique ID of each version or quality gate scan. The ID is used to query quality gate tasks.

Constraints

N/A

Range

N/A

Default Value

N/A

merge_id

No

String

Definition

Merge request ID or commit ID. They are used to query quality gate tasks.

Constraints

N/A

Range

N/A

Default Value

N/A

merge_key

Yes

String

Definition:

MergeKey, that is, issue ID. The mergeKey field in the response to the request for obtaining the list of code issues.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

bug_id

Yes

String

Definition:

bugId, that is, code snippet ID of the issue. The bugId field in the response to the request for obtaining the list of code issues.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Language

No

String

Definition:

Language of the response.

Constraints:

N/A

Value range:

  • zh-cn: Chinese.

  • en-us: English.

Default value:

zh-cn

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

status

String

Definition:

Response status.

Value range:

  • success: successful.

  • error: failed.

result

String

Definition:

File content in the code repository.

Value range:

N/A

Status code: 400

Table 4 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 5 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

GET https://{endpoint}/v1/tasks/2b31ed520xxxxxxebedb6e57xxxxxxxx/v1/defects/file-content

Example Responses

Status code: 200

Request succeeded!

{
  "status" : "success",
  "error" : null,
  "result" : "import android.app.Application;\n\n..."
}

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: AI-assisted Analysis