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

Creating or Updating Mandatory Items for Project Review Comments

Function

This API is used to create or update for project review comments.

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

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

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

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: 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/setting/note-required-attributes

{
  "is_assignee_id_required" : true,
  "is_review_categories_required" : true,
  "is_review_modules_required" : true
}

Example Responses

Status code: 201

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