查询评审单列表 - ListIpdReviewForms
功能介绍
查询评审单列表,支持查询变更评审,通用评审,基线评审
调用方法
请参见如何调用API。
URI
POST /v1/ipdprojectservice/projects/{project_id}/review/query
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
type |
是 |
String |
参数解释: 评审单类型。 取值范围:
|
|
created_by |
否 |
String |
参数解释: 评审单创建人Id。用户通过获取当前用户信息接口获取,响应消体中的user_id字段的值就是用户32位uuid。 约束限制: 正则表达式:"[0-9a-z]{32}"。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
keyword |
否 |
String |
参数解释: 关键字搜索,标题支持模糊搜索,编号支持精确搜索。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
created_time |
否 |
DateFilterVO object |
参数解释: 评审单创建时间过滤器 |
|
plan_end_date |
否 |
DateFilterVO object |
参数解释: 评审单计划完成时间过滤器 |
|
plan_start_date |
否 |
DateFilterVO object |
参数解释: 评审单计划开始时间过滤器 |
|
closed_time |
否 |
DateFilterVO object |
参数解释: 评审单完成时间过滤器 |
|
approver |
否 |
String |
参数解释: 按评审单决策人Id过滤 约束限制: 多值使用英文逗号分隔。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
reviewer |
否 |
String |
参数解释: 按评审单评审专家Id过滤 约束限制: 多值使用英文逗号分隔。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
offset |
否 |
Integer |
参数解释: 分页参数起始偏移量。 约束限制: 需要可以整除limit。 取值范围: 不涉及。 默认取值: 0 |
|
limit |
否 |
Integer |
参数解释: 分页参数每页大小。 约束限制: 需要可以被offset整除,不能为0,否则会指定为默认值。 取值范围: 不涉及。 默认取值: 20 |
|
sort |
否 |
Array of SortInfo objects |
参数解释: 排序方式 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
start_date |
否 |
String |
参数解释: 时间过滤器开始时间戳,-2表示未设置内容。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
end_date |
否 |
String |
参数解释: 时间过滤器结束时间戳,-2表示未设置内容。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
field |
否 |
String |
参数解释: 排序字段code 约束限制: 不涉及 取值范围: 对应字段的唯一code,可选值可以通过查询字段模板列表接口获取,响应体中的code就是字段唯一标识。 默认取值: 不涉及 |
|
asc |
否 |
Boolean |
参数解释: 是否升序 约束限制: 不涉及 取值范围: true(是) false(否) 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
status |
String |
参数解释: 返回状态。 取值范围:
|
|
message |
String |
请求错误信息 |
|
result |
ReviewListResult object |
评审单列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
Array of ReviewListEntity objects |
评审单列表 |
|
total |
Integer |
项目下评审单总数。CR/BR/GR互不干扰 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
评审单id |
|
number |
String |
评审单编号 |
|
state |
String |
参数解释: 评审单的生命周期。 取值范围:
|
|
title |
String |
评审单标题 |
|
category |
String |
评审单类别,CR:变更评审,BR:基线评审,GR:通用评审 |
|
created_by |
UserEntity object |
评审单创建人 |
|
modified_by |
UserEntity object |
评审单最后修改人 |
|
assigned_cc |
Array of UserEntity objects |
评审单抄送人 |
|
created_time |
String |
评审单创建时间戳 |
|
modified_time |
String |
评审单最后修改时间戳 |
|
plan_end_date |
String |
计划完成日期时间戳,不可早于计划开始日期 |
|
plan_start_date |
String |
计划开始日期时间戳,不可晚于计划完成日期 |
|
close_time |
String |
评审单完成时间 |
|
need_approval |
String |
评审单是否需要决策人审批,可选值为true,false |
|
status |
StatusEntity object |
评审单状态 |
|
description |
String |
评审单描述,列表接口不返回描述信息 |
|
closed_time |
String |
评审单完成时间 |
|
approver |
String |
决策人id |
|
reviewer |
String |
评审人id,逗号分隔 |
|
cos |
Array of COEntity objects |
评审对象列表 |
|
ccbs |
Array of CcbEntity objects |
审批信息列表 |
|
cc |
String |
抄送人id |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 状态id。 取值范围: 不涉及。 |
|
belonging |
String |
参数解释: 工作项的状态属性。 取值范围: START、IN_PROGRESS、END。 |
|
display_value |
String |
参数解释: 状态名。 取值范围: 不涉及。 |
|
code |
String |
参数解释: 状态唯一标识。 取值范围: 不涉及。 |
|
created_by |
String |
参数解释: 状态创建人。 取值范围: 不涉及。 |
|
created_time |
String |
参数解释: 状态创建时间。 取值范围: 不涉及。 |
|
modified_by |
String |
参数解释: 状态修改人。 取值范围: 不涉及。 |
|
modified_time |
String |
参数解释: 状态最近修改时间。 取值范围: 不涉及。 |
|
category_code |
Array of strings |
参数解释: 状态被哪些工作项使用。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
after_change |
String |
参数解释: 变更对象修改后内容。 取值范围: 不涉及。 |
|
review_complete_time |
String |
参数解释: 变更对象评审完成时间。 取值范围: 不涉及。 |
|
review_phase_result |
String |
参数解释: 变更对象评审阶段结果。 取值范围:
|
|
review_time |
String |
参数解释: 变更对象评审时间。 取值范围: 不涉及。 |
|
before_change |
String |
参数解释: 变更对象工作项修改前内容。 取值范围: 不涉及。 |
|
category |
String |
参数解释: 变更对象工作项类型,此处固定为CO。 取值范围: 不涉及。 |
|
ccb_info |
CcbEntity object |
参数解释: 变更对象实际决策人信息。 取值范围: 不涉及。 |
|
ccbs |
Array of UserEntity objects |
参数解释: 变更对象决策人列表,兼容旧版评审。现版本决策人只有一人。 取值范围: 不涉及。 |
|
change_type |
String |
参数解释: 变更类型。 取值范围:
|
|
co2review |
String |
参数解释: 变更对象关联的评审单Id。 取值范围: 不涉及。 |
|
created_by |
String |
参数解释: 变更对象的创建人ID。 取值范围: 不涉及。 |
|
created_date |
String |
参数解释: 变更对象创建时间。 取值范围: 不涉及。 |
|
description |
String |
参数解释: 变更对象描述信息。 取值范围: 不涉及。 |
|
id |
String |
参数解释: 变更对象Id。 取值范围: 不涉及。 |
|
issue_id |
String |
参数解释: 变更对象关联的工作项Id。 取值范围: 不涉及。 |
|
issue_number |
String |
参数解释: 变更对象关联的工作项编号。 取值范围: 不涉及。 |
|
issue_category |
String |
参数解释: 变更对象关联的工作项类型。 取值范围: 不涉及。 |
|
modified_by |
String |
参数解释: 变更对象最后修改人Id。 取值范围: 不涉及。 |
|
modified_date |
String |
参数解释: 变更对象最后修改时间。 取值范围: 不涉及。 |
|
opinions |
Array of UserEntity objects |
参数解释: 变更对象评审专家Id列表(创建变更评审时使用)。 取值范围: 不涉及。 |
|
opinion_comments |
Array of ReviewOpinionEntity objects |
参数解释: 变更对象评审意见。 取值范围: 不涉及。 |
|
review_comments |
Array of ReviewCommentEntity objects |
参数解释: 变更对象评审意见(评审更新时使用)。 取值范围: 不涉及。 |
|
approval_comments |
Array of ReviewCommentEntity objects |
参数解释: 变更对象决策意见(决策更新时使用)。 取值范围: 不涉及。 |
|
reviewer |
Array of strings |
参数解释: 变更对象评审专家Id列表。 取值范围: 不涉及。 |
|
approver |
Array of strings |
参数解释: 变更对象决策人ID数组。 取值范围: 不涉及。 |
|
status |
String |
参数解释: 变更对象状态。 取值范围:
|
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
approval_time |
String |
参数解释: 审批时间。 取值范围: 不涉及。 |
|
category |
String |
参数解释: 工作项类型,审批对象固定为CCB。 取值范围: 不涉及。 |
|
ccb2review |
String |
参数解释: 审批对象关联的评审单Id。 取值范围: 不涉及。 |
|
co_id |
String |
参数解释: 关联的变更对象Id。 取值范围: 不涉及。 |
|
id |
String |
参数解释: 审批对象Id。 取值范围: 不涉及。 |
|
owner |
UserEntity object |
参数解释: 决策人。 取值范围: 不涉及。 |
|
approval_comments |
String |
参数解释: 审批意见。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 用户id,可通过获取当前用户信息接口获取,响应消息体中的id字段的值就是用户id。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
name |
String |
参数解释: 用户名称。 约束限制: 最小长度:2,最大长度:64。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
nick_name |
String |
参数解释: 用户昵称。 约束限制: 最小长度:2,最大长度:30。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
category |
String |
参数解释: 评审意见对象类型,固定为Opinion。 取值范围: 不涉及。 |
|
co_id |
String |
参数解释: 评审意见对象关联的变更对象Id。 取值范围: 不涉及。 |
|
created_by |
UserEntity object |
参数解释: 评审意见创建人,即评审人。 取值范围: 不涉及。 |
|
created_date |
String |
参数解释: 评审意见创建时间。 取值范围: 不涉及。 |
|
curr_owner |
UserEntity object |
参数解释: 当前评审人。 取值范围: 不涉及。 |
|
id |
String |
参数解释: 评审意见对象Id。 取值范围: 不涉及。 |
|
modified_date |
String |
参数解释: 评审意见最后修改时间。 取值范围: 不涉及。 |
|
review_comments |
String |
参数解释: 评审意见。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 评审意见对象Id。 取值范围: 不涉及。 |
|
user_id |
String |
参数解释: 评审用户Id。 取值范围: 不涉及。 |
|
other_user_id |
String |
参数解释: 其他用户Id(转他人)。 取值范围: 不涉及。 |
|
result |
String |
参数解释: 评审结果。 取值范围: 不涉及。 |
|
comment |
String |
参数解释: 评审意见。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 密级字段id。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
display_value |
String |
参数解释: 密级字段名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
value |
String |
参数解释: 用户自定义的密级字段的值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 value: |
|
code |
String |
参数解释: 密级编码。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
sequence |
Double |
参数解释: 密级排序值,越大级别越高 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码。 取值范围: 不涉及。 |
|
error_msg |
String |
参数解释: 错误描述,对error_code的补充解释。 取值范围: 不涉及。 |
请求示例
查询变更评审列表
https://{endpoint}/v1/ipdprojectservice/projects/{project_id}/review/query
{
"type" : "CR",
"limit" : 20,
"offset" : 0
}
响应示例
状态码:200
OK
{
"status" : "success",
"result" : {
"data" : [ {
"id" : "1073260377648705537",
"number" : "CR20241210781532",
"state" : "正在工作",
"title" : "21-CR-03x",
"category" : "CR",
"created_by" : {
"id" : "a360371833bf4c558f796fd707b44daf",
"name" : "devcloud_devcloud_01",
"nick_name" : "测试账号"
},
"modified_by" : {
"id" : "system",
"name" : "系统"
},
"created_time" : "1733814814000",
"modified_time" : "1733814883000",
"plan_end_date" : "1735574400000",
"plan_start_date" : "1733673600000",
"need_approval" : "yes",
"status" : {
"display_value" : "已完成",
"code" : "End"
},
"closed_time" : "1733814883000",
"cc" : "a360371833bf4c558f796fd707b44daf"
}, {
"id" : "1072969160107925505",
"number" : "CR20241209780443",
"state" : "正在工作",
"title" : "21-CR-02",
"category" : "CR",
"created_by" : {
"id" : "a360371833bf4c558f796fd707b44daf",
"name" : "devcloud_devcloud_01",
"nick_name" : "测试账号"
},
"modified_by" : {
"id" : "a360371833bf4c558f796fd707b44daf",
"name" : "devcloud_devcloud_01",
"nick_name" : "测试账号"
},
"created_time" : "1733745382000",
"modified_time" : "1733745382000",
"need_approval" : "yes",
"status" : {
"display_value" : "待评审",
"code" : "ToBeReviewed"
}
} ],
"total" : 2
}
}
状态码:400
通用错误响应
{
"error_code" : "PM.02174103",
"error_msg" : "无操作权限"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
通用错误响应 |
错误码
请参见错误码。