# 获取检视意见设置（废弃） #### 功能介绍 获取检视意见设置 ![](https://support.huaweicloud.com/api-codeartsrepo/public_sys-resources/note_3.0-zh-cn.png) 当前API已经废弃，请使用[获取检视意见设置](https://support.huaweicloud.com/api-codeartsrepo/ShowReviewSetting.html) #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CodeHub/doc?api=ShowReviewSetting)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### URI GET /v2/repositories/{repository_id}/review_setting 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | repository_id | 是 | Integer | **参数解释：** 仓库id。 **约束限制：** 必传。 **取值范围：** 最小值：**1** 最大值：**2147483647** | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 必传。 **取值范围：** 字符串长度不少于1，不超过10万。 **默认取值：** 不涉及。 | #### 响应参数 **状态码： 200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [Error] object | **参数解释：** 响应错误码 | | result | [ReviewSettingDto] object | **参数解释：** 返回新建检视意见的相关信息。 **取值范围：** 不涉及。 | | status | String | **参数解释：** 响应状态。 **取值范围：** - success，表示接口调用成功。 - failed，表示接口调用失败。 | 表4Error | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释：** 调用此接口失败时返回的错误码。 **取值范围：** - CH.10000，系统繁忙，请稍后再试。 | | message | String | **参数解释：** 调用此接口失败时返回的提示信息。 **取值范围：** - "系统繁忙，请稍后再试"。 | 表5ReviewSettingDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | categories_and_modules_enabled | Boolean | **参数解释：** 是否启用检视意见分类与模块。 **取值范围：** - true：启用检视意见分类与模块。 - false：禁用检视意见分类与模块。 | | secondary_category_enabled | Boolean | **参数解释：** 是否启用系统预置检视意见分类。 **取值范围：** - true：启用系统预置检视意见分类。 - false：禁用系统预置检视意见分类，此时可勾选分类或添加自定义分类。 | | primary_categories | Array of [CategoryDto] objects | **参数解释：** 已勾选的分类。 **取值范围：** 不涉及。 | | review_default_categories | Array of strings | **参数解释：** 已勾选的分类的key。 **取值范围：** 不涉及。 | | review_customized_categories | Array of strings | **参数解释：** 自定义分类。 **取值范围：** 数量限制：20条。 单条长度限制：200字符。 单条字符限制：unicode编码\\u0000 - \\uffff，不支持emoji表情、部分生僻字等特殊字符。 单条blank限制：不能为null或空字符串或全是空格。 | | review_modules | Array of strings | **参数解释：** 检视意见模块。 **取值范围：** 数量限制：20条。 单条长度限制：200字符。 单条字符限制：unicode编码\\u0000 - \\uffff，不支持emoji表情、部分生僻字等特殊字符。 单条blank限制：不能为null或空字符串或全是空格。 | | source_id | Integer | **参数解释：** 仓库id。 **取值范围：** 最小值：**1** 最大值：**2147483647** | | source_type | String | **参数解释：** 项目类型，目前仅支持一种。 **取值范围：** - Project | | source_path | String | **参数解释：** 仓库路径。 **取值范围：** 不涉及。 | | secondary_category_type | String | **参数解释：** 系统预置检视意见分类(废弃字段)。 **取值范围：** HiCode | | secondary_categories | Array of [CategoryDto] objects | **参数解释：** 系统预置检视意见。 **取值范围：** 不涉及。 | 表6CategoryDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释：** 系统预置检视意见分类的key。 **取值范围：** 不涉及。 | | name_zh | String | **参数解释：** 系统预置检视意见分类的中文名。 **取值范围：** 不涉及。 | | name_en | String | **参数解释：** 系统预置检视意见分类的英文名。 **取值范围：** 不涉及。 | | sub_categories | Array of [CategoryDto] objects | **参数解释：** 系统预置检视意见分类的子分类。 **取值范围：** 不涉及。 | #### 请求示例 ``` GET https://{endpoint}/v2/repositories/{repository_id}/review_setting ``` #### 响应示例 **状态码： 200** OK ``` { "result": { "categories_and_modules_enabled": true, "secondary_category_enabled": false, "primary_categories": [ { "key": "realize", "name_zh": "算法实现", "name_en": "Algorithm" } ], "review_default_categories": [ "realize" ], "review_customized_categories": [ "分类" ], "review_modules": [ "模块" ], "source_id": 2111704470, "source_type": "Project", "source_path": "sll_test00006/mr_test" }, "status": "success" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK |