Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Modifying the MR Check Mode
Updated on 2026-02-03 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Modifying the MR Check Mode

Function

This API is used to modify the MR check mode of the task based on the task ID. Different MR check modes have different file check scopes.

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

Write

task *

-

-

-

-

codeartscheck:ProjectId

URI

PUT /v1/task/check-mode

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

operator

No

String

Definition:

Operator.

Constraints:

N/A

Value range:

N/A

Default value:

N/A
Table 2 Request body parameters

Parameter

Mandatory

Type

Description

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

mrCheckMode

Yes

Integer

Definition:

MR check mode.

Constraints:

N/A

Range:

  • 4: Scan changed files.

  • 5: Full scan.

  • 0: Scan changed code.

Default value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

httpStatus

String

Definition:

HTTP response status.

Value range:

  • OK: The request has been successfully processed, and the server returns the requested resource or operation result.

  • ACCEPTED: The request has been accepted by the server, but the processing is not complete (usually used for asynchronous operations).

  • INTERNAL_SERVER_ERROR: internal API exception.

  • BAD_REQUEST: abnormal parameter verification.

result

String

Definition:

If the MR check mode is modified successfully, the message Check mode configuration updated. is returned.

Range:

N/A

status

String

Definition:

API response status.

Value range:

  • success: successful response.

  • error: response failed.

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

Modify the MR check mode of the task whose ID is 10155df661744d1f98f0055f1236702d. The changed code is checked.

PUT https://{endpoint}/v1/task/check-mode

{
  "id" : "10155df661744d1f98f0055f1236702d",
  "mrCheckMode" : 0
}

Example Responses

Status code: 200

Request succeeded!

{
  "httpStatus" : "OK",
  "result" : "Check mode configuration updated.",
  "status" : "success"
}

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: Task Management