GET Events/EntityEvent
Get entityEvent from criteria
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| IncludeActive |
Include records where RecordState == RecordState.Active |
boolean |
None. |
| IncludeInactive |
Include records where RecordState == RecordState.Inactive |
boolean |
None. |
| IncludeDeleted |
Include records where RecordState == RecordState.Deleted |
boolean |
None. |
| Match |
When searching by string, include records based on match type |
MatchCriteriaStringType |
None. |
| EntityIDs |
Filter by EntityIDs |
Collection of integer |
None. |
| EventIDs |
Filter by EventIDs |
Collection of integer |
None. |
| EntityType |
Filter by EntityType |
EntityType |
None. |
| EntityRole |
Filter by EntityRole |
EntityEventRole |
None. |
| ActualStartDateUtcMin |
Filter by ActualStartDateUtcMin |
date |
None. |
| ActualStartDateUtcMax |
Filter by ActualStartDateUtcMax |
date |
None. |
| ActualStopDateUtcMin |
Filter by ActualStopDateUtcMin |
date |
None. |
| ActualStopDateUtcMax |
Filter by ActualStopDateUtcMax |
date |
None. |
| ActualMinutes |
Filter by ActualMinutes |
integer |
None. |
| ClientOrderID |
Filter by ClientOrderID |
integer |
None. |
| RoleID |
Filter by RoleID |
integer |
None. |
| ServiceID |
Filter by ServiceID |
integer |
None. |
| CreatedDateUtcMin |
Filter by CreatedDateUtcMin |
date |
None. |
| CreatedDateUtcMax |
Filter by CreatedDateUtcMax |
date |
None. |
| LastUpdatedDateUtcMin |
Filter by LastUpdatedDateUtcMin |
date |
None. |
| LastUpdatedDateUtcMax |
Filter by LastUpdatedDateUtcMax |
date |
None. |
| ExcludeEventSubType |
Exclude by EventSubType |
EventSubType |
None. |
Body Parameters
None.
Response Information
Resource Description
List of EntityEventDTOs
Collection of EntityEventDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| EntityID |
Entity ID |
integer |
None. |
| EventID |
Event ID |
integer |
None. |
| EntityType |
Entity Type |
EntityType |
None. |
| EntityRole |
Entity Role |
EntityEventRole |
None. |
| ActualStartDateUtc |
Actual Start Date Utc |
date |
None. |
| ActualStopDateUtc |
Actual Stop Date Utc |
date |
None. |
| ActualMinutes |
Actual Minutes |
integer |
None. |
| ClientOrderID |
Client Order ID |
integer |
None. |
| RoleID |
Role ID |
integer |
None. |
| ServiceID |
Service ID |
integer |
None. |
| RecordState |
Record State |
RecordState |
None. |
| Created |
Created |
AuditDataDTO |
None. |
| LastUpdated |
Last Updated |
AuditDataDTO |
None. |
| Summary |
Summary |
string |
None. |