Scheduling Audit is a read-only resource, meaning audits cannot be modified or deleted. Hence, there is only one API to get the audits. However, the result can be filtered in various ways as per the need.
Data Model
AuditAction ENUM
| Value | Description |
|---|---|
| CREATE | Audit action for creation of a resource. |
| UPDATE | Audit action for modification of a resource. |
| DELETE | Audit action for deletion of a resource. |
Changes Object
The object represents the before and after values of a modified property of a
resource.
| Name | Required? | Data Type? | Description |
|---|---|---|---|
| before | y | Object | Value of a resource’s property before modification. |
| after | y | Object | Value of a resource’s property after modification. |
SchedulingAudit Object
The object is used for generating an Audit record for Scheduling resources’
CRUD actions.
| Name | Required? | Data Type? | Description |
|---|---|---|---|
| id | Y | String | (System Generated) The ID of the generated audit. |
| organizationId | Y | Long | The ID of the EB organization being audited. |
| calendarId | N | Long | The ID of the Calendar being audited. |
| shiftScheduleId | Y | Long | The ID of the ShiftSchedule being audited. |
| staffScheduleId | Y | Long | The ID of the StaffSchedule being audited. |
| shiftScheduleSubstitudionId | N | Long | The ID of the ShiftScheduleSubstitution being audited. |
| staffSubstituionId | N | Long | The ID of the StaffSubstitution being audited. |
| action | Y | AuditAction | The Scheduling CRUD action being audited. |
| auditResource | Y | ParameterizedBaseMongoObject | The Scheduling resource name being audited. This could be a Calendar, ShiftSchedule, StaffSchedule, ShiftScheduleSubstitution, or StaffSubstitution object with its respective properties that are tracked by Audit. |
| details | N | Map<String,Changes> | Map of modified properties of the resource being audited with their respective before and after modification values. |
| includes | N | List | List of resource objects with their static metadata (values at the time of audit) that can be looked up by the IDs in the SchedulingAudit object. |
| createdDate | Y | Date | Date-time stamp (in UTC +0) of the generation of the audit. |
| createId | Y | Long | The ID of the User/Contact responsible for the Scheduling CRUD action corresponding to the audit. |
| createdName | Y | String | The name of the User/Contact responsible for the Scheduling CRUD action corresponding to the audit. |
Additional Query Params supported
The following query parameters are not listed under supported "Query Params" section for this API because the parameter name doesn't match regular expression: ^[a-zA-Z0-9:._$-]+$] You can still use them optionally in filtering Scheduling Audit request.
Readme portal does not support adding query parameters that are not explicitly listed in the "Query Params" section. If you need to test with additional query parameters, please use tools like Postman or similar alternatives.
Name Description Data Type createdDate[gte] Start date (in UTC +0) of the audits that this request should filter by
Eg. 2019-01-08 or 2019-01-08T00:00:00Zstring createdDate[lte] End date (in UTC +0) of the audits that this request should filter by
Eg. 2019-01-09 or 2019-01-09T00:00:00Zstring