Obtaining Repository Group Review Comment Settings (Excluding Mandatory Items)
Function
This API is used to obtain repository group review comment settings (excluding 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}/review-settings
| 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
| 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
| 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). |
| Parameter | Type | Description |
|---|---|---|
| name | String | Definition Mandatory field name. Description: Body Severity: Severity Assignee: AssigneeId Comment type: ReviewCategories Comment module: ReviewModules Enumeration values: |
| is_required | Boolean | Definition Mandatory or not. |
| 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: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Definition Error code. |
| error_msg | String | Definition Error message. |
Status code: 401
| 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" : [ "Type" ],
"review_modules" : [ "Module" ]
} 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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
