This endpoint will update the state of a change request

PUT /api/admin/projects/:projectId/change-requests/:id/state

This endpoint will update the state of a change request if the business rules allow it. The state can be one of the following: Draft, In review, Approved, Cancelled, Applied. In order to be approved, the change request must have at least one change and the number of approvals must be greater than or equal to the number of approvals required for the environment.

                Once a change request has been approved, it can be applied. Once a change request has been applied, it cannot be changed. Once a change request has been cancelled, it cannot be changed. Any change to a change request in the state of Approved will result in the state being set to In Review and the number of approvals will be reset.

Request

Path Parameters

• projectId string required
• id string required

Responses

• 200

---

changeRequestStateSchema

application/json

Schema

Schema

oneOf

MOD1

state string required

Possible values: [Draft, In review, Approved, Applied, Cancelled, Rejected]

The new desired state for the change request

comment string

Any comments accompanying the state changed. Used when sending a draft to review.

MOD2

state string required

Possible values: [Scheduled]

The new desired state for the change request

scheduledAt date-time required

The time at which the change request should be applied.

comment string

Any comments accompanying the state changed. Used when sending a draft to review.

Loading...