文档首页/ 需求管理 CodeArts Req/ API参考/ API/ IPD评审单管理/ 查询评审单列表（BR/GR） - ShowIpdProcessInstances
更新时间：2025-12-11 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询评审单列表（BR/GR） - ShowIpdProcessInstances

功能介绍

查询评审单列表， 适用于基线评审（BR）和通用评审（GR）列表查询

调用方法

请参见如何调用API。

URI

POST /v1/ipdprojectservice/projects/{project_id}/process-instances/query

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

filter

是

Array of filter objects

参数解释：

过滤条件数组，多个对象之间逻辑关系为且

sort

否

Array of sort objects

参数解释：

排序参数数组，多个对象按对象顺序排序

page

否

page object

参数解释：

分页参数对象
表3 filter

参数

是否必选

参数类型

描述

field

否

field object

参数解释：

过滤字段。

约束限制：

查询对象可过滤字段。

取值范围：

通过界面过滤器获取过滤字段名称。如下示例

category：类型

status：状态

created_date：创建时间

approver：决策人

cc：抄送人

默认取值：

不涉及。
表4 field

参数

是否必选

参数类型

描述

values

否

Array of strings

参数解释：

过滤值数组。

约束限制：

结合过滤字段和操作符一起配套使用，建议参考界面过滤器参数进行使用。

取值范围：

不涉及。

默认取值：

不涉及。

operator

否

String

参数解释：

操作符

约束限制：

不涉及

取值范围：

"||"：表示查询目标和values之间的关系为或；

"!"：表示查询目标和values之间的关系为非；

"="：表示查询目标和values之间的关系为等于，通常values中只有一个元素时使用；

"<>"、"<"、">"：表示查询目标和values之间的关系为区间、小于、大于，通常用于日期时间、整数类型的过滤，含边界值。

默认取值：

不涉及。
表5 sort

参数

是否必选

参数类型

描述

field

否

String

参数解释：

排序字段。

约束限制：

查询对象上可排序字段。

取值范围：

界面表头上存在排序标识字段。

默认取值：

不涉及。

asc

否

Boolean

参数解释：

是否升序。

约束限制：

不涉及。

取值范围：

true，false。

默认取值：

不涉及。
表6 page

参数

是否必选

参数类型

描述

page_no

否

Integer

参数解释：

分页索引

约束限制：

不涉及

取值范围：

最小值1，最大值10000

默认取值：

1

page_size

否

Integer

参数解释：

分页大小

约束限制：

不涉及

取值范围：

最小值5，最大值200

默认取值：

200

响应参数

状态码：200

表7 响应Body参数

参数

参数类型

描述

status

String

参数解释：

返回状态。

取值范围：

success：响应成功

error：响应失败

message

String

参数解释：

请求信息。

取值范围：

不涉及。

result

result object

参数解释：

请求结果。

取值范围：

不涉及。
表8 result

参数

参数类型

描述

total

Integer

参数解释：

总数。

取值范围：

不涉及。

process_instances

Array of process_instances objects

参数解释：

评审单列表。

取值范围：

不涉及。
表9 process_instances

参数

参数类型

描述

cc

String

参数解释：

抄送人，多值使用英文逗号分隔。

取值范围：

不涉及。

approver

String

参数解释：

评审单决策人。

取值范围：

不涉及。

closed_time

String

参数解释：

评审单完成时间。

取值范围：

不涉及。

reviewer

String

参数解释：

评审专家。

取值范围：

不涉及。

type

String

参数解释：

评审分类。

取值范围：

不涉及。

title

String

参数解释：

标题。

取值范围：

不涉及。

modified_date

String

参数解释：

修改时间。

取值范围：

不涉及。

created_by

UserVO object

参数解释：

创建人。

取值范围：

不涉及。

domain_id

String

参数解释：

租户id。

取值范围：

不涉及。

number

String

参数解释：

评审编号。

取值范围：

不涉及。

need_approval

String

参数解释：

是否需要决策人审批。

取值范围：

不涉及。

modified_by

UserVO object

参数解释：

修改人。

取值范围：

不涉及。

approval_time

String

参数解释：

审批时间。

取值范围：

不涉及。

plan_end_date

String

参数解释：

计划结束时间。

取值范围：

不涉及。

id

String

参数解释：

评审单id。

取值范围：

不涉及。

state

String

参数解释：

评审单数据状态。

取值范围：

不涉及。

created_date

String

参数解释：

创建时间。

取值范围：

不涉及。

category

String

参数解释：

评审单类型。

取值范围：

不涉及。

plan_start_date

String

参数解释：

计划开始时间。

取值范围：

不涉及。

status

status object

参数解释：

评审单状态。

取值范围：

不涉及。

ccbs

Array of UserObject objects

参数解释：

决策人对象列表。

取值范围：

不涉及。

opinions

Array of opinions objects

参数解释：

opinion对象列表。

取值范围：

不涉及。
表10 SecurityLevelResult

参数

参数类型

描述

id

String

参数解释：

密级字段id。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

display_value

String

参数解释：

密级字段名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

value

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

value:

code

String

参数解释：

密级编码。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

sequence

Double

参数解释：

密级排序值，越大级别越高
表11 UserVO

参数

参数类型

描述

user_id

String

参数解释：

用户Id。

取值范围：

不涉及。

user_num_id

Integer

参数解释：

用户短Id。

取值范围：

不涉及。

user_name

String

参数解释：

用户名称。

取值范围：

不涉及。

domain_id

String

参数解释：

用户所属域Id。

取值范围：

不涉及。

domain_name

String

参数解释：

租户名称。

取值范围：

不涉及。

nick_name

String

参数解释：

用户昵称。

取值范围：

不涉及。

role_id

String

参数解释：

角色Id，用户在项目中具有多个角色时用英文逗号分隔。

取值范围：

不涉及。

role_name

String

参数解释：

用户角色名称，多个角色用英文逗号分隔。

取值范围：

不涉及。
表12 status

参数

参数类型

描述

code

String

参数解释：

状态编码。

取值范围：

不涉及。

name

String

参数解释：

状态名称。

取值范围：

不涉及。
表13 UserObject

参数

参数类型

描述

watcher

String

参数解释：

是否关注。

取值范围：

不涉及。

user_id

String

参数解释：

用户id。

取值范围：

不涉及。

user_num_id

String

参数解释：

用户数字id。

取值范围：

不涉及。

user_name

String

参数解释：

用户名称。

取值范围：

不涉及。

domain_id

String

参数解释：

租户id。

取值范围：

不涉及。

domain_name

String

参数解释：

租户名称。

取值范围：

不涉及。

nick_name

String

参数解释：

昵称。

取值范围：

不涉及。

role_id

String

参数解释：

角色id。

取值范围：

不涉及。

role_name

String

参数解释：

角色名称。

取值范围：

不涉及。

image_id

String

参数解释：

用户头像。

取值范围：

不涉及。

region

String

参数解释：

区域。

取值范围：

不涉及。

opinion

String

参数解释：

意见。

取值范围：

不涉及。

description

String

参数解释：

描述。

取值范围：

不涉及。

owner

String

参数解释：

责任人。

取值范围：

不涉及。

ccbId

String

参数解释：

决策人Id。

取值范围：

不涉及。

has_removed

String

参数解释：

是否已移出项目。

取值范围：

不涉及。
表14 opinions

参数

参数类型

描述

id

String

参数解释：

opinion主键。

取值范围：

不涉及。

type

String

参数解释：

类型分类。

取值范围：

不涉及。

state

String

参数解释：

数据状态。

取值范围：

不涉及。

status

String

参数解释：

opinion状态。

取值范围：

不涉及。

region

String

参数解释：

区域。

取值范围：

不涉及。

category

String

参数解释：

类型。

取值范围：

不涉及。

title

String

参数解释：

标题。

取值范围：

不涉及。

rounds

String

参数解释：

评审轮次。

取值范围：

不涉及。

opinion

String

参数解释：

评审意见。

取值范围：

不涉及。

description

String

参数解释：

描述。

取值范围：

不涉及。

modified_by

String

参数解释：

修改人。

取值范围：

不涉及。

modified_date

String

参数解释：

修改时间。

取值范围：

不涉及。

created_by

UserObject object

参数解释：

创建人。

取值范围：

不涉及。

created_date

String

参数解释：

创建时间。

取值范围：

不涉及。

tenant_id

String

参数解释：

租户id。

取值范围：

不涉及。

domain_id

String

参数解释：

项目id。

取值范围：

不涉及。

issue_category

String

参数解释：

对象类型。

取值范围：

不涉及。

issue_id

String

参数解释：

对象id。

取值范围：

不涉及。

curr_owner

UserObject object

参数解释：

当前责任人。

取值范围：

不涉及。

co_id

String

参数解释：

变更对象id。

取值范围：

不涉及。

user_id

String

参数解释：

用户id。

取值范围：

不涉及。

opinion_issue_id

String

参数解释：

评审工作项id。

取值范围：

不涉及。

opinion_issue_category

String

参数解释：

评审工作项类型。

取值范围：

不涉及。

状态码：400

表15 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

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

取值范围：

不涉及。

请求示例

查询基线评审单列表

{{url}}/v1/ipdprojectservice/projects/b811b0bef58b479d9b5e4ab856b349ab/process-instances/query

body参数：
{
    "filter": [
        {
            "category": {
                "values": [
                    "BR"
                ],
                "operator": "||"
            }
        },
        {
            "status": {
                "values": [
                    "Committed",
                    "ToBeReviewed",
                    "ToBeApproved",
                    "Rejected",
                    "Passed",
                    "Canceled",
                    "TurnBacked"
                ],
                "operator": "||"
            }
        },
        {
            "created_date": {
                "values": [
                    1753632000000,
                    1753718399999
                ],
                "operator": "<>"
            }
        },
        {
            "approver": {
                "values": [
                    "0dcd2224fcda451ebd983b0e8dd9e6ee"
                ],
                "operator": "||"
            }
        }
    ],
    "page": {
        "page_no": 1,
        "page_size": 20
    }
}

响应示例

状态码：200

OK

{
  "status" : "success",
  "message" : "null",
  "result" : {
    "total" : 1,
    "process_instances" : [ {
      "cc" : "a360371833bf4c558f796fd707b44daf,68dbd07f132e4005a263156085df6af3,29da565ad02d4aa081568420a15fcaa9,0dcd2224fcda451ebd983b0e8dd9e6ee",
      "approver" : "0dcd2224fcda451ebd983b0e8dd9e6ee",
      "closed_time" : "null",
      "reviewer" : "68dbd07f132e4005a263156085df6af3",
      "type" : "process_instance",
      "title" : "test",
      "modified_date" : "1753694214029",
      "created_by" : {
        "user_id" : "a360371833bf4c558f796fd707b44daf",
        "user_num_id" : "null",
        "user_name" : "devcloud_devcloud_01",
        "domain_id" : "4e919d73499648e3b0292cd3cbef806a",
        "domain_name" : "null",
        "nick_name" : "张三丰1",
        "role_id" : "0c4370789ec246bb9f5480077e1119d5,0438be11ed284528ae79c8afd054ecf1",
        "role_name" : "项目经理,项目管理员"
      },
      "domain_id" : "1155517541943128064",
      "number" : "BR20250728665812",
      "need_approval" : "yes",
      "modified_by" : {
        "user_id" : "a360371833bf4c558f796fd707b44daf",
        "user_num_id" : "null",
        "user_name" : "devcloud_devcloud_01",
        "domain_id" : "4e919d73499648e3b0292cd3cbef806a",
        "domain_name" : "null",
        "nick_name" : "张三丰1",
        "role_id" : "0c4370789ec246bb9f5480077e1119d5,0438be11ed284528ae79c8afd054ecf1",
        "role_name" : "项目经理,项目管理员"
      },
      "approval_time" : "null",
      "plan_end_date" : "null",
      "id" : "1156640623684530177",
      "state" : "正在工作",
      "created_date" : "1753694214029",
      "category" : "BR",
      "plan_start_date" : "null",
      "status" : {
        "code" : "ToBeReviewed",
        "name" : "待评审"
      },
      "ccbs" : [ {
        "watcher" : "null",
        "user_id" : "0dcd2224fcda451ebd983b0e8dd9e6ee",
        "user_num_id" : "null",
        "user_name" : "devcloud_devcloud_01/build_admin_trust",
        "domain_id" : "4e919d73499648e3b0292cd3cbef806a",
        "domain_name" : "null",
        "nick_name" : "null",
        "role_id" : "b91711747d2043afa8fbd7657960c74f",
        "role_name" : "开发人员",
        "image_id" : "null",
        "region" : "null",
        "opinion" : "null",
        "description" : "null",
        "owner" : "null",
        "ccbId" : "null",
        "has_removed" : "null"
      } ],
      "opinions" : [ {
        "id" : "null",
        "type" : "null",
        "state" : "null",
        "status" : "null",
        "region" : "null",
        "category" : "null",
        "title" : "null",
        "rounds" : "null",
        "opinion" : "null",
        "description" : "null",
        "modified_by" : "null",
        "modified_date" : "null",
        "created_by" : {
          "watcher" : "null",
          "user_id" : "68dbd07f132e4005a263156085df6af3",
          "user_num_id" : "null",
          "user_name" : "devcloud_devcloud_01/deploy_admin_trust",
          "domain_id" : "4e919d73499648e3b0292cd3cbef806a",
          "domain_name" : "null",
          "nick_name" : "null",
          "role_id" : "b91711747d2043afa8fbd7657960c74f",
          "role_name" : "开发人员",
          "image_id" : "null",
          "region" : "null",
          "opinion" : "null",
          "description" : "null",
          "owner" : "null",
          "ccbId" : "null",
          "has_removed" : "null"
        },
        "created_date" : "null",
        "tenant_id" : "null",
        "domain_id" : "null",
        "issue_category" : "null",
        "issue_id" : "null",
        "curr_owner" : {
          "watcher" : "null",
          "user_id" : "68dbd07f132e4005a263156085df6af3",
          "user_num_id" : "null",
          "user_name" : "devcloud_devcloud_01/deploy_admin_trust",
          "domain_id" : "4e919d73499648e3b0292cd3cbef806a",
          "domain_name" : "null",
          "nick_name" : "null",
          "role_id" : "b91711747d2043afa8fbd7657960c74f",
          "role_name" : "开发人员",
          "image_id" : "null",
          "region" : "null",
          "opinion" : "null",
          "description" : "null",
          "owner" : "null",
          "ccbId" : "null",
          "has_removed" : "null"
        },
        "co_id" : "null",
        "user_id" : "null",
        "opinion_issue_id" : "null",
        "opinion_issue_category" : "null"
      } ]
    } ]
  }
}

状态码：400

通用错误响应

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

状态码

状态码

描述

200

OK

400

通用错误响应

错误码

请参见错误码。

父主题： IPD评审单管理

相关文档