Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Updating the Gate Configuration
Updated on 2026-08-10 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Updating the Gate Configuration

Function

This API is used to set the threshold for the number of critical issues, major issues, minor issues, and suggestions based on the task ID. After the check is complete, if the number of issues exceeds the threshold, the gate result is Failed.

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/code-gate

Request Parameters

Table 1 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

The length is the value of [1-100000].

Default Value

N/A

Content-Type

Yes

String

Definition

Encoding format.

Constraints

N/A

Range

N/A

Default Value

application/json: The return value is in JSON format for any input value.

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

reviewData

Yes

Array of ReviewDataInfoRequestParam objects

Definition

Task gate configurations.

Constraints

N/A

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
Table 3 ReviewDataInfoRequestParam

Parameter

Mandatory

Type

Description

compareType

Yes

String

Definition:

Calculation logic.

Constraints:

N/A

Range:

The value is ≤.

Default value:

N/A

isCheck

Yes

Integer

Definition:

Gate switch.

Constraints:

N/A

Range:

  • 0: disabled.

  • 1: enabled.

Default value:

N/A

name

Yes

String

Definition:

Gate item.

Constraints:

N/A

Range:

  • Number of critical issues.

  • Number of major issues.

  • Number of minor problems.

  • Number of suggestions.

Default value:

N/A

value

Yes

Integer

Definition:

Gate threshold.

Constraints:

N/A

Value range:

≥0

Default value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

result

String

Definition:

If the update is successful, a message Gate configuration updated. is returned.

Range:

N/A

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.

status

String

Definition:

API response status.

Value range:

  • success: successful response.

  • error: response failed.

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

Modify the gate configuration of the task whose ID is a2825abdc53e4b53ba2226d6531fd09d. The number of critical issues, major issues, minor issues, and suggestions should be no more than 0.

PUT https://{endpoint}/v1/task/code-gate

{
  "id" : "a2825abdc53e4b53ba2226d6531fd09d",
  "reviewData" : [ {
    "compareType" : "≤",
    "isCheck" : 1,
    "name" : "Number of critical issues.",
    "value" : 0
  }, {
    "compareType" : "≤",
    "isCheck" : 1,
    "name" : "Member of major issues.",
    "value" : 0
  }, {
    "compareType" : "≤",
    "isCheck" : 1,
    "name" : "Number of minor issues.",
    "value" : 0
  }, {
    "compareType" : "≤",
    "isCheck" : 1,
    "name" : "Number of suggestions.",
    "value" : 0
  } ]
}

Example Responses

Status code: 200

Request succeeded.

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

Status code: 400

A request error occurred.

{
  "error_code" : "CC.xxxxxxxx.400",
  "error_msg" : "Verify request parameter failed. Check whether the request parameters are correct."
}

Status code: 401

The permission is insufficient.

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

Status Codes

Status Code

Description

200

Request succeeded.

400

A request error occurred.

401

The permission is insufficient.

Error Codes

See Error Codes.

Parent Topic: Task Management