文档首页/ 需求管理 CodeArts Req/ API参考/ API/ IPD评审单管理/ 查询评审单详情 - ShowIpdReviewForm
更新时间:2025-12-11 GMT+08:00
分享

查询评审单详情 - ShowIpdReviewForm

功能介绍

查询评审单详情,支持查询变更评审,通用评审,基线评审。

调用方法

请参见如何调用API

URI

GET /v1/ipdprojectservice/projects/{project_id}/review/{id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

id

String

评审单Id

表2 Query参数

参数

是否必选

参数类型

描述

category

String

评审单类型,可选值为CR,BR,GR

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

status

String

参数解释:

响应状态。

取值范围:

  • success:响应成功

  • error:响应失败

message

String

参数解释:

响应信息。

取值范围:

不涉及。

result

ReviewEntity object

评审详情

表4 ReviewEntity

参数

参数类型

描述

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

参数解释:

审批信息列表

old_status

StatusEntity object

参数解释:

评审单历史状态

cc

Array of UserEntity objects

参数解释:

抄送人列表

表5 COEntity

参数

参数类型

描述

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:评审单已通过

表6 CcbEntity

参数

参数类型

描述

approval_time

String

参数解释:

审批时间。

取值范围:

不涉及。

category

String

参数解释:

工作项类型,审批对象固定为CCB。

取值范围:

不涉及。

ccb2review

String

参数解释:

审批对象关联的评审单Id。

取值范围:

不涉及。

co_id

String

参数解释:

关联的变更对象Id。

取值范围:

不涉及。

id

String

参数解释:

审批对象Id。

取值范围:

不涉及。

owner

UserEntity object

参数解释:

决策人。

取值范围:

不涉及。

approval_comments

String

参数解释:

审批意见。

取值范围:

不涉及。

表7 ReviewOpinionEntity

参数

参数类型

描述

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

参数解释:

评审意见。

取值范围:

不涉及。

表8 ReviewCommentEntity

参数

参数类型

描述

id

String

参数解释:

评审意见对象Id。

取值范围:

不涉及。

user_id

String

参数解释:

评审用户Id。

取值范围:

不涉及。

other_user_id

String

参数解释:

其他用户Id(转他人)。

取值范围:

不涉及。

result

String

参数解释:

评审结果。

取值范围:

不涉及。

comment

String

参数解释:

评审意见。

取值范围:

不涉及。

表9 UserEntity

参数

参数类型

描述

id

String

参数解释:

用户id,可通过获取当前用户信息接口获取,响应消息体中的id字段的值就是用户id。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

name

String

参数解释:

用户名称。

约束限制:

最小长度:2,最大长度:64。

取值范围:

不涉及。

默认取值:

不涉及。

nick_name

String

参数解释:

用户昵称。

约束限制:

最小长度:2,最大长度:30。

取值范围:

不涉及。

默认取值:

不涉及。

表10 StatusEntity

参数

参数类型

描述

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

参数解释:

状态被哪些工作项使用。

表11 SecurityLevelResult

参数

参数类型

描述

id

String

参数解释:

密级字段id。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

display_value

String

参数解释:

密级字段名称。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

value

String

参数解释:

用户自定义的密级字段的值。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

value:

code

String

参数解释:

密级编码。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

sequence

Double

参数解释:

密级排序值,越大级别越高

状态码:400

表12 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

error_msg

String

参数解释:

错误描述,对error_code的补充解释。

取值范围:

不涉及。

请求示例

查询基线评审详情

https://{endpoint}/v1/ipdprojectservice/projects/b54914d464d1498a97d683ef198ec448/review/1029697355810648065?category=BR

响应示例

状态码:200

OK

{
  "status" : "success",
  "result" : {
    "id" : "1029697355810648065",
    "number" : "BR20240812233640",
    "state" : "正在工作",
    "title" : "BR-IR",
    "category" : "BR",
    "created_by" : {
      "id" : "a360371833bf4c558f796fd707b44daf",
      "name" : "devcloud_devcloud_01",
      "nick_name" : "测试昵称"
    },
    "modified_by" : {
      "id" : "system",
      "name" : "系统"
    },
    "created_time" : "1723428580000",
    "modified_time" : "1723428601000",
    "plan_end_date" : "1724688000000",
    "plan_start_date" : "1723478400000",
    "need_approval" : "true",
    "status" : {
      "display_value" : "已通过",
      "code" : "Passed"
    },
    "description" : "<p><strong>【基线描述】</strong></p>",
    "cos" : [ {
      "after_change" : "{\"view\":{},\"execute\":{},\"snapshot\":{\"develop_owner\":null,\"type\":\"requirement\",\"plan_test_end_date\":null,\"number\":\"IR20240703054812\",\"convolution_actual_hours\":null,\"path\":\"/1015209126636986369\",\"workload_man_day\":null,\"children\":null,\"id\":\"1015209126636986369\",\"state\":\"正在工作\",\"need_break\":{\"id\":\"995623980368965685\",\"display_value\":\"是\",\"value\":\"yes\",\"code\":\"yes\",\"value_py\":\"yes\",\"sequence\":1.0,\"level\":1,\"domain_id\":\"995623979534299136\",\"belong_definition_type\":\"5\"},\"baseline\":null,\"priority\":{\"id\":\"995623980368965646\",\"display_value\":\"低\",\"value\":\"低\",\"code\":\"低\",\"value_py\":\"1\",\"sequence\":3.0,\"level\":1,\"domain_id\":\"995623979534299136\",\"belong_definition_type\":\"5\"},\"break_status\":{\"id\":\"995623980368965652\",\"display_value\":\"未分解\",\"value\":\"undecomposed\",\"code\":\"undecomposed\",\"value_py\":\"undecomposed\",\"sequence\":2.0,\"level\":1,\"domain_id\":\"995623979534299136\",\"belong_definition_type\":\"5\"},\"assignee\":{\"watcher\":null,\"user_id\":\"a360371833bf4c558f796fd707b44daf\",\"user_num_id\":4091,\"user_name\":\"devcloud_devcloud_01\",\"domain_id\":\"4e919d73499648e3b0292cd3cbef806a\",\"domain_name\":\"devcloud_devcloud_01\",\"nick_name\":\"测试昵称\",\"role_id\":\"a6e1428a71e14bc489bcd5b460bfbced,d77754d3becb42ec80431f49f8906bcf\",\"role_name\":\"项目管理员,项目经理\",\"image_id\":null,\"region\":null,\"opinion\":null,\"description\":null,\"owner\":null,\"ccbId\":null,\"has_removed\":null},\"status\":{\"id\":\"995623980381548551\",\"belonging\":\"IN_PROGRESS\",\"space_id\":\"995623979534299136\",\"name\":\"测试\",\"status_category\":null,\"code\":\"Test\",\"definition_type\":\"5\",\"belong_definition_type\":3,\"belong_scope\":null,\"display_value\":\"测试\",\"position\":4,\"displayable\":1,\"editable\":1,\"deletable\":1,\"mutable\":1,\"title_py\":\"cs\",\"builtin\":null,\"label\":null,\"description\":null,\"created_by\":\"a360371833bf4c558f796fd707b44daf\",\"created_userinfo\":null,\"created_on\":null,\"created_date\":1715333654000,\"modified_date\":1715333654000,\"modified_by\":\"a360371833bf4c558f796fd707b44daf\",\"category_code\":null,\"editing_fields\":null,\"associate\":null,\"linkage_node_fields\":false},\"tenant_id\":\"4e919d73499648e3b0292cd3cbef806a\",\"plan_pi\":null,\"plan_dev_end_date\":null,\"plan_end_date\":null,\"cascade_delete\":\"none\",\"modified_by\":{\"watcher\":0,\"user_id\":\"a360371833bf4c558f796fd707b44daf\",\"user_num_id\":4091,\"user_name\":\"devcloud_devcloud_01\",\"domain_id\":\"4e919d73499648e3b0292cd3cbef806a\",\"domain_name\":\"devcloud_devcloud_01\",\"nick_name\":\"测试昵称\",\"role_id\":\"a6e1428a71e14bc489bcd5b460bfbced,d77754d3becb42ec80431f49f8906bcf\",\"role_name\":\"项目管理员,项目经理\",\"role_alias_name\":\"Project admin,Project manager\",\"role_code\":\"project_admin,Project manager\",\"image_id\":\"\",\"region\":\"\",\"has_removed\":\"\"},\"closed_flag\":null,\"collaborative_status\":[],\"position_float\":\"9999999538.6270750000\",\"domain_id\":{\"id\":\"995623979534299136\",\"name\":\"IPD-feature-M1-0510-copyFrom\",\"title\":\"IPD-feature-M1-0510-copyFrom\",\"project_id\":\"b54914d464d1498a97d683ef198ec448\",\"parent_id\":\"\",\"category\":\"Project\",\"created_by\":\"a360371833bf4c558f796fd707b44daf\",\"model_id\":\"10001\",\"children\":[]},\"processing_owner\":null,\"stay_days\":26,\"ir2feature\":\"\",\"related_network_security\":{\"id\":\"995623980368965637\",\"display_value\":\"否\",\"value\":\"no\",\"code\":\"no\",\"value_py\":\"no\",\"sequence\":2.0,\"level\":1,\"domain_id\":\"995623979534299136\",\"belong_definition_type\":\"5\"},\"assigned_cc\":null,\"workitem2label\":null,\"c7205110023690788864\":null,\"close_time\":null,\"modified_date\":1723255005000,\"created_by\":{\"watcher\":0,\"user_id\":\"a360371833bf4c558f796fd707b44daf\",\"user_num_id\":4091,\"user_name\":\"devcloud_devcloud_01\",\"domain_id\":\"4e919d73499648e3b0292cd3cbef806a\",\"domain_name\":\"devcloud_devcloud_01\",\"nick_name\":\"测试昵称\",\"role_id\":\"a6e1428a71e14bc489bcd5b460bfbced,d77754d3becb42ec80431f49f8906bcf\",\"role_name\":\"项目管理员,项目经理\",\"role_alias_name\":\"Project admin,Project manager\",\"role_code\":\"project_admin,Project manager\",\"image_id\":\"\",\"region\":\"\",\"has_removed\":\"\"},\"status_modified_date\":1720150409000,\"important\":null,\"collaboratives\":null,\"parent_id\":null,\"business_domain\":{\"id\":\"995623980368965664\",\"display_value\":\"软件\",\"value\":\"software\",\"code\":\"software\",\"value_py\":\"rj\",\"sequence\":0.0,\"level\":1,\"domain_id\":\"995623979534299136\",\"belong_definition_type\":\"5\"},\"region\":\"example\",\"plan_processing_end_date\":null,\"link\":\"\",\"is_suspended\":null,\"change_status\":null,\"title\":\"IR-API-附件1\",\"sum_workload_man_day\":null,\"ir2rr\":\"\",\"plan_start_date\":null,\"convolution_plan_hours\":null,\"no_break_reason\":null,\"submitted_by\":[{\"watcher\":0,\"user_id\":\"a360371833bf4c558f796fd707b44daf\",\"user_num_id\":4091,\"user_name\":\"devcloud_devcloud_01\",\"domain_id\":\"4e919d73499648e3b0292cd3cbef806a\",\"domain_name\":\"devcloud_devcloud_01\",\"nick_name\":\"测试昵称\",\"role_id\":\"a6e1428a71e14bc489bcd5b460bfbced,d77754d3becb42ec80431f49f8906bcf\",\"role_name\":\"项目管理员,项目经理\",\"role_alias_name\":\"Project admin,Project manager\",\"role_code\":\"project_admin,Project manager\",\"image_id\":\"\",\"region\":\"\",\"has_removed\":\"\"}],\"test_owner\":null,\"created_date\":1719974317000,\"category\":\"IR\",\"setup\":true,\"inherit_button\":\"hide\",\"parent_status\":\"no\"}}",
      "approver" : [ ],
      "before_change" : "{\"view\":{}}",
      "category" : "CO",
      "change_type" : "Modify",
      "co2review" : "1029697355810648065",
      "created_by" : "a360371833bf4c558f796fd707b44daf",
      "created_date" : "2024-08-12T10:09:40Z",
      "description" : "<p>【需求背景】</p><p><br></p><p>【需求价值】</p><p><br></p><p>【需求详情】</p>",
      "id" : "1029697354418139136",
      "issue_id" : "1015209126636986369",
      "issue_number" : "IR20240703054812",
      "modified_by" : "a360371833bf4c558f796fd707b44daf",
      "modified_date" : "2024-08-12T10:09:40Z",
      "reviewer" : [ ],
      "status" : "Test"
    } ],
    "ccbs" : [ { } ]
  }
}

状态码:400

通用错误响应

{
  "error_code" : "PM.02174103",
  "error_msg" : "无操作权限"
}

状态码

状态码

描述

200

OK

400

通用错误响应

错误码

请参见错误码

相关文档