Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ Discussion/ Creating or Updating Project Review Comment Settings (Excluding Mandatory Items)
Updated on 2026-01-27 GMT+08:00
View PDF
Share

Creating or Updating Project Review Comment Settings (Excluding Mandatory Items)

Function

This API is used to create or update the project review comment settings (excluding mandatory items).

Debugging

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

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

codeartsrepo::updateProjectSetting

Write

-

codeartsrepo:ProjectId

-

-

URI

POST https://{hostURL}/v4/projects/{project_id}/review-settings

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

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

Range

String length: 32 characters.

Request Parameters

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

1–100,000 characters.

Default Value

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

categories_and_modules_enabled

No

Boolean

Definition

Whether to enable review comment types and modules.

review_modules

No

Array of strings

Definition

Review comment module.

secondary_category_enabled

No

Boolean

Definition

Whether to enable preset review comment types.

review_default_categories

No

Array of strings

Definition

Review comment types (key list of selected types).

review_customized_categories

No

Array of strings

Definition

Custom type list.

is_assignee_id_required

No

Boolean

Definition

Whether to select an assignee.

is_review_categories_required

No

Boolean

Definition

Whether to select a comment type.

is_review_modules_required

No

Boolean

Definition

Whether to select a comment module.

Response Parameters

Status code: 201

Table 4 Response body parameters

Parameter

Type

Description

categories_and_modules_enabled

Boolean

Definition

Whether to enable review comment types and modules.

secondary_category_enabled

Boolean

Definition

Whether to enable preset review comment types.

primary_categories

Array of categoryDto objects

Definition

Review comment types (selected).

review_default_categories

Array of strings

Definition

Review comment type keys (selected).

review_customized_categories

Array of strings

Definition

Custom types.

review_modules

Array of strings

Definition

Review comment module.

secondary_category_type

String

Definition

Preset review comment categories. (Returned when the relevant feature is enabled. HiCode is returned by default.)

secondary_categories

Array of categoryDto objects

Definition

Details about the preset review comment category. (Returned when the relevant feature is enabled.)
Table 5 categoryDto

Parameter

Type

Description

key

String

Definition

Review comment type key.

name_zh

String

Definition

Review comment type (CN).

name_en

String

Definition

Review comment type.

sub_categories

Array of categoryDto objects

Definition

Sub-review comment type.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Example Requests

/v4/projects/123/review-settings

{
  "categories_and_modules_enabled" : true,
  "secondary_category_enabled" : false,
  "review_default_categories" : [ "realize", "design" ],
  "review_customized_categories" : [ "Type" ],
  "review_modules" : [ "Module" ]
}

Example Responses

Status code: 201

OK

{
  "categories_and_modules_enabled" : true,
  "secondary_category_enabled" : false,
  "primary_categories" : [ {
    "key" : "realize",
    "name_zh" : "Algorithm implementation",
    "name_en" : "Algorithm"
  }, {
    "key" : "design",
    "name_zh" : "Code design",
    "name_en" : "Code design"
  } ],
  "review_default_categories" : [ "realize", "design" ],
  "review_customized_categories" : [ "Type" ],
  "review_modules" : [ "Module" ]
}

Status code: 401

Unauthorized

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

Status code: 403

Bad Request

{
  "error_code" : "CH.004403",
  "error_msg" : "Insufficient permissions. Apply for the required permissions and try again."
}

Status Codes

Status Code

Description

201

OK

401

Unauthorized

403

Bad Request

Error Codes

See Error Codes.

Parent topic: Discussion