Get Change by display ID

GET

https://{tenant}.atomicwork.com/api/v1/change-management/changes/:display_id

GET

/api/v1/change-management/changes/:display_id

$ curl https://{tenant}.atomicwork.com/api/v1/change-management/changes/display_id \
>      -H "X-Workspace-Id: {{workspace_id}}" \
>      -H "X-Api-Key: <apiKey>" \
>      -H "Content-Type: application/json"

200Retrieved

1 {
2   "id": "CHG-20240612-001",
3   "title": "Upgrade Database Server to v12.3",
4   "description": "Planned upgrade of the primary database server to version 12.3 to improve performance and security.",
5   "status": "APPROVED",
6   "requestedBy": "jane.doe@example.com",
7   "assignedTo": "john.smith@example.com",
8   "createdAt": "2024-06-10T09:15:00Z",
9   "scheduledStart": "2024-06-15T22:00:00Z",
10   "scheduledEnd": "2024-06-16T02:00:00Z",
11   "priority": "High",
12   "changeType": "Standard",
13   "impact": "Medium",
14   "risk": "Low",
15   "approvalState": "Approved"
16 }

Authentication

X-Api-Keystring

API Key authentication via header

Path parameters

display_idstringRequired

Display ID of the change

Response

Successful response

Authentication

Path parameters

Headers

Response