根据条件分页获取评审对象
功能介绍
根据条件分页获取评审对象
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/reviews/page
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过获取CodeArts项目ID接口查询项目列表获取。 取值范围: 字符串长度32。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
params |
是 |
ReviewPageParam object |
参数解释: 评审分页参数 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
deleted |
否 |
String |
参数解释: 是否删除 取值范围:
|
limit |
否 |
Integer |
参数解释: 每页显示的条目数量,最大支持200条 |
mindmap_id |
否 |
String |
参数解释: 脑图ID 取值范围: 大小写字母、数字。 长度限制固定32位 |
node_id |
否 |
String |
参数解释: 节点ID 取值范围: 大小写字母、数字。 长度限制固定32位 |
node_value |
否 |
String |
参数解释: 节点内容 取值范围: 大小写字母、数字、中文、符号。 长度限制1-2000位 |
offset |
否 |
Integer |
参数解释: 起始偏移量,表示从此偏移量开始查询,offset大于等于0,小于等于100000 |
status |
否 |
String |
参数解释: 评审状态 取值范围: open-评审开启 close-评审关闭 |
type |
否 |
String |
参数解释: 评审类型 取值范围: 致命|严重|一般|提示 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释: 错误码 取值范围: 大小写字母、数字。 长度限制0到20位 |
data |
BasePageInfoReview object |
参数解释: 返回体 取值范围: 不涉及 |
message |
String |
参数解释: 错误信息 取值范围: 大小写字母、数字、符号、中文。 长度限制0到1000位 |
参数 |
参数类型 |
描述 |
---|---|---|
list |
Array of Review objects |
参数解释: 列表 取值范围: 不涉及 |
limit |
Integer |
参数解释: 每页显示的条目数量,最大支持200条 取值范围: 数字,范围1-200 |
offset |
Integer |
参数解释: 起始偏移量,表示从此偏移量开始查询,offset大于等于0,小于等于100000 取值范围: 数字,范围0-100000 |
pages |
Integer |
参数解释: 总页数量 取值范围: 数字,范围1-100 |
size |
Integer |
参数解释: 列表个数 取值范围: 数字,范围1-200 |
total |
Long |
参数解释: 总数 取值范围: 数字,范围1-100000 |
参数 |
参数类型 |
描述 |
---|---|---|
charger |
String |
参数解释: 名称 取值范围: 大小写字母、数字、中文、符号。 |
create_time |
String |
参数解释: 创建时间 取值范围: 固定日期格式yyyy-MM-dd HH:mm:ss |
creator |
String |
参数解释: 创建人 取值范围: 大小写字母、数字、中文。 |
deleted |
String |
参数解释: 是否删除 取值范围:
|
description |
String |
参数解释: 描述 取值范围: 大小写字母、数字、中文、符号。 |
id |
String |
参数解释: id 主键 取值范围: 大小写字母、数字。 长度限制固定32位 |
mindmap_id |
String |
参数解释: 脑图ID 取值范围: 大小写字母、数字。 长度限制固定32位 |
node_id |
String |
参数解释: 节点ID 取值范围: 大小写字母、数字。 长度限制固定32位 |
node_value |
String |
参数解释: 节点值 取值范围: 大小写字母、数字、中文、符号。 |
status |
String |
参数解释: 状态 取值范围: 大小写字母、数字、中文、符号。 |
type |
String |
参数解释: 类型 取值范围: 大小写字母、数字、中文、符号。 |
update_time |
String |
参数解释: 更新时间 取值范围: 固定日期格式yyyy-MM-dd HH:mm:ss |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释: 接口调用错误码。 取值范围: 大小写字母、数字。 长度限制0到20位 |
data |
String |
参数解释: 接口调用返回体 取值范围: 不涉及 |
message |
String |
参数解释: 接口调用错误信息 取值范围: 大小写字母、数字、符号、中文。 长度限制0到1000位 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释: 接口调用错误码。 取值范围: 大小写字母、数字。 长度限制0到20位 |
data |
String |
参数解释: 接口调用返回体 取值范围: 不涉及 |
message |
String |
参数解释: 接口调用错误信息 取值范围: 大小写字母、数字、符号、中文。 长度限制0到1000位 |
请求示例
根据条件分页获取评审对象
post https://{endpoint}/v2/b94c9a6947a44597891e0a7362e7383f/reviews/page { "params" : { "mindmap_id" : "ba2725c5b72c4ec18214736ceb99f3d7", "offset" : 1, "limit" : 10, "node_value" : "" } }
响应示例
状态码:200
OK
{ "code" : "success", "data" : { "total" : 1, "list" : [ { "id" : "fa46fdf99a8f4f1f97198689839dc9db", "charger" : "昵称xxx1111144445454545", "description" : "1", "status" : "open", "type" : "一般", "creator" : "昵称xxx1111144445454545", "deleted" : "no", "mindmap_id" : "fb6bd82a6c084fdab0d8e5d8f820eabc", "node_id" : "7B3E87D771504220A2B9C757E6AC42E1", "node_value" : "子主题", "create_time" : "2025/01/10 10:55:51 GMT+08:00", "update_time" : "2025/01/10 10:55:51 GMT+08:00" } ], "offset" : 1, "limit" : 10, "pages" : 1, "size" : 1 }, "message" : null }
状态码:400
Bad Request
{ "error_code" : "TESTMIND.00021882", "error_msg" : "分支、计划id长度不合法,请稍后重试" }
状态码:401
Unauthorized
{ "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
错误码
请参见错误码。