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

Deleting a Change Review

Function

This API is used to delete a change review.

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:delete

Write

-

  • codeartsreq:Model

  • codeartsreq:ProjectId

-

-

URI

DELETE /v1/ipdprojectservice/projects/{project_id}/review/{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

category

Yes

String

Definition

Review type.

Constraints

N/A

Range

  • BR: baseline review

  • CR: change review

  • GR: general review

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

id

String

Definition

ID of the changed work item.

Range

N/A

operator

String

Definition

ID of the work item changer.

Range

N/A

state

String

Definition

Discard flag of a work item. The options are as follows.

Range

  • In use: work items that can be operated properly

  • Discarded: soft-deleted work items that can be restored from the recycle bin

  • Deleted: permanently deleted work items that cannot be restored

operate_time

String

Definition

Work item change time.

Range

N/A

Status code: 400

Table 4 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 change review

DELETE https://{endpoint}/v1/ipdprojectservice/projects/b54914d464d1498a97d683ef198ec448/review/1029697355810648065?category=CR

Example Responses

Status code: 200

{
  "id" : "1073382258376749056",
  "operator" : "a360371833bf4c558f796fd707b44daf",
  "operate_time" : "1733887244396"
}

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.