Obtaining Mandatory Items for Repository Review Comments

Function

This API is used to obtain mandatory items for 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:repository:getRepository	Read	-	-	-	-

URI

GET https://{hostURL}/v4/repositories/{repository_id}/setting/note-required-attributes

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
repository_id	Yes	Integer	Definition You can call the API used to query all repositories of the user to query the project list to obtain the repository ID. 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. You can obtain the token by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. Constraints N/A Range A string that can contain 1 to 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

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

Previous topic: Obtaining Mandatory Items for Repository Review Comments

Next topic: Pipeline

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.

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

Chatbot