- 最新动态
- 功能总览
- 服务公告
- 产品介绍
- 快速入门
- 用户指南
- 最佳实践
-
API参考
- 使用前必读
- API概览
- 如何调用API
-
API
- SSH Key
-
Repository
- 获取分支目录下的文件
- 获取仓库统计数据
- 获取一个仓库下特定分支的图片文件
- 修改被流水线引用的仓库状态
- 判断用户是否有仓库的管理员权限
- 设置仓库是公开状态还是私有状态
- 获取一个仓库下特定分支指定文件内容
- 获取公开示例模板列表
- 创建仓库
- 根据仓库名组名获取仓库短id,用以拼接与commitid对应提交详情页面url
- 根据组名和仓库名查询某仓库某分支对应的提交
- 查询某仓库对应的分支
- 根据仓库id查询仓库某分支对应的提交,提供更多可选参数
- 添加部署密钥
- 删除仓库部署密钥
- 获取仓库上一次的提交统计信息
- 仓库统计
- 删除仓库
- 查看仓库的创建状态
- 查询某仓库的标签列表
- 新建标签
- 查询某个仓库的详细信息
- 获取代码提交行数
- 下载仓库
- 新建保护分支
- 删除保护分支
- 批量删除保护分支
- 新建保护tag
- 删除保护tag
- 获取仓库分支列表
- 获取仓库合并请求列表
- 获取仓库合并请求详情
- 获取仓库ip白名单
- 添加仓库ip白名单
- 修改仓库ip白名单
- 删除仓库ip白名单
- 获取合并请求的变化
- 关联仓库与成员组
- 根据仓库短ID锁定仓库
- 根据仓库短ID解锁仓库
- 审核合并请求
- 获取关联工作项信息
- 根据仓库短ID和合并请求短ID获取检视人信息
- 获取变更文件列表
- Tenant
- Group
- V2Project
- RepoMember
- Commit
- File
- User
- Webhook
- Project
- v2仓库管理
- Discussion
- 应用示例
- 附录
- 历史API
-
常见问题
- 认证鉴权问题
- 成员权限问题
-
代码上传下载问题
- 从本地推送代码仓到CodeArts Repo时,报错"Error: Deny by project hooks setting 'default': message of commit"
- 用户推送二进制文件到CodeArts Repo失败
- 执行git push 命令时,报错'origin' does not appear to be a git repository...
- 在CentOS系统下使用HTTPS协议克隆代码时,报错"The requested URL returned error: 401"
- 使用git pull拉取CodeArts Repo的代码失败,报错"Merge branch 'master' of https://test.com Please Enter a commit"
- fatal: refusing to merge unrelated histories
- 如何阻止涉密文件被推送到CodeArts Repo代码仓库
- 仓库迁移问题
- 合并请求问题
- Fork同步问题
- 仓库容量问题
- 常见问题汇总
- 视频帮助
- 计费说明
- 文档下载
- 通用参考
链接复制成功!
获取检视意见设置
功能介绍
获取检视意见设置
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/repositories/{repository_id}/review_setting
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
repository_id |
是 |
Integer |
参数解释: 仓库id。 约束限制: 必传。 取值范围: 最小值:1 最大值:2147483647 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
error |
Error object |
参数解释: 响应错误码 |
result |
ReviewSettingDto object |
参数解释: 返回新建检视意见的相关信息。 取值范围: 无。 |
status |
String |
参数解释: 响应状态。 取值范围:
|
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释: 调用此接口失败时返回的错误码。 取值范围:
|
message |
String |
参数解释: 调用此接口失败时返回的提示信息。 取值范围:
|
参数 |
参数类型 |
描述 |
---|---|---|
categories_and_modules_enabled |
Boolean |
参数解释: 是否启用检视意见分类与模块。 取值范围:
|
secondary_category_enabled |
Boolean |
参数解释: 是否启用系统预置检视意见分类。 取值范围:
|
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 |
参数解释: 项目类型,目前仅支持一种。 取值范围:
|
source_path |
String |
参数解释: 仓库路径。 取值范围: 无。 |
secondary_category_type |
String |
参数解释: 系统预置检视意见分类(废弃字段)。 取值范围: HiCode |
secondary_categories |
Array of CategoryDto objects |
参数解释: 系统预置检视意见。 取值范围: 无。 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |