Exception History Object

The Exception History object provides detailed information for an exception at a specific point in time. 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.

Attributes

string (UUID)

ID of the exception history snapshot.

exceptionId

string (UUID)

ID of the exception.

type

string, enum values: ASSIGNED_TO, CREATE, STATUS_CHANGE

Event that triggered the creation of the exception history snapshot. The following values are supported:

CREATE Exception has been created.
STATUS_CHANGE Exception’s status has changed.
ASSIGNED_TO Exception has been assigned to a different user.

description

string

Description of the history snapshot.

previousValue

string

Previous value of the updated field.

newValue

string

New value of the updated field.

createdBy

object

Entity that created the exception.

string (UUID)

ID of the entity. Will be blank if createdBy.type is internal.

type

string enum, values: employee, internal, kor_employee, service-account

Type of entity. The following values are supported:

employee Team Member using the RocketKOR Portal.
internal Internal service call.
kor_employee Rocket Financial employee.
service-account Service Account using APIs.

createdAt

string (date-time), format: yyyy-MM-dd’T’HH:mm:ss.SSSz

Date and time the exception was created in the RocketKOR system.

updatedBy

object

Entity that last updated the exception.

string (UUID)

ID of the entity. Will be blank if updatedBy.type is internal.

type

string enum, values: employee, internal, kor_employee, service-account

Type of entity. The following values are supported:

employee Team Member using the RocketKOR Portal.
internal Internal service call.
kor_employee Rocket Financial employee.
service-account Service Account using APIs.

updatedAt

string (date-time), format: yyyy-MM-dd’T’HH:mm:ss.SSSz

Date and time the exception was last updated.

Exception History Object

				
					{
  "id": "string(UUID)",
  "exceptionId": "string(UUID)",
  "type": "ASSIGNED_TO | CREATE | STATUS_CHANGE",
  "description": "string",
  "previousValue": "string",
  "newValue": "string",
  "createdBy": {
    "id": "string(UUID)",
    "type": "employee | internal | kor_employee | service-account"
  },
  "createdAt": "string(date-time)",
  "updatedBy": {
    "id": "string(UUID)",
    "type": "employee | internal | kor_employee | service-account"
  },
  "updatedAt": "string(date-time)"
}