文档首页/ 需求管理 CodeArts Req/ API参考/ API/ IPD评审单管理/ 查询评审单列表
更新时间：2024-11-30 GMT+08:00
查看PDF
分享

查询评审单列表

功能介绍

查询评审单列表,支持查询变更评审，通用评审，基线评审

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v1/ipdprojectservice/projects/{project_id}/review/query

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目Id

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

type

是

String

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

created_by

否

String

评审单创建人Id

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

否

Integer

分页参数每页大小。默认值为20，需要可以被offset整除，不能为0，否则会指定为默认值

sort

否

Array of SortInfo objects

排序方式
表3 DateFilterVO

参数

是否必选

参数类型

描述

start_date

否

String

时间过滤器开始时间戳，-2表示未设置内容

end_date

否

String

时间过滤器结束时间戳，-2表示未设置内容
表4 SortInfo

参数

是否必选

参数类型

描述

field

否

String

排序字段

asc

否

Boolean

是否升序

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

status

String

请求状态

message

String

请求错误信息

result

ReviewListResult object

评审单列表
表6 ReviewListResult

参数

参数类型

描述

data

Array of ReviewEntity objects

评审单列表

total

Integer

项目下评审单总数。CR/BR/GR互不干扰
表7 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

评审单是否需要审批人审批，可选值为yes,no

status

StatusEntity object

评审单状态

description

String

评审单描述，列表接口不返回描述信息

cos

Array of COEntity objects

评审对象列表

ccbs

Array of CcbEntity objects

审批信息列表
表8 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

状态被哪些工作项使用
表9 COEntity

参数

参数类型

描述

after_change

String

变更对象修改后内容

review_complete_time

String

变更对象评审完成时间

review_phase_result

String

变更对象评审阶段结果

Approved：通过

Rejected：拒绝(CR)

TurnBacked：驳回(BR/GR)

review_time

String

变更对象评审时间

approver

Array of strings

变更对象审批人ID数组

before_change

String

变更对象工作项修改前内容

category

String

变更对象工作项类型，此处固定为CO

ccb_info

CcbEntity object

变更对象实际审批人信息

ccbs

Array of UserEntity objects

变更对象审批人列表，兼容旧版评审。现版本审批人只有一人

change_type

String

变更类型，基线评审的修改类型属于Modify

Modify：修改

Move：迁移

Delete：删除

co2review

String

变更对象关联的评审单Id

created_by

String

变更对象的创建人ID

created_date

String

变更对象创建时间

description

String

变更对象描述信息

id

String

变更对象Id

issue_id

String

变更对象关联的工作项Id

issue_number

String

变更对象关联的工作项编号

modified_by

String

变更对象最后修改人Id

modified_date

String

变更对象最后修改时间

opinion_comments

Array of ReviewOpinionEntity objects

变更对象评审意见

reviewer

Array of strings

变更对象评审专家Id列表

status

String

变更对象状态
表10 CcbEntity

参数

参数类型

描述

approval_time

String

审批时间

category

String

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

ccb2review

String

审批对象关联的评审单Id

co_id

String

关联的变更对象Id

id

String

审批对象Id

owner

UserEntity object

审批人

approval_comments

String

审批意见
表11 UserEntity

参数

参数类型

描述

id

String

用户Id

name

String

用户名称

nick_name

String

用户昵称
表12 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

评审意见

请求示例

查询变更评审列表

{endpoint}/v1/ipdprojectservice/projects/{project_id}/review/query

{
  "type" : "CR",
  "limit" : 20,
  "offset" : 0
}

响应示例

状态码： 200

OK

{
  "status" : "success",
  "result" : {
    "data" : [ {
      "id" : "1017841308053581824",
      "number" : "CR20240710077151",
      "state" : "正在工作",
      "title" : "111",
      "category" : "CR",
      "created_by" : {
        "id" : "a360371833bf4c558f796fd707b44daf",
        "name" : "devcloud_devcloud_s00404480_01",
        "nick_name" : "测试昵称"
      },
      "modified_by" : {
        "id" : "a360371833bf4c558f796fd707b44daf",
        "name" : "devcloud_devcloud_s00404480_01",
        "nick_name" : "测试昵称"
      },
      "created_time" : "1720601878000",
      "modified_time" : "1720601878000",
      "need_approval" : "yes",
      "status" : {
        "display_value" : "待评审",
        "code" : "ToBeReviewed"
      }
    } ],
    "total" : 1
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： IPD评审单管理

相关文档