OPERA Cloud Sales Event Management API

APIs to cater for Event Management functionality in OPERA Cloud. The Events feature in OPERA Cloud is designed to manage any kind of catering activity. Events can be as simple as a one-hour reception or more complex, such as a three-day business meeting with meals, breaks, and specific meeting functionSpaceDetails with setupCode and resource requirements. Any group function can be an Event. Compatible with OPERA Cloud release 26.2.0.0. 45 operation(s) documented; base path /evm/v1. Harvested verbatim from Oracle's public hospitality-api-docs repository (Swagger 2.0, release 26.2.0.0).

OpenAPI Specification

oracle-hospitality-property-v1-evm.json Raw ↑
{
  "swagger": "2.0",
  "info": {
    "title": "OPERA Cloud Sales Event Management API",
    "description": "APIs to cater for Event Management functionality in OPERA Cloud. <br /><br />The Events feature in OPERA Cloud is designed to manage any kind of catering activity. Events can be as simple as a one-hour reception or more complex, such as a three-day business meeting with meals, breaks, and specific meeting functionSpaceDetails with setupCode and resource requirements. Any group function can be an Event.<br /><br /> Compatible with OPERA Cloud release 26.2.0.0.<br /><br /><p> This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2026 Oracle and/or its affiliates.</p>",
    "version": "26.2.0.0",
    "termsOfService": "https://www.oracle.com/legal/terms.html",
    "contact": {
      "email": "hospitality_apis_ww_grp@oracle.com"
    },
    "license": {
      "name": "UPL",
      "url": "https://opensource.org/licenses/upl"
    }
  },
  "schemes": [
    "https"
  ],
  "basePath": "/evm/v1",
  "produces": [
    "application/json"
  ],
  "paths": {
    "/alternateEvents": {
      "put": {
        "summary": "Manage alternate events.",
        "description": " <p><strong>OperationId:</strong>manageAlternateEvents</p>",
        "operationId": "manageAlternateEvents",
        "parameters": [
          {
            "name": "manageAlternateEvents",
            "in": "body",
            "required": true,
            "description": "Request object for managing catering events those are alternate to other catering events.",
            "schema": {
              "allOf": [
                {
                  "$ref": "#/definitions/manageAlternateEvents"
                },
                {
                  "example": {
                    "manageAlternateEventsInstruction": "Copy",
                    "alternateEvents": [
                      {
                        "eventPrimaryInfo": {
                          "eventId": {
                            "url": "string",
                            "type": "string",
                            "instance": "string",
                            "idContext": "string",
                            "id": "string",
                            "idExtension": 0
                          },
                          "hotelId": "string",
                          "includeSubEvents": true
                        },
                        "eventDetail": {
                          "eventName": {
                            "defaultText": "string",
                            "translations": {
                              "text": [
                                {
                                  "value": "string",
                                  "language": "string"
                                }
                              ]
                            }
                          },
                          "eventType": "string",
                          "eventTimeSpan": {
                            "startDateTime": "2020-07-17T11:06:40.118Z",
                            "endDateTime": "2020-07-17T11:06:40.118Z"
                          },
                          "eventStatus": {
                            "status": {
                              "code": "string",
                              "description": "string"
                            },
                            "color": "White"
                          },
                          "waitlistReturnStatus": {
                            "status": {
                              "code": "string",
                              "description": "string"
                            },
                            "color": "White"
                          },
                          "cateringStatusType": "Waitlist",
                          "attendees": {
                            "expected": 0,
                            "guaranteed": 0,
                            "actual": 0,
                            "set": 0,
                            "billed": 0,
                            "packageExpected": 0,
                            "packageGuaranteed": 0,
                            "packageActual": 0,
                            "packageBilled": 0
                          },
                          "masterEventId": {
                            "id": "string",
                            "type": "string"
                          },
                          "doorcard": "string",
                          "eventLink": {
                            "id": {
                              "id": "string",
                              "type": "string"
                            },
                            "type": "SubEvent",
                            "masterEventDates": {
                              "startDateTime": "2020-07-17T11:06:40.118Z",
                              "endDateTime": "2020-07-17T11:06:40.118Z"
                            }
                          },
                          "inactiveDate": "2020-07-17",
                          "packageId": 0,
                          "packageName": "string",
                          "masterEvent": true,
                          "subEvent": true,
                          "packageEvent": true,
                          "alternateEvent": true,
                          "waitlisted": true,
                          "notMoveable": true,
                          "loudEvent": true,
                          "hasPostings": true,
                          "displayDoorcard": true,
                          "cateringDeductInventory": true,
                          "eventShared": true,
                          "createDateTime": "2020-07-17T11:06:40.118Z",
                          "creatorId": "string",
                          "lastModifyDateTime": "2020-07-17T11:06:40.118Z",
                          "lastModifierId": "string",
                          "purgeDate": "2020-07-17",
                          "includeSpaceInPackage": true,
                          "eventLevelRevenueActualization": true
                        },
                        "eventResources": [
                          {
                            "resourceId": {
                              "url": "string",
                              "type": "string",
                              "instance": "string",
                              "idContext": "string",
                              "id": "string",
                              "idExtension": 0
                            },
                            "resourceType": "FunctionSpace",
                            "resourceName": "string",
                            "setupCode": "string",
                            "itemAttribute": "string",
                            "quantity": 0,
                            "hours": 0,
                            "persons": 0,
                            "quantityIncluded": 0,
                            "quantityExcluded": 0,
                            "unitPrice": {
                              "amount": 0,
                              "currencyCode": "string"
                            },
                            "revenue": {
                              "amount": 0,
                              "currencyCode": "string"
                            },
                            "rentalCode": "string",
                            "discount": 0,
                            "eventResourceNotes": [
                              {
                                "noteId": {
                                  "id": "string",
                                  "type": "string"
                                },
                                "noteCode": "string",
                                "internal": true,
                                "noteTitle": "string",
                                "comment": "string",
                                "sequence": 0,
                                "createDateTime": "2020-07-17T11:06:40.118Z",
                                "creatorId": "string",
                                "lastModifyDateTime": "2020-07-17T11:06:40.118Z",
                                "lastModifierId": "string",
                                "purgeDate": "2020-07-17"
                              }
                            ],
                            "sellStartDate": "2020-07-17",
                            "sellEndDate": "2020-07-17",
                            "eventStartDate": "2020-07-17",
                            "eventEndDate": "2020-07-17",
                            "consumptionBased": true,
                            "multiChoice": true,
                            "hotelId": "string",
                            "order": "string",
                            "hasDiscountMenuItem": true,
                            "hasNotes": true,
                            "external": true,
                            "custom": true,
                            "packaged": true
                          }
                        ],
                        "processInstructions": {
                          "overrideCapacity": true,
                          "overbook": true,
                          "shareable": true,
                          "overrideMaxgroups": true,
                          "waitList": true,
                          "warnFunctionSpace": true
                        },
                        "eventBlockInfo": {
                          "blockIdList": [
                            {
                              "id": "string",
                              "type": "string"
                            }
                          ]
                        },
                        "functionSpaceInformation": {
                          "functionSpaceCode": "string",
                          "functionSpaceDescription": "string",
                          "setupCode": "string",
                          "setupDescription": "string",
                          "setupTime": 0,
                          "setdownTime": 0,
                          "rentalCode": "string",
                          "rateDesc": "string",
                          "rentalAmount": {
                            "amount": 0,
                            "currencyCode": "string"
                          },
                          "discountPercentage": 0,
                          "minimumOccupancy": 0,
                          "maximumOccupancy": 0,
                          "shareable": true,
                          "comboSpace": true,
                          "elementSpace": true
                        },
                        "eventNotes": [
                          {
                            "noteId": {
                              "id": "string",
                              "type": "string"
                            },
                            "noteCode": "string",
                            "internal": true,
                            "noteTitle": "string",
                            "comment": "string",
                            "sequence": 0,
                            "createDateTime": "2020-07-17T11:06:40.138Z",
                            "creatorId": "string",
                            "lastModifyDateTime": "2020-07-17T11:06:40.138Z",
                            "lastModifierId": "string",
                            "purgeDate": "2020-07-17"
                          }
                        ],
                        "eventIndicators": [
                          {
                            "indicatorName": "string",
                            "count": 0
                          }
                        ],
                        "onTheBooksRevenue": {
                          "amount": 0,
                          "currencyCode": "string"
                        },
                        "subEventsDetail": [
                          {
                            "eventPrimaryInfo": {
                              "eventId": {
                                "url": "string",
                                "type": "string",
                                "instance": "string",
                                "idContext": "string",
                                "id": "string",
                                "idExtension": 0
                              },
                              "hotelId": "string",
                              "includeSubEvents": true
                            },
                            "eventDetail": {
                              "eventName": {
                                "defaultText": "string",
                                "translations": {
                                  "text": [
                                    {
                                      "value": "string",
                                      "language": "string"
                                    }
                                  ]
                                }
                              },
                              "eventType": "string",
                              "eventTimeSpan": {
                                "startDateTime": "2020-07-17T11:06:40.138Z",
                                "endDateTime": "2020-07-17T11:06:40.138Z"
                              },
                              "eventStatus": {
                                "status": {
                                  "code": "string",
                                  "description": "string"
                                },
                                "color": "White"
                              },
                              "waitlistReturnStatus": {
                                "status": {
                                  "code": "string",
                                  "description": "string"
                                },
                                "color": "White"
                              },
                              "cateringStatusType": "Waitlist",
                              "attendees": {
                                "expected": 0,
                                "guaranteed": 0,
                                "actual": 0,
                                "set": 0,
                                "billed": 0,
                                "packageExpected": 0,
                                "packageGuaranteed": 0,
                                "packageActual": 0,
                                "packageBilled": 0
                              },
                              "masterEventId": {
                                "id": "string",
                                "type": "string"
                              },
                              "doorcard": "string",
                              "eventLink": {
                                "id": {
                                  "id": "string",
                                  "type": "string"
                                },
                                "type": "SubEvent",
                                "masterEventDates": {
                                  "startDateTime": "2020-07-17T11:06:40.138Z",
                                  "endDateTime": "2020-07-17T11:06:40.138Z"
                                }
                              },
                              "inactiveDate": "2020-07-17",
                              "packageId": 0,
                              "packageName": "string",
                              "masterEvent": true,
                              "subEvent": true,
                              "packageEvent": true,
                              "alternateEvent": true,
                              "waitlisted": true,
                              "notMoveable": true,
                              "loudEvent": true,
                              "hasPostings": true,
                              "displayDoorcard": true,
                              "cateringDeductInventory": true,
                              "eventShared": true,
                              "createDateTime": "2020-07-17T11:06:40.138Z",
                              "creatorId": "string",
                              "lastModifyDateTime": "2020-07-17T11:06:40.138Z",
                              "lastModifierId": "string",
                              "purgeDate": "2020-07-17",
                              "includeSpaceInPackage": true,
                              "eventLevelRevenueActualization": true
                            },
                            "functionSpaceInformation": {
                              "functionSpaceCode": "string",
                              "functionSpaceDescription": "string",
                              "setupCode": "string",
                              "setupDescription": "string",
                              "setupTime": 0,
                              "setdownTime": 0,
                              "rentalCode": "string",
                              "rateDesc": "string",
                              "rentalAmount": {
                                "amount": 0,
                                "currencyCode": "string"
                              },
                              "discountPercentage": 0,
                              "minimumOccupancy": 0,
                              "maximumOccupancy": 0,
                              "shareable": true,
                              "comboSpace": true,
                              "elementSpace": true
                            }
                          }
                        ],
                        "altEventsDetail": [
                          {
                            "eventPrimaryInfo": {
                              "eventId": {
                                "url": "string",
                                "type": "string",
                                "instance": "string",
                                "idContext": "string",
                                "id": "string",
                                "idExtension": 0
                              },
                              "hotelId": "string",
                              "includeSubEvents": true
                            },
                            "eventDetail": {
                              "eventName": {
                                "defaultText": "string",
                                "translations": {
                                  "text": [
                                    {
                                      "value": "string",
                                      "language": "string"
                                    }
                                  ]
                                }
                              },
                              "eventType": "string",
                              "eventTimeSpan": {
                                "startDateTime": "2020-07-17T11:06:40.138Z",
                                "endDateTime": "2020-07-17T11:06:40.138Z"
                              },
                              "eventStatus": {
                                "status": {
                                  "code": "string",
                                  "description": "string"
                                },
                                "color": "White"
                              },
                              "waitlistReturnStatus": {
                                "status": {
                                  "code": "string",
                                  "description": "string"
                                },
                                "color": "White"
                              },
                              "cateringStatusType": "Waitlist",
                              "attendees": {
                                "expected": 0,
                                "guaranteed": 0,
                                "actual": 0,
                                "set": 0,
                                "billed": 0,
                                "packageExpected": 0,
                                "packageGuaranteed": 0,
                                "packageActual": 0,
                                "packageBilled": 0
                              },
                              "masterEventId": {
                                "id": "string",
                                "type": "string"
                              },
                              "doorcard": "string",
                              "eventLink": {
                                "id": {
                                  "id": "string",
                                  "type": "string"
                                },
                                "type": "SubEvent",
                                "masterEventDates": {
                                  "startDateTime": "2020-07-17T11:06:40.138Z",
                                  "endDateTime": "2020-07-17T11:06:40.138Z"
                                }
                              },
                              "inactiveDate": "2020-07-17",
                              "packageId": 0,
                              "packageName": "string",
                              "masterEvent": true,
                              "subEvent": true,
                              "packageEvent": true,
                              "alternateEvent": true,
                              "waitlisted": true,
                              "notMoveable": true,
                              "loudEvent": true,
                              "hasPostings": true,
                              "displayDoorcard": true,
                              "cateringDeductInventory": true,
                              "eventShared": true,
                              "createDateTime": "2020-07-17T11:06:40.139Z",
                              "creatorId": "string",
                              "lastModifyDateTime": "2020-07-17T11:06:40.139Z",
                              "lastModifierId": "string",
                              "purgeDate": "2020-07-17",
                              "includeSpaceInPackage": true,
                              "eventLevelRevenueActualization": true
                            },
                            "functionSpaceInformation": {
                              "functionSpaceCode": "string",
                              "functionSpaceDescription": "string",
                              "setupCode": "string",
                              "setupDescription": "string",
                              "setupTime": 0,
                              "setdownTime": 0,
                              "rentalCode": "string",
                              "rateDesc": "string",
                              "rentalAmount": {
                                "amount": 0,
                                "currencyCode": "string"
                              },
                              "discountPercentage": 0,
                              "minimumOccupancy": 0,
                              "maximumOccupancy": 0,
                              "shareable": true,
                              "comboSpace": true,
                              "elementSpace": true
                            }
                          }
                        ],
                        "masterEventDetail": {
                          "eventPrimaryInfo": {
                            "eventId": {
                              "url": "string",
                              "type": "string",
                              "instance": "string",
                              "idContext": "string",
                              "id": "string",
                              "idExtension": 0
                            },
                            "hotelId": "string",
                            "includeSubEvents": true
                          },
                          "eventDetail": {
                            "eventName": {
                              "defaultText": "string",
                              "translations": {
                                "text": [
                                  {
                                    "value": "string",
                                    "language": "string"
                                  }
                                ]
                              }
                            },
                            "eventType": "string",
                            "eventTimeSpan": {
                              "startDateTime": "2020-07-17T11:06:40.139Z",
                              "endDateTime": "2020-07-17T11:06:40.139Z"
                            },
                            "eventStatus": {
                              "status": {
                                "code": "string",
                                "description": "string"
                              },
                              "color": "White"
                            },
                            "waitlistReturnStatus": {
                              "status": {
                                "code": "string",
                                "description": "string"
                              },
                              "color": "White"
                            },
                            "cateringStatusType": "Waitlist",
                            "attendees": {
                              "expected": 0,
                              "guaranteed": 0,
                              "actual": 0,
                              "set": 0,
                              "billed": 0,
                              "packageExpected": 0,
                              "packageGuaranteed": 0,
                              "packageActual": 0,
                              "packageBilled": 0
                            },
                            "masterEventId": {
                              "id": "string",
                              "type": "string"
                            },
                            "doorcard": "string",
                            "eventLink": {
                              "id": {
                                "id": "string",
                                "type": "string"
                              },
                              "type": "SubEvent",
                              "masterEventDates": {
                                "startDateTime": "2020-07-17T11:06:40.139Z",
                                "endDateTime": "2020-07-17T11:06:40.139Z"
                              }
                            },
                            "inactiveDate": "2020-07-17",
                            "packageId": 0,
                            "packageName": "string",
                            "masterEvent": true,
                            "subEvent": true,
                            "packageEvent": true,
                            "alternateEvent": true,
                            "waitlisted": true,
                            "notMoveable": true,
                            "loudEvent": true,
                            "hasPostings": true,
                            "displayDoorcard": true,
                            "cateringDeductInventory": true,
                            "eventShared": true,
                            "createDateTime": "2020-07-17T11:06:40.139Z",
                            "creatorId": "string",
                            "lastModifyDateTime": "2020-07-17T11:06:40.139Z",
                            "lastModifierId": "string",
                            "purgeDate": "2020-07-17",
                            "includeSpaceInPackage": true,
                            "eventLevelRevenueActualization": true
                          },
                          "functionSpaceInformation": {
                            "functionSpaceCode": "string",
                            "functionSpaceDescription": "string",
                            "setupCode": "string",
                            "setupDescription": "string",
                            "setupTime": 0,
                            "setdownTime": 0,
                            "rentalCode": "string",
                            "rateDesc": "string",
                            "rentalAmount": {
                              "amount": 0,
                              "currencyCode": "string"
                            },
                            "discountPercentage": 0,
                            "minimumOccupancy": 0,
                            "maximumOccupancy": 0,
                            "shareable": true,
                            "comboSpace": true,
                            "elementSpace": true
                          }
                        },
                        "eventRevenues": {
                          "eventRevenueInformation": [
                            {
                              "revenueType": {
                                "code": "string",
                                "translatableDescription": {
                                  "defaultText": "string",
                                  "translations": {
                                    "text": [
                                      {
                                        "value": "string",
                                        "language": "string"
                                      }
                                    ]
                                  }
                                },
                                "displaySequence": 0,
                                "revenueGroup": "string",
                                "foodAndBeverage": true,
                                "inactive": true,
                                "revenueDetails": [
                                  {
                                    "hotelId": "string",
                                    "revenueMinimum": true,
                                    "tax": 0
                                  }
                                ]
                              },
                              "forecastRevenue": {
                                "amount": 0,
                                "currencyCode": "string"
                              },
                              "expectedRevenue": {
                                "amount": 0,
                                "currencyCode": "string"
                              },
                              "guaranteedRevenue": {
                                "amount": 0,
                                "currencyCode": "string"
                              },
                              "onTheBooksRevenue": {
                                "amount": 0,
                                "currencyCode": "string"
                              },
                              "billedRevenue": {
                                "amount": 0,
                                "currencyCode": "string"
                              },
                              "actualRevenue": {
                                "amount": 0,
                                "currencyCode": "string"
                              },
                              "totalCost": {
                                "amount": 0,
                                "currencyCode": "string"
                              },
                              "flatForecastRevenue": true,
                              "custom": true,
                              "ignoreForecast": true,
                              "packaged": true,
                              "orderBy": 0
                            }
                          ],
                          "currencyCode": "string",
                          "excludeFromForecast": true,
                          "useForecastRevenue": true,
                          "eventLevelRevenueActualization": true
                        }
                      }
                    ],
                    "links": [
                      {
                        "href": "string",
                        "rel": "string",
                        "templated": false,
                        "method": "GET",
                        "targetSchema": "string",
                        "operationId": "string",
                        "title": "string"
                      }
                    ]
                  }
                }
              ]
            }
          

# --- truncated at 32 KB (1380 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle-hospitality/refs/heads/main/openapi/oracle-hospitality-property-v1-evm.json