文档首页/ 代码托管 CodeArts Repo/ API参考（联盟区域）/ API/ Discussion/ 获取检视意见设置
更新时间：2026-01-08 GMT+08:00
查看PDF
分享

获取检视意见设置

功能介绍

获取检视意见设置

URI

GET /v2/repositories/{repository_id}/review_setting

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

是

Integer

仓库短id

最小值：1

最大值：2147483647

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

error

Error object

响应错误

result

ReviewSettingDto object

响应结果

status

String

响应状态
表4 Error

参数

参数类型

描述

code

String

错误码

message

String

错误信息
表5 ReviewSettingDto

参数

参数类型

描述

categories_and_modules_enabled

Boolean

是否开启检视意见分类和模块

secondary_category_enabled

Boolean

是否开启二级分类

forbidden_add_to_issue

Boolean

是否禁止关联issue

primary_categories

Array of CategoryDto objects

一级分类

数组长度：0 - 100

review_default_categories

Array of strings

默认分类

数组长度：0 - 100

review_customized_categories

Array of strings

自定义分类

数组长度：0 - 100

review_modules

Array of strings

检视意见模块

数组长度：0 - 100

source_id

Integer

目标id

最小值：1

最大值：2147483647

source_type

String

目标类型

source_path

String

目标路径

secondary_category_type

String

二级分类类型

secondary_categories

Array of CategoryDto objects

二级分类
表6 CategoryDto

参数

参数类型

描述

key

String

key

name_zh

String

中文名

name_en

String

英文名

sub_categories

Array of CategoryDto objects

二级分类

数组长度：0 - 100

请求示例

GET https://{endpoint}/v2/repositories/{repository_id}/review_setting

{
  "body" : "检视意见标题",
  "review_categories" : "",
  "review_modules" : "",
  "severity" : "suggestion",
  "assignee_id" : 9124
}

响应示例

状态码： 200

OK

{
  "result" : {
    "categories_and_modules_enabled" : true,
    "secondary_category_enabled" : false,
    "primary_categories" : [ {
      "key" : "design",
      "name_zh" : "代码设计",
      "name_en" : "Code design"
    }, {
      "key" : "regulations",
      "name_zh" : "编程军规问题",
      "name_en" : "Programming guideline"
    } ],
    "review_default_categories" : [ "design", "regulations" ],
    "review_customized_categories" : [ "xxx", "yyy" ],
    "review_modules" : [ "aaa", "bbb", "ccc" ],
    "source_id" : 2111699786,
    "source_type" : "Project",
    "source_path" : "DevOpsqlcylxm00004/project-test"
  },
  "status" : "success"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： Discussion