v1

latestOpenAPI 3.1.02026-07-261344388.3 KB

Change requests

Update activity

Update an existing activity on a change request. Allows modifying the comment or resolving the activity.

put/api/projects/{projectId}/change-requests/{changeRequestId}/activities/{activityId}

Path parameters

projectIdstring uuid required

Project unique identifier

changeRequestIdstring uuid required

Change request unique identifier

activityIdstring uuid required

Activity unique identifier

Request body

commentstring nullable

Updated comment for the activity

resolveboolean nullable

Whether to mark the activity as resolved

Response

Updated change request with the modified activity

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}/activities/{activityId}:put: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}/activities/{activityId}:put: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