Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ Discussion/ Obtaining Review Settings
Updated on 2026-04-28 GMT+08:00
View PDF

Obtaining Review Settings

Function

This API is used to obtain review settings.

Debugging

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

URI

GET https://{hostURL}/v4/repositories/{repository_id}/review-setting

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.

Value range:

1~2147483647
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

with_default_review_categories

No

Boolean

Definition

Additionally returns review comment types can be selected, as well as preset review comment types.

Range

  • true: returns review comment types can be selected, as well as preset review comment types.

  • false: not to return review comment types can be selected, as well as preset review comment types.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. Obtain a token by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token.

Constraints

Mandatory.

Range

1–100,000 characters.

Default Value

N/A.

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.

repository_id

Integer

Definition

Repository ID.

Value range:

1~2147483647

note_required_attributes

Array of RequiredAttributeDto objects

Definition

Review comment. This is a mandatory field.

codehub_default_categories

Array of categoryDto objects

Definition

Review comment types (all available options, which are returned only when with_default_review_categories: true is transferred).

hicode_default_categories

Array of categoryDto objects

Definition

Preset review comment types (returned only when with_default_review_categories: true is transferred).
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

None

Example Responses

Status code: 200

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" : [ "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