Get Event Definition Details
post
/config/sim/v2/setup/eventDefinitions/getDetails
Gets the revenue centers and event areas assigned to all 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:
hierUnitId, objectNum, areaObjectNum, rvcId -
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 hierUnitId, objectNum, areaObjectNum, and rvcId.Example:
objectNum:asc -
searchCriteria:
string
If specified, returns records that match the criteria. Allowed fields are hierUnitId, objectNum, areaObjectNum, and rvcId.Example:
where equals(rvcId, 101)
Response
Supported Media Types
- application/json
200 Response
A collection of Event Definition assignments.
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 Detail objects.
-
limit:
integer
Server page size.Example:
10 -
offset:
integer
Starting resource record index.Example:
0 -
totalResults:
integer
Total number of records.Example:
100
Nested Schema : items
Type:
arrayArray of Event Definition Detail objects.
Show Source
-
Array of:
object EventDefinitionDetail
Event Definition assignment. Each item represents either an assigned revenue center or an assigned event area.
Nested Schema : EventDefinitionDetail
Type:
objectEvent Definition assignment. Each item represents either an assigned revenue center or an assigned event area.
Show Source
-
areaObjectNum:
integer
Event Area object number for an event area assignment.Example:
3 -
hierUnitId:
integer
Unique hierarchy unit value of the parent Event Definition.Example:
3599 -
objectNum:
integer
Object number of the parent Event Definition.Example:
10 -
rvcId:
integer
Revenue Center ID for a revenue center assignment.Example:
101