Retrieve Exception History

Retrieve a list of all history snapshots for an exception. Exception history snapshots are created automatically based on events such as the exception creation, changes to the exception status, and the assignment of an exception to a user.

Endpoint

GET /exceptions/{exceptionId}/history

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

exceptionId  REQUIRED

string (UUID)

ID of the exception.

Query Parameters

sort

array of strings

Sort the response by any field in ascending or descending order. The default sort order is createdAt,DESC. For more information, see Sorting and Pagination.

page

integer (int32)

Page number to return, based on zero-based page indexing.

size

integer (int32)

Maximum number of results to return per page.

Request Body

None

Returns

Returns a paginated response with an array of Exception History objects.

SAMPLE RESPONSE

				
					{
  "totalElements": 3,
  "totalPages": 1,
  "number": 0,
  "numberOfElements": 3,
  "hasNext": false,
  "content": [
    {
      "id": "01514cd2-308a-44cb-a1a9-d019f42e542e",
      "exceptionId": "3859255b-addb-4af4-a8ba-2cf3ed4249f5",
      "type": "STATUS_CHANGE",
      "description": "status change",
      "previousValue": "NEW",
      "newValue": "IN_PROGRESS",
      "createdBy": {
        "id": "3a86d0eb-a2a2-4779-9420-528abe695337",
        "type": "employee"
      },
      "createdAt": "2025-03-30T15:33:21.390Z",
      "updatedBy": {
        "id": "3a86d0eb-a2a2-4779-9420-528abe695337",
        "type": "employee"
      },
      "updatedAt": "2025-03-31T15:33:21.390Z"
    },
    {...},
    {...}
  ]
}
				
			
Exit mobile version