Help Center/ CodeArts Req/ API Reference/ API/ IPD Review Management/ Querying Reviews

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

Querying Reviews

Function

Query reviews, including change reviews (CRs), general reviews (GRs), and baseline reviews (BRs).

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:review:list	List	-	codeartsreq:Model codeartsreq:ProjectId	-	-

URI

POST /v1/ipdprojectservice/projects/{project_id}/review/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
type	Yes	String	Definition Review type. Range CR: change review BR: baseline review GR: general review
created_by	No	String	Definition Review creator ID. Obtain a user ID by calling the API for querying project members. The value of id in the response message body is a user ID. Constraints A string of 32 characters consisting of lowercase letters and digits. Range N/A Default Value N/A
keyword	No	String	Definition Keyword search. Fuzzy search by title and exact search by ID are supported. Constraints N/A Range N/A Default Value N/A
created_time	No	DateFilterVO object	Definition Creation time filter for reviews.
plan_end_date	No	DateFilterVO object	Definition Planned completion time filter for reviews.
plan_start_date	No	DateFilterVO object	Definition Planned start time filter for reviews.
closed_time	No	DateFilterVO object	Definition Completion time filter for reviews.
approver	No	String	Definition Review decision-maker ID. Constraints Use commas (,) to separate multiple values. Range N/A Default Value N/A
reviewer	No	String	Definition Review expert ID. Constraints Use commas (,) to separate multiple values. Range N/A Default Value N/A
offset	No	Integer	Definition Start page number. The value starts from 0 and is an integer multiple of limit. Constraints The value must be evenly divisible by limit. Range N/A Default Value 0
limit	No	Integer	Definition Number of records on each page (pagination parameter). Constraints The value must be a positive divisor of offset. Otherwise, the default value is used. Range N/A Default Value 20
sort	No	Array of SortInfo objects	Definition Sorting order.

**Table 3** DateFilterVO
Parameter	Mandatory	Type	Description
start_date	No	String	Definition Start timestamp of the time filter, for example, 1711036800000. Constraints -2 indicates that no content is set. Range N/A Default Value N/A
end_date	No	String	Definition End timestamp of the time filter, for example, 1711036899999. Constraints -2 indicates that no content is set. Range N/A Default Value N/A

**Table 4** SortInfo
Parameter	Mandatory	Type	Description
field	No	String	Definition Sorting field code. Constraints N/A Range Obtain the value from the API for querying field templates. The value is code in the response body. Default Value N/A
asc	No	Boolean	Definition Ascending or not. Constraints N/A Range true: ascending false: descending Default Value N/A

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
status	String	Definition Response status. Range success: The response is successful. error: The response fails.
message	String	Request error message.
result	ReviewListResult object	Review list.

**Table 6** ReviewListResult
Parameter	Type	Description
data	Array of ReviewListEntity objects	Review list.
total	Integer	Total number of reviews in a project. CRs, BRs, and GRs are counted separately.

**Table 7** ReviewListEntity
Parameter	Type	Description
id	String	Definition Review ID. Obtain the value by calling the Querying the Review List API. The value of id in the response body is the review ID. Range A string of 18 to 19 digits.
number	String	Definition Review ID, which is automatically generated by the system. Range N/A
state	String	Definition Lifecycle status of the review. Range In use: reviews that can be operated properly Discarded: reviews that have been deleted.
title	String	Definition Review title. Range N/A
category	String	Definition Review type. Range CR: change review BR: baseline review GR: general review
created_by	UserEntity object	Definition Information about the review form creator.
modified_by	UserEntity object	Definition Information about the last modifier of the review.
assigned_cc	Array of UserEntity objects	Definition List of Cc recipients of the review form. Range Max. 50 Cc recipients.
created_time	String	Definition Timestamp when a review form is created, in milliseconds. Range N/A
modified_time	String	Definition Timestamp when the review was last modified, in milliseconds. Range N/A
plan_end_date	String	Definition Timestamp of the planned completion date, in milliseconds. Cannot be earlier than the planned start date. Range N/A
plan_start_date	String	Definition Timestamp of the planned start date, in milliseconds. Cannot be later than the planned completion date. Range N/A
close_time	String	Definition Timestamp when a review is closed, in milliseconds. Range N/A
need_approval	String	Definition Whether the review needs to be approved by the decision-maker. Range yes: approval required no: approval not required
status	StatusEntity object	Definition Review status information.
description	String	Definition Review description. Note: The list API does not return the description. Range Max. 50,000 characters.
closed_time	String	Definition Timestamp when a review is completed, in milliseconds. Range N/A
approver	String	Definition Decision maker user ID. Separate decision maker IDs with commas (,). Range N/A
reviewer	String	Definition User ID of the reviewer. Separate reviewers with commas (,). Range N/A
cos	Array of COEntity objects	Definition List of review objects (COs). Range Max. 50 review objects.
ccbs	Array of CcbEntity objects	Definition Approval information lists. Range N/A
cc	String	Definition User ID of the Cc recipient. Separate Cc recipients with commas (,). Range N/A

**Table 8** StatusEntity
Parameter	Type	Description
id	String	Definition Status ID. Range N/A
belonging	String	Definition Work item status. Range START, IN_PROGRESS, and END
display_value	String	Definition Status name. Range N/A
code	String	Definition Unique status ID. Range N/A
created_by	String	Definition Status creator. Range N/A
created_time	String	Definition Status creation time. Range N/A
modified_by	String	Definition Status modifier. Range N/A
modified_time	String	Definition Latest modification time of a status. Range N/A
category_code	Array of strings	Definition Work items that use the status.

**Table 9** COEntity
Parameter	Type	Description
after_change	String	Definition Change object content after change. Range N/A
review_complete_time	String	Definition Review completion time of the change object. Range N/A
review_phase_result	String	Definition Review result of the change object. Range Approved Rejected (for CRs) TurnBacked (for BRs/GRs)
review_time	String	Definition Review time of the change object. Range N/A
before_change	String	Definition Work item content before change. Range N/A
category	String	Definition Work item type of the change object. The value is fixed to CO. Range N/A
ccb_info	CcbEntity object	Definition Actual decision-maker of the change object. Range N/A
ccbs	Array of UserEntity objects	Definition List of decision makers for the change object. The list contains only one element. Range N/A
change_type	String	Definition Change type. Range Modify Move: migrate Delete ModifyPlan: move it into or out of the baselined release or sprint
co2review	String	Definition ID of the review associated with a change object. Range N/A
created_by	String	Definition Creator ID of a change object. Range N/A
created_date	String	Definition Time when a change object is created. Range N/A
description	String	Definition Description of a change object. Range N/A
id	String	Definition Change object ID. Range N/A
issue_id	String	Definition ID of the work item associated with a change object. Range N/A
issue_number	String	Definition ID of the work item associated with a change object. Range N/A
issue_category	String	Definition Type of the work item associated with a change object. Range N/A
modified_by	String	Definition ID of the last modifier of a change object. Range N/A
modified_date	String	Definition Last modification time of a change object. Range N/A
opinions	Array of UserEntity objects	Definition List of change object review expert IDs (used when a change review is created). Range N/A
opinion_comments	Array of ReviewOpinionEntity objects	Definition Review comments on a change object. Range N/A
review_comments	Array of ReviewCommentEntity objects	Definition Review comments on a change object (for review update). Range N/A
approval_comments	Array of ReviewCommentEntity objects	Definition Decision-making comments on a change object (for decision-making update). Range N/A
reviewer	Array of strings	Definition List of change object review expert IDs. Range N/A
approver	Array of strings	Definition Array of change object decision-maker IDs. Range N/A
status	String	Definition Change object status. Range Canceled: The review form is canceled. ToBeCommitted: The review form is saved. ToBeReviewed: The review form is to be reviewed. ToBeApproved: The review form is to be decided. Approved: The review form is approved. TurnBacked: The review form is turned back. Rejected: The review form is rejected. End: The review form is completed. Passed: The review form is passed.

**Table 10** CcbEntity
Parameter	Type	Description
approval_time	String	Definition Approval time. Range N/A
category	String	Definition Work item type. The value is fixed at CCB. Range N/A
ccb2review	String	Definition ID of the review associated with an approval object. Range N/A
co_id	String	Definition ID of the associated change object. Range N/A
id	String	Definition Approval object ID. Range N/A
owner	UserEntity object	Definition Decision-maker. Range N/A
approval_comments	String	Definition Approval comments. Range N/A

**Table 11** UserEntity
Parameter	Type	Description
id	String	Definition User ID. Obtain it by calling the API for querying project members. The value of id in the response message body is the user ID. Range N/A
name	String	Definition Username. Range 2 to 64 characters.
nick_name	String	Definition User alias. Range 2 to 30 characters

**Table 12** ReviewOpinionEntity
Parameter	Type	Description
category	String	Definition Review comment object type. The value is fixed at Opinion. Range N/A
co_id	String	Definition ID of the change object associated with the review comment object. Range N/A
created_by	UserEntity object	Definition Review expert who creates the review comment. Range N/A
created_date	String	Definition Review comment creation time. Range N/A
curr_owner	UserEntity object	Definition Current review expert. Range N/A
id	String	Definition Review comment object ID. Range N/A
modified_date	String	Definition Last modification time of a review comment. Range N/A
review_comments	String	Definition Review comment. Range N/A

**Table 13** ReviewCommentEntity
Parameter	Type	Description
id	String	Definition Review comment object ID. Range N/A
user_id	String	Definition Reviewer ID. Range N/A
other_user_id	String	Definition ID of the review receiver (during review transfer). Range N/A
result	String	Definition Review result. Range N/A
comment	String	Definition Review comment. 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 change reviews

POST https://{endpoint}/v1/ipdprojectservice/projects/de7115f62a96485b8ceaac6e68c701c4/review/query

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

Example Responses

Status code: 200

{
  "status" : "success",
  "result" : {
    "data" : [ {
      "id" : "1073260377648705537",
      "number" : "CR20241210781532",
      "state" : "Working",
      "title" : "21-CR-03x",
      "category" : "CR",
      "created_by" : {
        "id" : "a360371833bf4c558f796fd707b44daf",
        "name" : "devcloud_devcloud_01",
        "nick_name" : "Test account"
      },
      "modified_by" : {
        "id" : "system",
        "name" : "System"
      },
      "created_time" : "1733814814000",
      "modified_time" : "1733814883000",
      "plan_end_date" : "1735574400000",
      "plan_start_date" : "1733673600000",
      "need_approval" : "yes",
      "status" : {
        "display_value" : "Completed",
        "code" : "End"
      },
      "closed_time" : "1733814883000",
      "cc" : "a360371833bf4c558f796fd707b44daf"
    }, {
      "id" : "1072969160107925505",
      "number" : "CR20241209780443",
      "state" : "Working",
      "title" : "21-CR-02",
      "category" : "CR",
      "created_by" : {
        "id" : "a360371833bf4c558f796fd707b44daf",
        "name" : "devcloud_devcloud_01",
        "nick_name" : "Test account"
      },
      "modified_by" : {
        "id" : "a360371833bf4c558f796fd707b44daf",
        "name" : "devcloud_devcloud_01",
        "nick_name" : "Test account"
      },
      "created_time" : "1733745382000",
      "modified_time" : "1733745382000",
      "need_approval" : "yes",
      "status" : {
        "display_value" : "Pending review",
        "code" : "ToBeReviewed"
      }
    } ],
    "total" : 2
  }
}

Status code: 400

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

Status Codes

Status Code	Description
200	OK
400	Common error response

Error Codes

See Error Codes.

Parent topic: IPD Review Management

Previous topic: Creating a change review

Next topic: Querying the List of Reviews Associated with a Work Item by Work Item ID