Help Center/ CodeArts Req/ API Reference/ API/ IPD Review Management/ Deleting a Change Review (BR/GR)
Updated on 2026-10-13 GMT+08:00

Deleting a Change Review (BR/GR)

Function

This API is used to delete 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:delete

Write

-

  • codeartsreq:Model

  • codeartsreq:ProjectId

-

-

URI

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

Request status.

message

String

Returned information.

Status code: 400

Table 3 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

Deleting a BR/GR

DELETE https://{endpoint}/v1/ipdprojectservice/projects/b811b0bef58b479d9b5e4ab856b349ab/process-instances/1156653026593779712

Example Responses

Status code: 200

{
  "status" : "success",
  "message" : "null"
}

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.