Upsert Event Types

post

/config/sim/v2/setup/upsertEventTypes

Updates provided fields if the Event Type exists; inserts a new Event Type if it does not.

Request

Supported Media Types
Header Parameters
Body ()
Request body for upserting an Event Type.
Root Schema : schema
Type: object
Model for upserting an Event Type.
Show Source
  • Unique reference of the Enterprise hierarchy unit where the Event Type is configured.
    Example: 3599
  • Minimum Value: 0
    Maximum Value: 8
    Main menu level index configured for the Event Type.
    Example: 1
  • name
    Event Type name in configured languages. Required when the upsert inserts a new Event Type.
  • Minimum Value: 1
    Maximum Value: 999999999
    Object number of the Event Type.
    Example: 1
  • Minimum Value: 0
    Maximum Value: 8
    Sub menu level index configured for the Event Type.
    Example: 2
  • subTypes
    Event Sub Type records associated with the Event Type. Updating this collection inserts new records, updates existing records, and deletes omitted records when no Event Definitions reference them.
Nested Schema : name
Type: object
Event Type name in configured languages. Required when the upsert inserts a new Event Type.
Example:
{
    "1":"Banquet",
    "2":"Banquete",
    "3":"Reception"
}
Nested Schema : subTypes
Type: array
Event Sub Type records associated with the Event Type. Updating this collection inserts new records, updates existing records, and deletes omitted records when no Event Definitions reference them.
Show Source
  • items
    Model for an Event Sub Type associated with the Event Type. Required fields apply only when a subtype object is supplied.
Nested Schema : items
Type: object
Model for an Event Sub Type associated with the Event Type. Required fields apply only when a subtype object is supplied.
Show Source
Nested Schema : name
Type: object
Event Sub Type name in configured languages.
Example:
{
    "1":"Wedding",
    "2":"Boda",
    "3":"Mariage"
}
Back to Top

Response

Supported Media Types

200 Response

Event Type updated.
Body ()
Root Schema : schema
Type: object
Show Source

201 Response

Event Type inserted.
Body ()
Root Schema : schema
Type: object
Show Source
Back to Top