Skip to main content

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 stringrequired
    id stringrequired

Responses​

changeRequestStateSchema

Schema

    oneOf

    state stringrequired

    The new desired state for the change request

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

    comment string

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

    Example: This is a comment for my change request
Loading...