v1

latestOpenAPI 3.1.02026-07-261344388.3 KB

Change requests

Get a change request

Retrieve a single change request by ID, including activities, snapshot, and related entities.

get/api/projects/{projectId}/change-requests/{changeRequestId}

Path parameters

projectIdstring uuid required

Project unique identifier

changeRequestIdstring uuid required

Change request unique identifier

Response

Change request with full details

idstring uuid required

Change request unique identifier

type'publish_document' | 'unpublish_document' | 'deploy_environment' | 'undeploy_environment' | 'merge_branch' required

Type of change request

status'pending' | 'rejected' | 'cancelled' | 'completed' required

Current status of the change request

descriptionstring nullable

Change request description

projectIdstring uuid required

Project unique identifier

documentIdstring uuid nullable

Document unique identifier

environmentIdstring uuid nullable

Environment unique identifier

releaseIdstring uuid nullable

Release unique identifier

branchIdstring uuid nullable

Branch unique identifier

createdAtstring required

Change request creation timestamp

updatedAtstring required

Change request last update timestamp

{"stackTrail":"paths:/api/projects/{projectId}/change-requests/{changeRequestId}:get:responses:200:content:application/json:schema:properties:documentVersion","oasType":"schema","type":"unknown","description":"Document version being published","nullable":true}

{"stackTrail":"paths:/api/projects/{projectId}/change-requests/{changeRequestId}:get:responses:200:content:application/json:schema:properties:previousDocumentVersion","oasType":"schema","type":"unknown","description":"Previous document version","nullable":true}

previousReleaseIdstring uuid nullable

Previous release unique identifier