Get notes for change by display ID

GET

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

GET

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

$ curl -G https://{tenant}.atomicwork.com/api/v1/change-management/changes/display_id/notes \
>      -H "X-Workspace-Id: 987654321" \
>      -H "X-Api-Key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d page=1 \
>      --data-urlencode "search_key=database migration" \
>      -d per_page=25 \
>      -d next_page_token=eyJwYWdlIjoxLCJ0b2tlbiI6IjEyMzQ1NiJ9

200Retrieved

1 {
2   "notes": [
3     {
4       "id": "note-001",
5       "author": "jane.doe@example.com",
6       "created_at": "2024-06-14T09:15:00Z",
7       "content": "Initial assessment completed. Database backup scheduled for 2024-06-16."
8     },
9     {
10       "id": "note-002",
11       "author": "john.smith@example.com",
12       "created_at": "2024-06-15T11:30:00Z",
13       "content": "Backup successful. Ready to proceed with migration."
14     }
15   ],
16   "page": 1,
17   "per_page": 25,
18   "next_page_token": "eyJwYWdlIjoxLCJ0b2tlbiI6IjEyMzQ1NyJ9",
19   "total_notes": 42
20 }

Authentication

X-Api-Keystring

API Key authentication via header

Path parameters

display_idstringRequired

Display ID of the change

Query parameters

search_keystringOptional>=1 character

pageintegerRequired>=1Defaults to 1

per_pageintegerOptional10-100Defaults to 25

next_page_tokenstringOptional

Response

Successful response

Authentication

Path parameters

Headers

Query parameters

Response