Help Center/ CodeArts Req/ API Reference/ API/ IPD Review Management/ Querying the Review List (BRs/GRs)

Updated on 2026-10-13 GMT+08:00

Querying the Review List (BRs/GRs)

Function

This API is used to query the list of BRs or GRs.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
codeartsreq:workflow:list	List	-	codeartsreq:Model codeartsreq:ProjectId	-	-

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition 32-character ID of a project, which must be unique. Obtain the value by calling the API for querying the IPD project list. The value of id in the response message body is the project ID. Constraints N/A Range A string of 32 characters consisting of letters and digits. Default Value N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
filter	Yes	Array of filter objects	Definition Filter condition array. The logical relationship between multiple objects is AND.
sort	No	Array of sort objects	Definition Sorting parameter array. Multiple objects are sorted by object sequence.
page	No	page object	Definition Pagination parameter object.

**Table 3** filter
Parameter	Mandatory	Type	Description
field	No	field object	Definition Filter field. Constraints Filter fields for query. Range Obtain the filter field name through the filter on the GUI. The options are as follows: category: type status created_date: creation time approver: decision maker cc: Cc recipient Default Value N/A

**Table 4** field
Parameter	Mandatory	Type	Description
values	No	Array of strings	Definition Filter value array. Constraints This field is used together with the filter field and operator. You are advised to use it based on the filter parameters on the GUI. Range N/A Default Value N/A
operator	No	String	Definition Operator. Constraints N/A Range \|\| indicates a logical OR relationship between the query target and the values. ! indicates a logical NOT relationship. = indicates an EQUALS relationship, generally applied when the values array contains a single element. <>, <, and > represent range, less-than, and greater-than relationships, respectively. These are typically used for datetime or integer comparisons and include boundary values. Default Value N/A

**Table 5** sort
Parameter	Mandatory	Type	Description
field	No	String	Definition Sorting field. Constraints Sorting field of the query object. Range Sorting identifier fields in the table header. Default Value N/A
asc	No	Boolean	Definition Ascending or not. Constraints N/A Range true and false Default Value N/A

**Table 6** page
Parameter	Mandatory	Type	Description
page_no	No	Integer	Definition Page index. Constraints N/A Range 1 to 10000 Default Value 1
page_size	No	Integer	Definition Page size. Constraints N/A Range 5 to 200 Default Value 200

Response Parameters

Status code: 200

**Table 7** Response body parameters
Parameter	Type	Description
status	String	Definition Response status. Range success: The response is successful. error: The response failed.
message	String	Definition Request information. Range N/A
result	result object	Definition Request result. Range N/A

**Table 8** result
Parameter	Type	Description
total	Integer	Definition Total number. Range N/A
process_instances	Array of process_instances objects	Definition Review list. Range N/A

**Table 9** process_instances
Parameter	Type	Description
cc	String	Definition Cc recipient. Multiple values are separated by commas (,). Range N/A
approver	String	Definition Review decision-maker. Range N/A
closed_time	String	Definition Review completion time. Range N/A
reviewer	String	Definition Review expert. Range N/A
type	String	Definition Review type. Range N/A
title	String	Definition Title. Range N/A
modified_date	String	Definition Modification time. Range N/A
created_by	UserVO object	Definition Creator. Range N/A
domain_id	String	Definition Project space ID. Range N/A
number	String	Definition Review No. Range N/A
need_approval	String	Definition Whether the review needs to be approved by the decision-maker. Range N/A
modified_by	UserVO object	Definition Modifier. Range N/A
approval_time	String	Definition Approval time. Range N/A
plan_end_date	String	Definition Planned end time. Range N/A
id	String	Definition Review ID. Range N/A
state	String	Definition Review data status. Range N/A
created_date	String	Definition Creation time. Range N/A
category	String	Definition Review type. Range N/A
plan_start_date	String	Definition Planned start time. Range N/A
status	status object	Definition Review status. Range N/A
ccbs	Array of UserObject objects	Definition Decision-maker object list. Range N/A
opinions	Array of opinions objects	Definition List of opinion objects. Range N/A

**Table 10** UserVO
Parameter	Type	Description
user_id	String	Definition User ID. Range N/A
user_num_id	Integer	Definition Short ID of a user. Range N/A
user_name	String	Definition Username. Range N/A
domain_id	String	Definition ID of the domain to which the user belongs. Range N/A
domain_name	String	Definition Tenant name. Range N/A
nick_name	String	Definition User alias. Range N/A
role_id	String	Definition Role ID. If a user has multiple roles in a project, use commas (,) to separate the values. Range N/A
role_name	String	Definition Role name. If a user has multiple roles, use commas (,) to separate the values. Range N/A
role_code	String	Definition Role code. If a user has multiple roles, use commas (,) to separate the values. Range N/A

**Table 11** status
Parameter	Type	Description
code	String	Definition Status code. Range N/A
name	String	Definition Status name. Range N/A

**Table 12** UserObject
Parameter	Type	Description
watcher	String	Definition Favorited or not. Range N/A
user_id	String	Definition User ID. Range N/A
user_num_id	String	Definition Digital ID of a user. Range N/A
user_name	String	Definition Username. Range N/A
domain_id	String	Definition Tenant ID. Range N/A
domain_name	String	Definition Tenant name. Range N/A
nick_name	String	Definition Alias. Range N/A
role_id	String	Definition Role ID. Range N/A
role_name	String	Definition Role name. Range N/A
image_id	String	Definition User avatar. Range N/A
region	String	Definition Region. Range N/A
opinion	String	Definition Comments. Range N/A
description	String	Definition Description. Range N/A
owner	String	Definition Owner. Range N/A
ccbId	String	Definition Decision-maker ID. Range N/A
has_removed	String	Definition Whether the user is removed from the project. Range N/A

**Table 13** opinions
Parameter	Type	Description
id	String	Definition Primary key of an opinion. Range N/A
type	String	Definition Type. Range N/A
state	String	Definition Data status. Range N/A
status	String	Definition Opinion status. Range N/A
region	String	Definition Region. Range N/A
category	String	Definition Type. Range N/A
title	String	Definition Title. Range N/A
rounds	String	Definition Rounds of reviews. Range N/A
opinion	String	Definition Review comment. Range N/A
description	String	Definition Description. Range N/A
modified_by	String	Definition Modifier. Range N/A
modified_date	String	Definition Modification time. Range N/A
created_by	UserObject object	Definition Creator. Range N/A
created_date	String	Definition Creation time. Range N/A
tenant_id	String	Definition Tenant ID. Range N/A
domain_id	String	Definition Project space ID. Range N/A
issue_category	String	Definition Object type. Range N/A
issue_id	String	Definition Object ID. Range N/A
curr_owner	UserObject object	Definition Current owner. Range N/A
co_id	String	Definition Change object ID. Range N/A
user_id	String	Definition User ID. Range N/A
opinion_issue_id	String	Definition Review work item ID. Range N/A
opinion_issue_category	String	Definition Review work item type. Range N/A

Status code: 400

**Table 14** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code. Range N/A
error_msg	String	Definition Error description, which is a supplement to error_code. Range N/A

Example Requests

Querying the BR list

POST https://{endpoint}/v1/ipdprojectservice/projects/b811b0bef58b479d9b5e4ab856b349ab/process-instances/query

Body parameters:
{
    "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
    }
}

Example Responses

Status code: 200

{
  "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" : "Sam 1",
        "role_id" : "0c4370789ec246bb9f5480077e1119d5,0438be11ed284528ae79c8afd054ecf1",
        "role_name" : "Project manager and project administrator"
      },
      "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" : "Sam 1",
        "role_id" : "0c4370789ec246bb9f5480077e1119d5,0438be11ed284528ae79c8afd054ecf1",
        "role_name" : "Project manager and project administrator"
      },
      "approval_time" : "null",
      "plan_end_date" : "null",
      "id" : "1156640623684530177",
      "state" : "In use",
      "created_date" : "1753694214029",
      "category" : "BR",
      "plan_start_date" : "null",
      "status" : {
        "code" : "ToBeReviewed",
        "name" : "Pending review"
      },
      "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" : "Developer",
        "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" : "Developer",
          "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" : "Developer",
          "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"
      } ]
    } ]
  }
}

Status code: 400

{
  "error_code" : "PM.02174103",
  "error_msg" : "No permission."
}

Status Codes

Status Code	Description
200	OK
400	Response upon a request failure. For example, the user does not have the operation permission or the project does not exist.

Error Codes

See Error Codes.

Parent topic: IPD Review Management

Previous topic: Modifying a Change Review (BR/GR)

Next topic: Querying the Approver/Review Expert