Get Event Definitions
post
/config/sim/v2/setup/getEventDefinitions
Gets Event Definitions.
Request
Supported Media Types
- multipart/form-data
- application/json
The input body model that needs to be given.
Root Schema : schema
Type:
Show Source
object-
include:
string
If specified, limits the data returned to these fields.Example:
eventId, hierUnitId, objectNum, name, shortCode, eventCode, eventTypeObjectNum, eventSubTypeObjectNum, rvcs, eventAreas -
includeAll:
string
If this value is specified, the include parameter is ignored.
Value Description basic Forces the response to include all fields except option string details detailed Forces the response to include all fields including option string details Example:detailed -
langIds:
string
If specified, limits translated strings returned.Example:
1,2,3 -
limit:
integer
If using paging, number of results returned in this page.Example:
100 -
offset:
integer
Starting resource record index.Example:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order. The default ordering is objectNum ascending.Example:
objectNum:asc -
searchCriteria:
string
If specified, returns records that match the criteria. Date/time fields are not searchable.Example:
where equals(hierUnitId, 3599)
Response
Supported Media Types
- application/json
200 Response
A collection of Event Definitions.
Root Schema : schema
Type:
Show Source
object-
count:
integer
Current response record count.Example:
10 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items:
array items
Array of Event Definition objects.
-
limit:
integer
Server page size.Example:
10 -
offset:
integer
Starting resource record index.Example:
0 -
totalResults:
integer
Total number of rows.Example:
100
Nested Schema : items
Type:
arrayArray of Event Definition objects.
Show Source
-
Array of:
object EventDefinition
Event Definition record.
Nested Schema : EventDefinition
Type:
objectEvent Definition record.
Show Source
-
actualEndDateTime:
string
Actual event end date/time.Example:
2026-07-15T22:05:00 -
actualStartDateTime:
string
Actual event start date/time.Example:
2026-07-15T18:05:00 -
attendance:
integer
Event attendance value.Example:
150 -
cancelDateTime:
string
Event cancel date/time.Example:
2026-07-14T10:00:00 -
endAutoTrigger:
boolean
Indicates whether the event ends automatically.Example:
true -
endDateTime:
string
Event end date/time.Example:
2026-07-15T22:00:00 -
eventAreas:
array eventAreas
Event Areas assigned to the Event Definition.
-
eventCode:
string
Full Event Definition event code. Generated internally from shortCode, startDateTime, and objectNum.Example:
WEDREC|20260715-10 -
eventId:
integer
Unique Event Definition identifier.Example:
50123 -
eventSubTypeObjectNum:
integer
Object number of the associated Event Sub Type.Example:
2 -
eventTypeObjectNum:
integer
Object number of the associated Event Type.Example:
1 -
externalEventId:
string
External event identifier.Example:
EV1001 -
hierUnitId:
integer
Unique reference of the Property hierarchy unit where the Event Definition is configured.Example:
3599 -
name:
object name
Event Definition name in configured languages.
-
nextEventId:
integer
Linked next Event Definition identifier.Example:
50124 -
objectNum:
integer
Object number of the Event Definition.Example:
10 -
previousEventId:
integer
Linked previous Event Definition identifier.Example:
50122 -
rvcs:
array rvcs
Revenue centers assigned to the Event Definition.
-
shortCode:
string
Short code parsed from the Event Definition event code.Example:
WEDREC -
startAutoTrigger:
boolean
Indicates whether the event starts automatically.Example:
true -
startDateTime:
string
Event start date/time.Example:
2026-07-15T18:00:00 -
status:
integer
Runtime Event Definition status. Values are 0 = Uninitialized, 1 = Started, 2 = Complete, 99 = Cancelled.Example:
0
Nested Schema : name
Type:
objectEvent Definition name in configured languages.
Example:
{
"1":"Wedding Reception",
"2":"Recepcion de Boda",
"3":"Reception de Mariage"
}Nested Schema : items
Type:
Show Source
object-
eventAreaObjectNum:
integer
Event Area object number.Example:
5
Nested Schema : items
Type:
Show Source
object-
rvcId:
integer
Revenue center identifier.Example:
101