Help Center/ CodeArts Req/ API Reference/ API/ IPD Review Management/ Modifying a Change Review (BR/GR)

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

Modifying a Change Review (BR/GR)

Function

This API is used to modify change reviews (CRs), which are 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:update	Write	-	codeartsreq:Model codeartsreq:ProjectId	-	-

URI

PUT /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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
domain_id	No	String	Domain ID of the proposing project.

Request Parameters

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
old_status	No	String	Unique status ID, which indicates the current review status. ToBeReviewed ToBeApproved Committed Canceled ReCommitted Rejected
status	Yes	String	Unique status ID, which indicates the status to which the current review will be transferred. ToBeReviewed ToBeApproved Committed Canceled ReCommitted Rejected
title	No	String	Definition Review title. Constraints: 1 to 256 characters. Range: N/A Default Value: N/A
description	No	String	Description.
plan_start_date	No	Long	Planned start time.
plan_end_date	No	Long	Planned end time.
ccbs	No	Array of ccbs objects	Decision-maker.
opinions	No	Array of opinions objects	Review expert.
cc	No	Array of cc objects	Cc recipient.
cos	No	Array of cos objects	Associated objects.

**Table 4** ccbs
Parameter	Mandatory	Type	Description
user_id	No	String	User ID.

**Table 5** opinions
Parameter	Mandatory	Type	Description
user_id	No	String	User ID.

**Table 6** cc
Parameter	Mandatory	Type	Description
user_id	No	String	User ID.

**Table 7** cos
Parameter	Mandatory	Type	Description
number	No	String	Associated object No.
issue_id	No	String	Associated object ID.
issue_category	No	String	Associated object type.
change_type	No	String	Change type.
before_change	No	String	Data before the change.
after_change	No	String	Data after the change.

Response Parameters

Status code: 200

**Table 8** Response body parameters
Parameter	Type	Description
status	String	Definition Response status. Range success: The response is successful. error: The response failed.
message	String	Response message.
result	result object	Returned result.

**Table 9** result
Parameter	Type	Description
cc	String	Cc recipient list.
approver	String	Decision-maker ID.
description	String	Review description. The list API does not return the description.
closed_time	String	Review completion time.
reviewer	String	Reviewer ID, separated by commas (,).
type	String	Type.
title	String	Review title.
modified_date	String	Timestamp when a review is last modified.
created_by	created_by object	Review creator.
domain_id	String	Tenant ID.
number	String	Review No.
need_approval	Boolean	Whether approval is required.
br2co	String	Baseline review object.
modified_by	modified_by object	Last modifier of a review.
approval_time	String	Review time.
plan_end_date	String	Planned completion time.
id	String	Review ID.
state	String	Review status. The options are In use and Discarded.
created_date	String	Creation time.
category	String	Type.
plan_start_date	String	Planned start time.
review_config	review_config object	Review configuration.
status	status object	Review status.
stage	String	Phase.
opinions	Array of opinions objects	List of change object review expert IDs (used when a change review is created).
opinion_comments	Array of strings	Review comments.
attachments	Array of strings	Attachment.
wikis	Array of strings	Associated wikis.
associatedocuments	Array of strings	Associated documents.
cos	Array of cos objects	Review object list.
approval_phase_result	String	Review result.
ccbs	Array of ccbs objects	Approval information list.

**Table 10** created_by
Parameter	Type	Description
watcher	String	Observer.
user_id	String	User ID.
user_num_id	String	Digital ID of a user.
user_name	String	Username.
domain_id	String	Tenant ID.
domain_name	String	Tenant name.
nick_name	String	User alias.
role_id	String	Role ID.
role_name	String	Role name.
image_id	String	User avatar.
region	String	Region.
opinion	String	Comments.
description	String	Description.
owner	String	Owner
ccbId	String	Review ID.
has_removed	String	Whether the user has been removed from the project.

**Table 11** modified_by
Parameter	Type	Description
watcher	String	Observer.
user_id	String	User ID.
user_num_id	String	Digital ID of a user.
user_name	String	Username.
domain_id	String	Tenant ID.
domain_name	String	Tenant name.
nick_name	String	User alias.
role_id	String	Role ID.
role_name	String	Role name.
image_id	String	User avatar.
region	String	Region.
opinion	String	Comments.
description	String	Description.
owner	String	Owner
ccbId	String	Review ID.
has_removed	String	Whether the user is removed from the project.

**Table 12** review_config
Parameter	Type	Description
approval_type	Integer	Review type.
ratio_value	String	Approval progress.
skip_decisioning	Boolean	Whether to skip decision-making.
approval_roles	String	Decision-making role.
review_roles	String	Approval role.

**Table 13** status
Parameter	Type	Description
code	String	Status code.
name	String	Status.

**Table 14** opinions
Parameter	Type	Description
id	String	id
type	String	Type.
state	String	Status.
status	String	Status
region	String	Region
category	String	Type
title	String	Title.
rounds	String	Scope.
opinion	String	Observer.
description	String	Description.
modified_by	String	Modifier.
modified_date	String	Modification time.
created_by	created_by object	Creator.
created_date	String	Creation time.
tenant_id	String	Tenant ID.
domain_id	String	Project ID.
issue_category	String	Work item type.
issue_id	String	Work item ID.
curr_owner	curr_owner object	Current owner.
co_id	String	Change object ID.
user_id	String	User ID.
opinion_issue_id	String	Review work item ID.
opinion_issue_category	String	Review work item type.

**Table 15** created_by
Parameter	Type	Description
watcher	String	Observer.
user_id	String	User ID.
user_num_id	String	Digital ID of a user.
user_name	String	Username.
domain_id	String	Tenant ID.
domain_name	String	Tenant name.
nick_name	String	Alias.
role_id	String	Role ID.
role_name	String	Role name.
image_id	String	User avatar.
region	String	Region.
opinion	String	Comments.
description	String	Description.
owner	String	Owner.
ccbId	String	Review ID.
has_removed	String	Whether the user is removed from the project.

**Table 16** curr_owner
Parameter	Type	Description
watcher	String	Observer.
user_id	String	User ID.
user_num_id	String	Digital ID of a user.
user_name	String	Username.
domain_id	String	Tenant ID.
domain_name	String	Tenant name.
nick_name	String	Alias.
role_id	String	Role ID.
role_name	String	Role name.
image_id	String	User avatar.
region	String	Region.
opinion	String	Comments.
description	String	Description.
owner	String	Owner.
ccbId	String	Review ID.
has_removed	String	Whether the user is removed from the project.

**Table 17** cos
Parameter	Type	Description
region	String	Region.
category	String	Work item type of the change object. The value is fixed to CO.
title	String	Review title.
status	String	Change object status.
assignee	assignee object	Cc recipient of a review.
description	String	Review description.
number	String	ID of the work item associated with the change object.
order	String	Sorting order.
co2cr	String	Associated change review flag.
co2br	String	Associated baseline review flag.
co2gr	String	Associated general review flag.
id	String	Approval object ID.
type	String	Review type.
state	String	Review status. The options are In use and Discarded.
before_change	String	Work item content before change.
after_change	String	Change object content after modification.
modified_by	String	Last modifier of a review.
modified_date	String	Last modification time of a review.
created_by	String	Review creator.
created_date	String	Review creation time.
tenant_id	String	ID of the tenant to which the work item belongs. Obtain the value from the Querying Tree-shaped Work Items API. The value is tenant_id in the response body.
status_map	String	Work item status.
domain_id	String	Tenant ID.
source_system	String	Source system.
source_system_link	String	Source system link.
issue_category	String	Type of the work item associated with the change object.
issue_id	String	Work item ID.
issue_status	issue_status object	Work item status.
issue_severity	String	Work item severity.
issue_priority	issue_priority object	Work item priority.
domain_title	String	Project name.
src_domain_title	String	Proposing project name.
issue_assignee_name	String	Owner alias.
change_reason	String	Review reason.
change_type	String	Review type.
source_system_id	String	Source system ID.
change_description	String	Review description.
has_deleted	String	Deleted or not.
approval_phase_result	String	Review result.
approval_complete_time	String	Review completion time.
ccb_description	String	Review description.
actual_ccb	String	Review expert.
ccbs	String	Approval information list.
ccb_info	String	Review information.
opinions	String	List of change object review expert IDs (used when a change review is created).
opinion_comments	String	Review comments.
approval_time	String	Approval time.
src_domain_id	String	Tenant ID.
cross_domain	String	Cross-tenant or not.
domain_moved	String	Whether the project is migrated.
reviewer	Array of strings	Review expert.
approver	Array of strings	Decision-maker.
rounds	String	Rounds of reviews.
last_round_result	String	Result of the latest round of decision-making.

**Table 18** assignee
Parameter	Type	Description
watcher	String	Observer.
user_id	String	User ID.
user_num_id	String	Digital ID of a user.
user_name	String	Username.
domain_id	String	Tenant ID.
domain_name	String	Tenant name.
nick_name	String	User alias.
role_id	String	Role ID.
role_name	String	Role name.
image_id	String	User avatar.
region	String	Region.
opinion	String	Review information.
description	String	Description.
owner	String	Current handler.
ccbId	String	Review object ID.
has_removed	String	Whether the user has been removed from the project.

**Table 19** issue_status
Parameter	Type	Description
id	String	Status ID.
belonging	String	Definition Work item status. Range START, IN_PROGRESS, and END
space_id	String	Space ID.
name	String	Status name.
code	String	Status code.
definition_type	String	Definition type.
belong_definition_type	Integer	Field definition type.
display_value	String	Display value.
position	Integer	Sorting position.
displayable	Integer	Displayable or not.
editable	Integer	Editable or not.
deletable	Integer	Deletable or not.
mutable	Integer	Changeable or not.
title_py	String	Status name abbreviation.
created_by	String	Status creator.
created_date	String	Status creation time.
modified_date	String	Latest modification time of a status.
modified_by	String	Last modifier of a status.
linkage_node_fields	Boolean	Whether to link the node field.

**Table 20** issue_priority
Parameter	Type	Description
id	String	id
display_value	String	Display name.
value	String	Value.
code	String	Code.
value_py	String	Value (initial letters)
sequence	Integer	Sequence.
level	Integer	Level.
domain_id	String	Project ID.
belong_definition_type	String	Definition severity.

**Table 21** ccbs
Parameter	Type	Description
watcher	String	Observer.
user_id	String	User ID.
user_num_id	String	Digital ID of a user.
user_name	String	Username.
domain_id	String	Tenant ID.
domain_name	String	Tenant name.
nick_name	String	User alias.
role_id	String	Role ID.
role_name	String	Role name.
image_id	String	User avatar ID.
region	String	Region.
opinion	String	Review information.
description	String	Description.
owner	String	Current handler.
ccbId	String	Review object ID.
has_removed	String	The user has been removed from the project.

Status code: 400

**Table 22** 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

Modifying a BR/GR

PUT https://{endpoint}/v1/ipdprojectservice/projects/{project_id}/process-instances/{id}

{
  "old_status" : "Committed",
  "status" : "Committed",
  "title" : "test21222-updat11e"
}

Example Responses

Status code: 200

{
  "status" : "success",
  "result" : {
    "id" : "1073568012549795840",
    "number" : "CR20241211782294",
    "state" : "In use",
    "title" : "21-CR-10x",
    "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" : "1733888160000",
    "modified_time" : "1733888160000",
    "plan_end_date" : "1735574400000",
    "plan_start_date" : "1733673600000",
    "need_approval" : "true",
    "status" : {
      "display_value" : "To be reviewed",
      "code" : "ToBeReviewed"
    },
    "description" : "<p><strong>[Background]</strong></p><p>1</p><p><strong>[Benefits]</strong></p><p><br></p><p><strong>[Details]</strong></p>",
    "cos" : [ {
      "after_change" : "{\"view\":{\"description\":\"<p>[Fault Symptom]</p><p>x</p><p>[Environment Information]</p><p><br></p><p>[Onsite Fault Locating R&D Engineer]</p><p><br></p><p>[Preliminary Fault Locating]</p>\"},\"execute\":{\"description\":\"<p>[Fault Symptom]</p><p>x</p><p>[Environment Information]</p><p><br></p><p>[Onsite Fault Locating R&D Engineer]</p><p><br></p><p>[Preliminary Fault Locating]</p>\"},\"snapshot\":{\"found_iteration\":null,\"type\":\"bug\",\"test_failures_times\":\"0\",\"number\":\"BUG20241209780441\",\"convolution_actual_hours\":null,\"path\":\"/1072968362439385089\",\"workload_man_day\":null,\"id\":\"1072968362439385089\",\"state\":\"In use\",\"sys_no_repair_reason\":null,\"module\":null,\"priority\":null,\"found_env\":null,\"sys_activation_reason\":null,\"assignee\":{\"watcher\":0,\"user_id\":\"a360371833bf4c558f796fd707b44daf\",\"user_num_id\":4091,\"user_name\":\"devcloud_devcloud_01\",\"domain_id\":\"4e919d73499648e3b0292cd3cbef806a\",\"domain_name\":\"devcloud_devcloud_01\",\"nick_name\":\"Test Account\",\"role_id\":\"257bbf34272649dd909bb35dfe27d126,05d9444b66cc4d5090ef3180a3096c91\",\"role_name\":\"Project Manager,Project Administrator\",\"role_alias_name\":\"Project manager,Project admin\",\"role_code\":\"Project manager,project_admin\",\"image_id\":\"\",\"region\":\"\",\"has_removed\":\"\"},\"close_type\":null,\"status\":{\"id\":\"1072203303913304105\",\"belonging\":\"START\",\"space_id\":\"1072203303493873664\",\"name\":\"Analysis\",\"status_category\":\"\",\"code\":\"Analyse\",\"definition_type\":\"5\",\"belong_definition_type\":3,\"belong_scope\":\"\",\"display_value\":\"Analysis\",\"position\":2,\"displayable\":1,\"editable\":1,\"deletable\":1,\"mutable\":1,\"title_py\":\"fx\",\"builtin\":false,\"label\":\"\",\"description\":\"\",\"created_by\":\"a360371833bf4c558f796fd707b44daf\",\"created_userinfo\":null,\"created_on\":\"\",\"created_date\":1733591588000,\"modified_date\":1733591588000,\"modified_by\":\"a360371833bf4c558f796fd707b44daf\",\"category_code\":[],\"editing_fields\":[],\"associate\":null,\"linkage_node_fields\":false},\"tenant_id\":\"4e919d73499648e3b0292cd3cbef806a\",\"plan_pi\":null,\"repair_solution\":null,\"plan_end_date\":null,\"expected_repair_date\":null,\"plan_iteration\":null,\"cascade_delete\":\"none\",\"issue_opinion_id\":null,\"modified_by\":{\"watcher\":0,\"user_id\":\"a360371833bf4c558f796fd707b44daf\",\"user_num_id\":4091,\"user_name\":\"devcloud_devcloud_01\",\"domain_id\":\"4e919d73499648e3b0292cd3cbef806a\",\"domain_name\":\"devcloud_devcloud_01\",\"nick_name\":\"Test Account\",\"role_id\":\"257bbf34272649dd909bb35dfe27d126,05d9444b66cc4d5090ef3180a3096c91\",\"role_name\":\"Project Manager,Project Administrator\",\"role_alias_name\":\"Project manager,Project admin\",\"role_code\":\"Project manager,project_admin\",\"image_id\":\"\",\"region\":\"\",\"has_removed\":\"\"},\"position_float\":\"10000000000.0000000000\",\"belong_inside\":\"1\",\"regression_failure_number\":\"0\",\"src_domain\":{\"id\":\"1072203303493873664\",\"name\":\"beta-m2-wyl-021\",\"title\":\"beta-m2-wyl-021\",\"project_id\":\"b248a70bc6434e6bad54c8e73a222dca\",\"parent_id\":\"\",\"category\":\"Project\",\"created_by\":\"a360371833bf4c558f796fd707b44daf\",\"model_id\":\"10002\",\"children\":[]},\"domain_id\":{\"id\":\"1072203303493873664\",\"name\":\"beta-m2-wyl-021\",\"title\":\"beta-m2-wyl-021\",\"project_id\":\"b248a70bc6434e6bad54c8e73a222dca\",\"parent_id\":\"\",\"category\":\"Project\",\"created_by\":\"a360371833bf4c558f796fd707b44daf\",\"model_id\":\"10002\",\"children\":[]},\"send_from\":\"\",\"send_to\":\"\",\"stay_days\":2,\"test_report\":null,\"assigned_cc\":null,\"return_reason\":null,\"submit_time\":1733745191791,\"workitem2label\":null,\"close_time\":null,\"modified_date\":1733887226000,\"created_by\":{\"watcher\":0,\"user_id\":\"a360371833bf4c558f796fd707b44daf\",\"user_num_id\":4091,\"user_name\":\"devcloud_devcloud_01\",\"domain_id\":\"4e919d73499648e3b0292cd3cbef806a\",\"domain_name\":\"devcloud_devcloud_01\",\"nick_name\":\"Test Account\",\"role_id\":\"257bbf34272649dd909bb35dfe27d126,05d9444b66cc4d5090ef3180a3096c91\",\"role_name\":\"Project Manager,Project Administrator\",\"role_alias_name\":\"Project manager,Project admin\",\"role_code\":\"Project manager,project_admin\",\"image_id\":\"\",\"region\":\"\",\"has_removed\":\"\"},\"activate_times\":\"0\",\"status_modified_date\":1733745192515,\"parent_id\":null,\"business_domain\":null,\"found_pi\":null,\"region\":\"example\",\"reason_analysis\":null,\"link\":\"\",\"is_suspended\":null,\"origin_id\":\"1072968362439385089\",\"change_status\":{\"id\":\"1072203303896526856\",\"display_value\":\"unchange\",\"value\":\"unchange\",\"code\":\"unchange\",\"value_py\":\"unchange\",\"sequence\":1.0,\"level\":1,\"domain_id\":\"1072203303493873664\",\"belong_definition_type\":\"5\"},\"title\":\"21-Bug-01\",\"sum_workload_man_day\":null,\"plan_start_date\":null,\"severity\":{\"id\":\"1072203303896526851\",\"display_value\":\"Information\",\"value\":\"Information\",\"code\":\"Information\",\"value_py\":\"ts\",\"sequence\":1.0,\"level\":1,\"domain_id\":\"1072203303493873664\",\"belong_definition_type\":\"5\"},\"convolution_plan_hours\":null,\"submitted_by\":[{\"watcher\":0,\"user_id\":\"a360371833bf4c558f796fd707b44daf\",\"user_num_id\":4091,\"user_name\":\"devcloud_devcloud_01\",\"domain_id\":\"4e919d73499648e3b0292cd3cbef806a\",\"domain_name\":\"devcloud_devcloud_01\",\"nick_name\":\"Test Account\",\"role_id\":\"257bbf34272649dd909bb35dfe27d126,05d9444b66cc4d5090ef3180a3096c91\",\"role_name\":\"Project Manager,Project Administrator\",\"role_alias_name\":\"Project manager,Project admin\",\"role_code\":\"Project manager,project_admin\",\"image_id\":\"\",\"region\":\"\",\"has_removed\":\"\"}],\"sys_return_reason\":null,\"issue_review_id\":null,\"created_date\":1733745192388,\"category\":\"Bug\",\"setup\":true,\"collaborative_status\":[],\"parent_status\":\"no\"}}",
      "before_change" : "{\"view\":{\"description\":\"<p>[Fault Symptom]</p><p><br></p><p>[Environment Information]</p><p><br></p><p>[Onsite Fault Locating R&D Engineer]</p><p><br></p><p>[Preliminary Fault Locating]</p>\"}}",
      "category" : "CO",
      "ccbs" : [ {
        "id" : "a360371833bf4c558f796fd707b44daf",
        "name" : "devcloud_devcloud_01",
        "nick_name" : "Test account."
      } ],
      "change_type" : "Modify",
      "co2review" : "1073568012549795840",
      "created_by" : "a360371833bf4c558f796fd707b44daf",
      "created_date" : "1733888157000",
      "description" : "<p>[Fault Symptom]</p><p>x</p><p>[Environment Information]</p><p><br></p><p>[Onsite Fault Locating R&D Engineer]</p><p><br></p><p>[Preliminary Fault Locating]</p>",
      "id" : "1073568002185670656",
      "issue_id" : "1072968362439385089",
      "issue_number" : "BUG20241209780441",
      "issue_category" : "Bug",
      "modified_by" : "a360371833bf4c558f796fd707b44daf",
      "modified_date" : "1733888157000",
      "opinions" : [ { } ],
      "approver" : [ "a360371833bf4c558f796fd707b44daf" ],
      "reviewer" : [ "a360371833bf4c558f796fd707b44daf" ],
      "status" : "ToBeReviewed"
    } ],
    "cc" : [ {
      "id" : "a360371833bf4c558f796fd707b44daf",
      "name" : "devcloud_devcloud_01",
      "nick_name" : "Test account."
    } ]
  }
}

Status code: 400

{
  "error_code" : "PM.02174103",
  "error_msg" : "Insufficient permissions."
}

Status Codes

Status Code	Description
200	OK
400	Common error response.

Error Codes

See Error Codes.

Parent topic: IPD Review Management

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

Next topic: Querying the Review List (BRs/GRs)