Get Event Definitions

post

/config/sim/v2/setup/getEventDefinitions

Gets Event Definitions.

Request

Supported Media Types
Body ()
The input body model that needs to be given.
Root Schema : schema
Type: object
Show Source
  • If specified, limits the data returned to these fields.
    Example: eventId, hierUnitId, objectNum, name, shortCode, eventCode, eventTypeObjectNum, eventSubTypeObjectNum, rvcs, eventAreas
  • 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
  • If specified, limits translated strings returned.
    Example: 1,2,3
  • If using paging, number of results returned in this page.
    Example: 100
  • Starting resource record index.
    Example: 0
  • Sorts the response by the specified field name and sort order. The default ordering is objectNum ascending.
    Example: objectNum:asc
  • If specified, returns records that match the criteria. Date/time fields are not searchable.
    Example: where equals(hierUnitId, 3599)
Back to Top

Response

Supported Media Types

200 Response

A collection of Event Definitions.
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : items
Type: array
Array of Event Definition objects.
Show Source
Nested Schema : EventDefinition
Type: object
Event Definition record.
Show Source
Nested Schema : eventAreas
Type: array
Event Areas assigned to the Event Definition.
Show Source
Nested Schema : name
Type: object
Event Definition name in configured languages.
Example:
{
    "1":"Wedding Reception",
    "2":"Recepcion de Boda",
    "3":"Reception de Mariage"
}
Nested Schema : rvcs
Type: array
Revenue centers assigned to the Event Definition.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top