Get Event Types
post
/config/sim/v2/setup/getEventTypes
Gets Event Types and their nested Event Sub Type records.
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:
hierUnitId, objectNum, name, mainMenuLevelIndex, subMenuLevelIndex, subTypes -
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.Example:
hierUnitId:asc -
searchCriteria:
string
If specified, returns records that match the criteria.Example:
where equals(hierUnitId, 3599)
Response
Supported Media Types
- application/json
200 Response
A collection of Event Types.
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 Type 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 Type objects.
Show Source
-
Array of:
object items
Model for Event Type configuration.
Nested Schema : items
Type:
objectModel for Event Type configuration.
Show Source
-
hierUnitId:
integer
Unique reference of the Enterprise hierarchy unit where the Event Type is configured.Example:
3599 -
mainMenuLevelIndex:
integer
Main menu level index configured for the Event Type.Example:
1 -
name:
object name
Event Type name in configured languages.
-
objectNum:
integer
Object number of the Event Type.Example:
1 -
subMenuLevelIndex:
integer
Sub menu level index configured for the Event Type.Example:
2 -
subTypes:
array subTypes
Event Sub Type records associated with the Event Type.
Nested Schema : name
Type:
objectEvent Type name in configured languages.
Example:
{
"1":"Banquet",
"2":"Banquete",
"3":"Reception"
}Nested Schema : subTypes
Type:
arrayEvent Sub Type records associated with the Event Type.
Show Source
-
Array of:
object items
Model for an Event Sub Type associated with the Event Type.
Nested Schema : items
Type:
objectModel for an Event Sub Type associated with the Event Type.
Show Source
-
name:
object name
Event Sub Type name in configured languages.
-
objectNum:
integer
Object number of the Event Sub Type.Example:
10
Nested Schema : name
Type:
objectEvent Sub Type name in configured languages.
Example:
{
"1":"Wedding",
"2":"Boda",
"3":"Mariage"
}