Get Event Areas
post
/config/sim/v2/setup/getEventAreas
Gets Event Areas
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 -
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 returnedExample:
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. Allowed fields are objectNum, hierUnitId, and name.Example:
hierUnitId:asc -
searchCriteria:
string
If specified, returns records that match the criteria. Allowed fields are objectNum, hierUnitId, and name.Example:
where equals(hierUnitId, 3599)
Response
Supported Media Types
- application/json
200 Response
A collection of Event Areas.
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 Area objects.
-
limit:
integer
Server page sizeExample:
10 -
offset:
integer
Starting resource record indexExample:
0 -
totalResults:
integer
Total number of rowsExample:
100
Nested Schema : items
Type:
arrayArray of Event Area objects.
Show Source
-
Array of:
object EventArea
Event Area record
Nested Schema : EventArea
Type:
objectEvent Area record
Show Source
-
hierUnitId:
integer
Unique hierarchy unit value.Example:
3599 -
name:
object name
A group of string objects representing the name of the Event Area in configured languages.
-
objectNum:
integer
Object number of the Event Area.Example:
1
Nested Schema : name
Type:
objectA group of string objects representing the name of the Event Area in configured languages.
Example:
{
"1":"Patio",
"2":"Terrasse",
"3":"Patio"
}