Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ Discussion/ Creating/Updating Review Comments Settings

Updated on 2026-01-27 GMT+08:00

View PDF

Creating/Updating Review Comments Settings

Function

This API is used to create/update review comment settings.

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:repository:setRepository	Write	-	-	-	-

URI

POST https://{hostURL}/v4/repositories/{repository_id}/review-settings

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
repository_id	Yes	Integer	Definition You can query the project list to obtain the repository ID by calling the API used to query user's all repositories. Constraints N/A Default Value N/A Value range: 1~2147483647

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

**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.)
note_required_attributes	Array of RequiredAttributeDto objects	Definition Mandatory for review comments. (Not returned when the post API does not update the mandatory item.)
codehub_default_categories	Array of categoryDto objects	Definition Review comment category. (This parameter is optional. It is returned only when with_default_review_categories in the get API transfers true.)
hicode_default_categories	Array of categoryDto objects	Definition Preset review comment category. (Returned only when with_default_review_categories in the get API transfers true.)

**Table 5** RequiredAttributeDto
Parameter	Type	Description
name	String	Definition Mandatory field name. Description: Body Severity: Severity Assignee: AssigneeId Comment type: ReviewCategories Comment module: ReviewModules Enumeration values: Body Severity AssigneeId ReviewCategories ReviewModules
is_required	Boolean	Definition Mandatory or not.

**Table 6** 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 7** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error message.

Example Requests

/v4/repositories/123/review-settings

{
  "categories_and_modules_enabled" : true,
  "secondary_category_enabled" : false,
  "review_default_categories" : [ "realize", "design" ],
  "review_customized_categories" : [ "Category" ],
  "review_modules" : [ "Module" ],
  "is_assignee_id_required" : true,
  "is_review_categories_required" : true,
  "is_review_modules_required" : true
}

Example Responses

Status code: 200

{
  "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" : [ "Category" ],
  "review_modules" : [ "Module" ],
  "note_required_attributes" : [ {
    "name" : "AssigneeId",
    "is_required" : true
  }, {
    "name" : "Body",
    "is_required" : true
  }, {
    "name" : "ReviewCategories",
    "is_required" : true
  }, {
    "name" : "ReviewModules",
    "is_required" : true
  }, {
    "name" : "Severity",
    "is_required" : true
  } ]
}

Status code: 401

Unauthorized

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

Status Codes

Status Code	Description
200	OK
401	Unauthorized

Error Codes

See Error Codes.

Parent topic: Discussion

Previous topic: Obtaining the Reviewer List of Review Comments in the Repository

Next topic: Obtaining Review Settings

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot