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

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

Querying Review Details (BRs/GRs)

Function

This API is used to query review form details, which is applicable to baseline reviews (BRs) and general reviews (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:get	Read	-	codeartsreq:Model codeartsreq:ProjectId	-	-

URI

GET /v1/ipdprojectservice/projects/{project_id}/process-instances/{review_id}

**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
review_id	Yes	String	Definition Review ID, which uniquely identifies a review. Obtain the value by calling the API for querying the review list (BR/GR). The value of id in the response body is the review ID. Constraints N/A Range A string of 18 to 19 digits. Default Value N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
status	String	Definition Response status. Range success: The response is successful. error: The response fails.
message	String	Definition Response message. Range N/A
result	ReviewEntity object	Review details

**Table 3** ReviewEntity
Parameter	Type	Description
id	String	Definition Review ID. Range N/A
number	String	Definition Review No. Range N/A
state	String	Definition Lifecycle of a review. Range In use: work items that can be operated properly Discarded: soft-deleted work items that can be restored from the recycle bin
title	String	Definition Review title. Range N/A
category	String	Definition Review type. Range CR (change review), BR (baseline review), and GR (general review).
created_by	UserEntity object	Definition Review creator.
modified_by	UserEntity object	Definition Last modifier of a review.
assigned_cc	Array of UserEntity objects	Definition Cc recipient of a review.
created_time	String	Definition Creation timestamp of a review. Range N/A
modified_time	String	Definition Timestamp when a review was last modified. Range N/A
plan_end_date	String	Definition Timestamp of the planned completion date. Range N/A
plan_start_date	String	Definition Timestamp of the planned start date. Range N/A
close_time	String	Definition Review completion time. Range N/A
need_approval	String	Definition Whether the review needs to be approved by the decision-maker. Range true and false
status	StatusEntity object	Definition Review status.
description	String	Definition Review description. Range N/A
closed_time	String	Definition Review completion time. Range N/A
approver	String	Definition Decision-maker ID. Range N/A
reviewer	String	Definition ID of a review expert. Range N/A
cos	Array of COEntity objects	Definition Review object list.
ccbs	Array of CcbEntity objects	Definition Approval information lists.
old_status	StatusEntity object	Definition Historical review status.
cc	Array of UserEntity objects	Definition List of CC recipients.

**Table 4** 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 5** 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 6** 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 7** 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

**Table 8** 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 9** 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.

Status code: 400

**Table 10** 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 review details

GET https://{endpoint}/v1/ipdprojectservice/projects/ac069b11a3524163ad6348953e2fe93e/process-instances/1161002910334492672

Example Responses

Status code: 200

{
  "status" : "success",
  "message" : null,
  "result" : {
    "description" : "<p><strong>[Background]</strong></p><p><br></p><p><strong>[Benefits]</strong></p><p><br></p><p><strong>[Details]</strong></p><br>",
    "type" : "process_instance",
    "title" : "Local Test To-Dos",
    "multi_parent_id" : "",
    "handing_cos" : "1161002905490071553",
    "review_type" : null,
    "domain_id" : "1160948493073686528",
    "number" : "CR20250809729340",
    "review_times" : "1",
    "need_approval" : true,
    "plan_end_date" : null,
    "id" : "1161002910334492672",
    "state" : "In use",
    "plan_start_date" : null,
    "review_config" : {
      "approval_type" : 0,
      "ratio_value" : null,
      "skip_decisioning" : false,
      "approval_roles" : "241ea3ccd25a441a91d948e62dc1302c,c0619788f1f5421b81c30083a0b3a26a",
      "review_roles" : "bbc80e4c2f5c4a3bb3f73faac744a883,107b73ca7834402ba15903bf182e6445,abeaf42190af4c338c3948d96fe3d871,0a353d02a6f1479c903bd8871762fea1,ef5c37da34164cc0bf38920f5b87b6c8,241ea3ccd25a441a91d948e62dc1302c,c0619788f1f5421b81c30083a0b3a26a,f40bc5b8e36249798072576276ee6dd5,ae187d881b574167bc1eaacae70aaf77,5604e92f78aa4946955ada93cc0df4d5,5c428ed6459b4111bcae2de8ea5f4336"
    },
    "cc" : null,
    "approver" : null,
    "sub_id" : "",
    "cr2co" : "1161002905490071553",
    "closed_time" : "1754734770727",
    "reviewer" : null,
    "modified_date" : "1754734770763",
    "created_by" : {
      "watcher" : null,
      "user_id" : "a360371833bf4c558f796fd707b44daf",
      "user_num_id" : null,
      "user_name" : "devcloud_devcloud_01",
      "domain_id" : "4e919d73499648e3b0292cd3cbef806a",
      "domain_name" : null,
      "nick_name" : "Sam 1",
      "role_id" : "241ea3ccd25a441a91d948e62dc1302c,c0619788f1f5421b81c30083a0b3a26a",
      "role_name" : "Project admin,Project manager",
      "image_id" : null,
      "region" : null,
      "opinion" : null,
      "description" : null,
      "owner" : null,
      "ccbId" : null,
      "has_removed" : null
    },
    "modified_by" : {
      "watcher" : null,
      "user_id" : "system",
      "user_num_id" : null,
      "user_name" : "System",
      "domain_id" : null,
      "domain_name" : null,
      "nick_name" : null,
      "role_id" : null,
      "role_name" : null,
      "image_id" : null,
      "region" : null,
      "opinion" : null,
      "description" : null,
      "owner" : null,
      "ccbId" : "system",
      "has_removed" : null
    },
    "created_date" : "1754734264212",
    "category" : "CR",
    "status" : {
      "code" : "End",
      "name" : "Completed"
    },
    "stage" : "finish_phase",
    "approval_time" : "1754734770000",
    "ccb_user" : [ {
      "watcher" : null,
      "user_id" : "09d25f5d3f80d2881fd7c008ecf1622b",
      "user_num_id" : null,
      "user_name" : "child01",
      "domain_id" : null,
      "domain_name" : null,
      "nick_name" : "child01update1",
      "role_id" : null,
      "role_name" : null,
      "image_id" : null,
      "region" : null,
      "opinion" : null,
      "description" : null,
      "owner" : null,
      "ccbId" : null,
      "has_removed" : "removed"
    } ],
    "ccb_description" : "1",
    "ccb_opinion" : "Approved",
    "ccb_id" : "1161005033818333184",
    "opinion_issue_id" : null,
    "opinion_issue_category" : null,
    "ccbs" : [ ],
    "opinions" : [ ],
    "opinion_comments" : [ ],
    "attachments" : [ ],
    "wikis" : [ ],
    "associatedocuments" : [ ],
    "cos" : [ {
      "region" : "example",
      "category" : "CO",
      "title" : "111",
      "status" : "Start",
      "assignee" : {
        "watcher" : null,
        "user_id" : "a360371833bf4c558f796fd707b44daf",
        "user_num_id" : null,
        "user_name" : "devcloud_devcloud_01",
        "domain_id" : "4e919d73499648e3b0292cd3cbef806a",
        "domain_name" : null,
        "nick_name" : "Sam 1",
        "role_id" : "241ea3ccd25a441a91d948e62dc1302c,c0619788f1f5421b81c30083a0b3a26a",
        "role_name" : "Project admin,Project manager",
        "image_id" : null,
        "region" : null,
        "opinion" : null,
        "description" : null,
        "owner" : null,
        "ccbId" : null,
        "has_removed" : null
      },
      "description" : "<p>[Background]</p><p><br></p>[Value]</p> <p><br></p><p>[Details]</p>",
      "number" : "IR20250809726533",
      "order" : null,
      "co2cr" : "1161002910334492672",
      "co2br" : "",
      "co2gr" : "",
      "id" : "1161002905490071553",
      "type" : "associate_issue",
      "state" : "In use",
      "before_change" : "{\"view\":{\"title\":\"111\"}}",
      "after_change" : "{\"view\":{\"title\":\"111222\"},\"execute\":{\"title\":\"111222\"},\"snapshot\":{\"develop_owner\":null,\"type\":\"requirement\",\"plan_test_end_date\":null,\"number\":\"IR20250809726533\",\"convolution_actual_hours\":null,\"path\":\"/1160948836415217664\",\"workload_man_day\":null,\"children\":null,\"id\":\"1160948836415217664\",\"state\":null,\"need_break\":{\"id\":\"1160948493527855172\",\"display_value\":\"Yes\",\"value\":\"yes\",\"code\":\"yes\",\"value_py\":\"yes\",\"sequence\":1.0,\"level\":1,\"domain_id\":\"1160948493073686528\",\"belong_definition_type\":\"5\"},\"collaborative_history\":null,\"baseline\":{\"id\":\"1160948493527855122\",\"display_value\":\"baselined\",\"value\":\"baselined\",\"code\":\"baselined\",\"value_py\":\"baselined\",\"sequence\":2.0,\"level\":1,\"domain_id\":\"1160948493073686528\",\"belong_definition_type\":\"5\"},\"priority\":{\"id\":\"1160948493527855125\",\"display_value\":\"medium\",\"value\":\"medium\",\"code\":\"medium\",\"value_py\":\"2\",\"sequence\":2.0,\"level\":1,\"domain_id\":\"1160948493073686528\",\"belong_definition_type\":\"5\"},\"break_status\":{\"id\":\"1160948493527855130\",\"display_value\":\"Not broken down\",\"value\":\"undecomposed\",\"code\":\"undecomposed\",\"value_py\":\"undecomposed\",\"sequence\":2.0,\"level\":1,\"domain_id\":\"1160948493073686528\",\"belong_definition_type\":\"5\"},\"assignee\":{\"watcher\":null,\"user_id\":\"a360371833bf4c558f796fd707b44daf\",\"user_num_id\":null,\"user_name\":\"devcloud_devcloud_01\",\"domain_id\":\"4e919d73499648e3b0292cd3cbef806a\",\"domain_name\":null,\"nick_name\":\"Sam 1\",\"role_id\":\"241ea3ccd25a441a91d948e62dc1302c,c0619788f1f5421b81c30083a0b3a26a\",\"role_name\":\"Project admin,Project manager\",\"image_id\":null,\"region\":null,\"opinion\":null,\"description\":null,\"owner\":null,\"ccbId\":null,\"has_removed\":null},\"status\":{\"id\":\"1160948493544632339\",\"belonging\":\"START\",\"space_id\":\"1160948493073686528\",\"name\":\"Initial\",\"code\":\"Start\",\"definition_type\":\"5\",\"belong_definition_type\":3,\"display_value\":\"Initial\",\"position\":1,\"displayable\":1,\"editable\":1,\"deletable\":1,\"mutable\":1,\"title_py\":\"cs\",\"created_by\":\"a360371833bf4c558f796fd707b44daf\",\"created_date\":\"1754721290241\",\"modified_date\":\"1754721290241\",\"modified_by\":\"a360371833bf4c558f796fd707b44daf\",\"linkage_node_fields\":false},\"tenant_id\":\"4e919d73499648e3b0292cd3cbef806a\",\"plan_pi\":null,\"plan_dev_end_date\":null,\"plan_end_date\":null,\"cascade_delete\":\"none\",\"issue_opinion_id\":null,\"modified_by\":{\"user_id\":\"d309f40ed61845f8acec5a2cadd53855\",\"user_name\":\"g00833904\",\"domain_id\":\"4e919d73499648e3b0292cd3cbef806a\",\"nick_name\":\"g00833904-1\",\"role_id\":\"5c428ed6459b4111bcae2de8ea5f4336\",\"role_name\":\"Viewer\",\"role_alias_name\":\"Viewer\",\"role_code\":\"Viewer\"},\"closed_flag\":null,\"collaborative_status\":[],\"position_float\":\"10000000000.0000000000\",\"domain_id\":{\"id\":\"1160948493073686528\",\"name\":\"IPD-System Device_Review Pending Optimization\",\"title\":\"IPD-System Device_Review Pending Optimization\",\"project_id\":\"ac069b11a3524163ad6348953e2fe93e\",\"parent_id\":\"\",\"category\":\"Project\",\"created_by\":\"a360371833bf4c558f796fd707b44daf\",\"model_id\":\"10001\",\"children\":[]},\"upstream_change_flag\":null,\"stay_days\":0,\"ir2feature\":\"\",\"related_network_security\":{\"id\":\"1160948493527855110\",\"display_value\":\"No\",\"value\":\"no\",\"code\":\"no\",\"value_py\":\"no\",\"sequence\":2.0,\"level\":1,\"domain_id\":\"1160948493073686528\",\"belong_definition_type\":\"5\"},\"assigned_cc\":null,\"workitem2label\":null,\"close_time\":null,\"modified_date\":1754733590564,\"created_by\":{\"user_id\":\"a360371833bf4c558f796fd707b44daf\",\"user_name\":\"devcloud_devcloud_01\",\"domain_id\":\"4e919d73499648e3b0292cd3cbef806a\",\"nick_name\":\"Sam 1\",\"role_id\":\"241ea3ccd25a441a91d948e62dc1302c,c0619788f1f5421b81c30083a0b3a26a\",\"role_name\":\"Project admin,Project manager\",\"role_alias_name\":\"Project manager,Project admin\",\"role_code\":\"Project manager,project_admin\"},\"status_modified_date\":1754721372084,\"important\":null,\"collaboratives\":null,\"parent_id\":null,\"business_domain\":{\"id\":\"1160948493527855144\",\"display_value\":\"Software\",\"value\":\"software\",\"code\":\"software\",\"value_py\":\"rj\",\"sequence\":0.0,\"level\":1,\"domain_id\":\"1160948493073686528\",\"belong_definition_type\":\"5\"},\"region\":\"example\",\"link\":\"\",\"is_suspended\":null,\"change_status\":{\"id\":\"1160948493527855115\",\"display_value\":\"changed\",\"value\":\"changed\",\"code\":\"changed\",\"value_py\":\"changed\",\"sequence\":3.0,\"level\":1,\"domain_id\":\"1160948493073686528\",\"belong_definition_type\":\"5\"},\"title\":\"111222\",\"sum_workload_man_day\":null,\"ir2rr\":\"\",\"plan_start_date\":null,\"convolution_plan_hours\":null,\"no_break_reason\":null,\"submitted_by\":[{\"user_id\":\"a360371833bf4c558f796fd707b44daf\",\"user_name\":\"devcloud_devcloud_01\",\"domain_id\":\"4e919d73499648e3b0292cd3cbef806a\",\"nick_name\":\"Sam 1\",\"role_id\":\"241ea3ccd25a441a91d948e62dc1302c,c0619788f1f5421b81c30083a0b3a26a\",\"role_name\":\"Project admin,Project manager\",\"role_alias_name\":\"Project manager,Project admin\",\"role_code\":\"Project manager,project_admin\"}],\"test_owner\":null,\"issue_review_id\":null,\"created_date\":1754721371983,\"category\":\"IR\",\"setup\":true,\"inherit_button\":\"hide\",\"parent_status\":\"no\"}}",
      "modified_by" : "a360371833bf4c558f796fd707b44daf",
      "modified_date" : "1754915897118",
      "created_by" : "a360371833bf4c558f796fd707b44daf",
      "created_date" : "1754734263058",
      "tenant_id" : "4e919d73499648e3b0292cd3cbef806a",
      "status_map" : null,
      "domain_id" : "1160948493073686528",
      "source_system" : null,
      "source_system_link" : null,
      "issue_category" : "IR",
      "issue_id" : "1160948836415217664",
      "issue_status" : {
        "id" : "1160948493544632339",
        "belonging" : "START",
        "space_id" : "1160948493073686528",
        "name" : "Initial",
        "code" : "Start",
        "definition_type" : "5",
        "belong_definition_type" : 3,
        "display_value" : "Initial",
        "position" : 1,
        "displayable" : 1,
        "editable" : 1,
        "deletable" : 1,
        "mutable" : 1,
        "title_py" : "cs",
        "created_by" : "a360371833bf4c558f796fd707b44daf",
        "created_date" : "1754721290241",
        "modified_date" : "1754721290241",
        "modified_by" : "a360371833bf4c558f796fd707b44daf",
        "linkage_node_fields" : false
      },
      "issue_severity" : null,
      "issue_priority" : {
        "id" : "1160948493527855125",
        "display_value" : "Medium",
        "value" : "Medium",
        "code" : "Medium",
        "value_py" : "2",
        "sequence" : 2,
        "level" : 1,
        "domain_id" : "1160948493073686528",
        "belong_definition_type" : "5"
      },
      "domain_title" : "IPD-System Device_Review Pending Optimization",
      "src_domain_title" : null,
      "issue_assignee_name" : "Sam 1",
      "change_reason" : null,
      "change_type" : "Modify",
      "source_system_id" : null,
      "change_description" : null,
      "has_deleted" : null,
      "approval_phase_result" : "Approved",
      "approval_complete_time" : "1754734539092",
      "ccb_description" : null,
      "actual_ccb" : null,
      "ccbs" : null,
      "ccb_info" : null,
      "opinions" : null,
      "opinion_comments" : null,
      "approval_time" : null,
      "src_domain_id" : null,
      "cross_domain" : null,
      "domain_moved" : null,
      "reviewer" : [ "84603a65a4ce4ef2b5eccbc3b7caf1e7", "d309f40ed61845f8acec5a2cadd53855", "a360371833bf4c558f796fd707b44daf" ],
      "approver" : [ "a360371833bf4c558f796fd707b44daf" ],
      "rounds" : "1",
      "last_round_result" : "Approved"
    } ],
    "approval_phase_result" : 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: Creating a BR/GR

Next topic: Deleting a Change Review (BR/GR)