文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ V4/ Discussion/ 获取代码组检视意见必填项
更新时间：2025-07-15 GMT+08:00
查看PDF
分享

获取代码组检视意见必填项

功能介绍

获取代码组检视意见必填项

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v4/groups/{group_id}/setting/note-required-attributes

表1 路径参数

参数

是否必选

参数类型

描述

group_id

是

Integer

参数解释：

代码组id，代码组首页，Group ID后的数字Id

取值范围：

1-2147483647

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

必传。

取值范围：

字符串长度不少于1，不超过10万。

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

[数组元素]

Array of NoteRequiredAttributeDto objects

检视意见设置请求体
表4 NoteRequiredAttributeDto

参数

参数类型

描述

note_required_attributes

Array of RequiredAttributeDto objects

参数解释：

检视意见必填项。
表5 RequiredAttributeDto

参数

参数类型

描述

name

String

参数解释：

必填字段名称。

描述：Body

严重程度：Severity

指派给：AssigneeId

意见分类：ReviewCategories

意见模块：ReviewModules

枚举值：

  • Body

  • Severity

  • AssigneeId

  • ReviewCategories

  • ReviewModules

is_required

Boolean

参数解释：

是否必填。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

状态码：401

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

请求示例

无

响应示例

状态码：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
  } ]
}

状态码：400

Bad Request

{
  "error_code" : "CH.00405011",
  "error_msg" : "错误请求"
}

状态码：401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "认证信息过期"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

错误码

请参见错误码。

父主题： Discussion

相关文档