Help Center/ CodeArts Check/ API Reference/ APIs/ Code Issues/ Updating the Status of a Code Issue
Updated on 2026-02-03 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Updating the Status of a Code Issue

Function

This API is used to update the status of a code issue in a code task. You can update the status of multiple code issues at a time.

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

Write

task *

-

-

-

-

codeartscheck:ProjectId

URI

POST /v1/defect/issue-status

Request Parameters

Table 1 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
Table 2 Request body parameters

Parameter

Mandatory

Type

Description

taskId

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

mergeId

No

String

Definition:

Merge request ID. This parameter is only used to distinguish version and quality gate scans. Leave it blank for a version scan and pass any non-empty value for a quality gate scan.

Constraints:

N/A

Range:

N/A

Default value:

N/A

jobId

No

String

Definition:

Execution ID, which is returned by the API of code check task execution. Each code check task has a unique execution ID. Leave this parameter blank for a version scan and pass a value for a quality gate scan. That is, the ID field in the response of API Querying Task Execution Record by Task ID.

Constraints:

N/A

Value range:

1 to 32 characters.

Default value:

N/A

status

Yes

String

Definition:

Issue status.

Constraints:

N/A

Value range:

  • 0: pending

  • 2: resolved

  • 5: ignored

Default value:

N/A

comment

Yes

String

Definition:

Remarks of the issue status change.

Constraints:

N/A

Value range:

1 to 256 characters.

Default value:

N/A

mergeKey

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:

1 to 32 characters.

Default value:

N/A

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:

Modification result.

Value range:

  • Modification succeeded: successful.

  • null: failed.

error

Error object

Definition:

Error message. This parameter is returned only when the operation fails.
Table 4 Error

Parameter

Type

Description

error_code

String

Definition:

Error code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

reason

String

Definition:

Details.

Value range:

N/A

Status code: 400

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

Status code: 401

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

Example Requests

Change the issue status of MergeKey df16aacxxxf6c8758 for task ID 897acf5exxx48a5013cd to Ignored and add comment "Falsely reported."

POST https://{endpoint}/v1/defect/issue-status

{
  "taskId" : "897acf5exxx48a5013cd",
  "mergeId" : "",
  "jobId" : "",
  "status" : 5,
  "comment" : "Falsely reported.",
  "mergeKey" : "df16aacxxxf6c8758",
  "operator" : "devcloud_codecheck_01"
}

Example Responses

Status code: 200

Response body for updating the code issue status.

{
  "status" : "success",
  "error" : null,
  "result" : "Updated."
}

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

Response body for updating the code issue status.

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.

Parent Topic: Code Issues