# 查询评审单列表 - ListIpdReviewForms #### 功能介绍 查询评审单列表,支持查询变更评审，通用评审，基线评审 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-projectman/projectman_api_1002.html)。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-projectman/projectman_03_Permission.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | codeartsreq:review:list | List | - | - codeartsreq:Model - codeartsreq:ProjectId | - | - | #### URI POST /v1/ipdprojectservice/projects/{project_id}/review/query 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目32位ID，项目唯一标识。通过[查询IPD项目列表](https://support.huaweicloud.com/api-projectman/ShowIpdProjectList.html)获取，响应消息体中的**id**字段的值就是项目ID。 **约束限制**： 不涉及。 **取值范围**： 32个字符，由英文字母和数字组成。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | type | 是 | String | **参数解释**： 评审单类型。 **取值范围**： - CR：变更评审 - BR：基线评审 - GR：通用评审 | | created_by | 否 | String | **参数解释**： 评审单创建人ID。可通过[查询项目成员列表](https://support.huaweicloud.com/api-projectman/ListProjectUsers.html)接口获取，响应消息体中的**id**字段的值就是用户ID。 **约束限制**： 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 | **参数解释**： 分页起始，从0开始，为limit整数倍。 **约束限制**： 需要可以整除limit。 **取值范围**： 不涉及。 **默认取值**： 0 | | limit | 否 | Integer | **参数解释**： 分页参数每页大小。 **约束限制**： 需要可以被offset整除，不能为0，否则会指定为默认值。 **取值范围**： 不涉及。 **默认取值**： 20 | | sort | 否 | Array of [SortInfo] objects | **参数解释**： 排序方式。 | 表3DateFilterVO | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | start_date | 否 | String | **参数解释**： 时间过滤器开始时间戳，如1711036800000。 **约束限制**： -2表示未设置内容。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | end_date | 否 | String | **参数解释**： 时间过滤器结束时间戳，如1711036899999。 **约束限制**： -2表示未设置内容。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表4SortInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | field | 否 | String | **参数解释**： 排序字段code。 **约束限制**： 不涉及 **取值范围**： 通过[查询字段模板列表](https://support.huaweicloud.com/api-projectman/ListIssueFields.html)接口获取，响应体中的**code**就是字段唯一标识。 **默认取值**： 不涉及 | | asc | 否 | Boolean | **参数解释**： 是否升序。 **约束限制**： 不涉及 **取值范围**： - true：升序 - false：降序 **默认取值**： 不涉及 | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | status | String | **参数解释**： 返回状态。 **取值范围**： - success：响应成功 - error：响应失败 | | message | String | 请求错误信息 | | result | [ReviewListResult] object | 评审单列表 | 表6ReviewListResult | 参数 | 参数类型 | 描述 | |:---|:---|:---| | data | Array of [ReviewListEntity] objects | 评审单列表 | | total | Integer | 项目下评审单总数。CR/BR/GR互不干扰 | 表7ReviewListEntity | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 评审单ID。可以通过[查询评审单列表](https://support.huaweicloud.com/api-projectman/ListIpdReviewForms.html)接口获取，响应消息体中的**id**字段的值就是评审单ID。 **取值范围**： 18\~19个字符的数字字符串。 | | 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 | **参数解释**： 评审单抄送人列表。 **取值范围**： 最多50个抄送人。 | | created_time | String | **参数解释**： 评审单创建时间戳，单位：毫秒。 **取值范围**： 不涉及。 | | modified_time | String | **参数解释**： 评审单最后修改时间戳，单位：毫秒。 **取值范围**： 不涉及。 | | plan_end_date | String | **参数解释**： 计划完成日期时间戳，单位：毫秒。不可早于计划开始日期。 **取值范围**： 不涉及。 | | plan_start_date | String | **参数解释**： 计划开始日期时间戳，单位：毫秒。不可晚于计划完成日期。 **取值范围**： 不涉及。 | | close_time | String | **参数解释**： 评审单关闭时间戳，单位：毫秒。 **取值范围**： 不涉及。 | | need_approval | String | **参数解释**： 是否需要决策人审批。 **取值范围**： - yes：需要审批 - no：不需要审批 | | status | [StatusEntity] object | **参数解释**： 评审单状态信息。 | | description | String | **参数解释**： 评审单描述信息。注意：列表接口不返回描述信息。 **取值范围**： 最大50000个字符。 | | closed_time | String | **参数解释**： 评审单完成时间戳，单位：毫秒。 **取值范围**： 不涉及。 | | approver | String | **参数解释**： 决策人用户ID，多个决策人时使用逗号分隔。 **取值范围**： 不涉及。 | | reviewer | String | **参数解释**： 评审人用户ID，多个评审人时使用逗号分隔。 **取值范围**： 不涉及。 | | cos | Array of [COEntity] objects | **参数解释**： 评审对象（CO）列表。 **取值范围**： 最多50个评审对象。 | | ccbs | Array of [CcbEntity] objects | **参数解释**： 审批信息列表。 **取值范围**： 不涉及。 | | cc | String | **参数解释**： 抄送人用户ID，多个抄送人时使用逗号分隔。 **取值范围**： 不涉及。 | 表8StatusEntity | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | **参数解释**： 状态被哪些工作项使用。 | 表9COEntity | 参数 | 参数类型 | 描述 | |:---|:---|:---| | after_change | String | **参数解释**： 变更对象修改后内容。 **取值范围**： 不涉及。 | | review_complete_time | String | **参数解释**： 变更对象评审完成时间。 **取值范围**： 不涉及。 | | review_phase_result | String | **参数解释**： 变更对象评审阶段结果。 **取值范围**： - Approved：通过 - Rejected：拒绝(CR) - TurnBacked：驳回(BR/GR) | | review_time | String | **参数解释**： 变更对象评审时间。 **取值范围**： 不涉及。 | | before_change | String | **参数解释**： 变更对象工作项修改前内容。 **取值范围**： 不涉及。 | | category | String | **参数解释**： 变更对象工作项类型，此处固定为CO。 **取值范围**： 不涉及。 | | ccb_info | [CcbEntity] object | **参数解释**： 变更对象实际决策人信息。 **取值范围**： 不涉及。 | | ccbs | Array of [UserEntity] objects | **参数解释**： 变更对象决策人列表，列表中只有一个元素。 **取值范围**： 不涉及。 | | change_type | String | **参数解释**： 变更类型。 **取值范围**： - Modify：修改 - Move：迁移 - Delete：删除 - ModifyPlan：移入移出已基线的发布或迭代 | | 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 | **参数解释**： 变更对象状态。 **取值范围**： - Canceled：撤销评审单 - ToBeCommitted：保存评审单 - ToBeReviewed：评审单待评审 - ToBeApproved：评审单待决策 - Approved：评审单决策通过评审单 - TurnBacked：驳回评审单 - Rejected：拒绝评审单 - End：评审单已完成 - Passed：评审单已通过 | 表10CcbEntity | 参数 | 参数类型 | 描述 | |:---|:---|:---| | approval_time | String | **参数解释**： 审批时间。 **取值范围**： 不涉及。 | | category | String | **参数解释**： 工作项类型，审批对象固定为CCB。 **取值范围**： 不涉及。 | | ccb2review | String | **参数解释**： 审批对象关联的评审单ID。 **取值范围**： 不涉及。 | | co_id | String | **参数解释**： 关联的变更对象ID。 **取值范围**： 不涉及。 | | id | String | **参数解释**： 审批对象ID。 **取值范围**： 不涉及。 | | owner | [UserEntity] object | **参数解释**： 决策人。 **取值范围**： 不涉及。 | | approval_comments | String | **参数解释**： 审批意见。 **取值范围**： 不涉及。 | 表11UserEntity | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 用户ID，可通过[查询项目成员列表](https://support.huaweicloud.com/api-projectman/ListProjectUsers.html)接口获取，响应消息体中的**id**字段的值就是用户ID。 **取值范围**： 不涉及。 | | name | String | **参数解释**： 用户名称。 **取值范围**： 2\~64个字符。 | | nick_name | String | **参数解释**： 用户昵称。 **取值范围**： 2\~30个字符。 | 表12ReviewOpinionEntity | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | **参数解释**： 评审意见。 **取值范围**： 不涉及。 | 表13ReviewCommentEntity | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 评审意见对象ID。 **取值范围**： 不涉及。 | | user_id | String | **参数解释**： 评审用户ID。 **取值范围**： 不涉及。 | | other_user_id | String | **参数解释**： 其他用户Id（转他人）。 **取值范围**： 不涉及。 | | result | String | **参数解释**： 评审结果。 **取值范围**： 不涉及。 | | comment | String | **参数解释**： 评审意见。 **取值范围**： 不涉及。 | **状态码：400** 表14响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。 **取值范围**： 不涉及。 | | error_msg | String | **参数解释**： 错误描述，对error_code的补充解释。 **取值范围**： 不涉及。 | #### 请求示例 查询变更评审列表 ``` POST https://{endpoint}/v1/ipdprojectservice/projects/de7115f62a96485b8ceaac6e68c701c4/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 | 通用错误响应 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-projectman/ErrorCode.html)。