Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ Discussion/ Obtaining Mandatory Items of Repository Group Review Comments
Updated on 2026-04-28 GMT+08:00
View PDF

Obtaining Mandatory Items of Repository Group Review Comments

Function

This API is used to obtain repository group review comments mandatory items.

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/groups/{group_id}/setting/note-required-attributes

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

group_id

Yes

Integer

Definition

Repository group ID, which is the numeric ID next to Group ID on the repository group homepage.

Value range:

1~2147483647

Request Parameters

Table 2 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 3 Response body parameters

Parameter

Type

Description

[items]

Array of NoteRequiredAttributeDto objects

Request body for review comment settings
Table 4 NoteRequiredAttributeDto

Parameter

Type

Description

note_required_attributes

Array of RequiredAttributeDto objects

Definition

Review comment. This is a mandatory field.
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.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

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

{
  "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: 400

Bad Request

{
  "error_code" : "CH.00405011",
  "error_msg" : "Request error."
}

Status code: 401

Unauthorized

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

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.

Parent topic: Discussion