APIs to cater for Sales Activity functionality in OPERA Cloud. Activities provide you with an account management tool for managing daily tasks such as appointments, sales calls, contact follow-up, and so on. Compatible with OPERA Cloud release 26.2.0.0. 23 operation(s) documented; base path /act/v1. Harvested verbatim from Oracle's public hospitality-api-docs repository (Swagger 2.0, release 26.2.0.0).
{
"swagger": "2.0",
"info": {
"title": "OPERA Cloud Activity API",
"description": "APIs to cater for Sales Activity functionality in OPERA Cloud. <br /><br /> Activities provide you with an account management tool for managing daily tasks such as appointments, sales calls, contact follow-up, and so on.<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": "/act/v1",
"produces": [
"application/json"
],
"paths": {
"/activities": {
"get": {
"summary": "Get activities",
"description": "Use this API to retrieve activities for multiple hotels. Results can be narrowed down by your search criteria in the request message. <p><strong>OperationId:</strong>getActivitiesByMultipleHotelIds</p> <p>The maximum allowable limit for this API is <strong>200</strong>.</p>",
"operationId": "getActivitiesByMultipleHotelIds",
"parameters": [
{
"name": "completed",
"in": "query",
"required": false,
"description": "Indicates whether the Activity is completed or not.",
"type": "boolean"
},
{
"name": "highPriority",
"in": "query",
"required": false,
"description": "Indicates whether the Activity has high priority.",
"type": "boolean"
},
{
"name": "limit",
"in": "query",
"required": false,
"description": "Indicates maximum number of records a Web Service should return.",
"type": "integer"
},
{
"name": "offset",
"in": "query",
"default": 0,
"required": false,
"description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.",
"type": "integer"
},
{
"name": "text",
"in": "query",
"required": false,
"description": "Search string to be used for super search.",
"type": "string"
},
{
"name": "hotelIds",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"items": {
"type": "string"
},
"required": false
},
{
"name": "startDate",
"in": "query",
"required": false,
"type": "string",
"format": "date"
},
{
"name": "endDate",
"in": "query",
"required": false,
"type": "string",
"format": "date"
},
{
"name": "ownerCode",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"items": {
"type": "string"
},
"required": false
},
{
"name": "activityClass",
"in": "query",
"enum": [
"Appointment",
"Todo"
],
"required": false,
"type": "string",
"description": "A collection of supported list of activity classes.",
"uniqueItems": true
},
{
"name": "activityType",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"items": {
"type": "string"
},
"required": false
},
{
"name": "activityPurpose",
"in": "query",
"required": false,
"description": "Purpose of the Activity.",
"type": "string"
},
{
"name": "accountId",
"in": "query",
"required": false,
"description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
"type": "string"
},
{
"name": "contactId",
"in": "query",
"required": false,
"description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
"type": "string"
},
{
"name": "blockId",
"in": "query",
"required": false,
"description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
"type": "string"
},
{
"$ref": "#/parameters/authKey"
},
{
"$ref": "#/parameters/externalData"
},
{
"$ref": "#/parameters/x-app-key"
},
{
"$ref": "#/parameters/x-request-id"
},
{
"$ref": "#/parameters/x-originating-application"
},
{
"$ref": "#/parameters/x-hotelid"
},
{
"$ref": "#/parameters/x-externalsystem"
},
{
"$ref": "#/parameters/Accept-Language"
}
],
"responses": {
"200": {
"headers": {
"Content-Language": {
"type": "string",
"description": "Audience language",
"pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*",
"x-example": "en-GB"
}
},
"description": "Response object after fetching Activities.",
"schema": {
"$ref": "#/definitions/activitiesInfo"
},
"examples": {
"application/json": {
"activitiesInformation": [
{
"activityId": {
"id": "149571"
},
"activityDetail": {
"hotelId": "HOTEL2",
"activityClass": "Todo",
"activityType": "OUT",
"activityPurpose": "Outlook Activity",
"activityOwner": "ABAS",
"startDateTime": "2019-12-09",
"endDateTime": "2019-12-10",
"status": {
"completed": false
},
"highPriority": false
}
},
{
"activityId": {
"id": "198848"
},
"activityDetail": {
"hotelId": "HOTEL1",
"activityClass": "Appointment",
"activityType": "BROCHURE",
"activityPurpose": "TEST1",
"activityOwner": "JBS",
"startDateTime": "2020-01-22",
"endDateTime": "2020-01-23",
"status": {
"completed": false
},
"highPriority": false
},
"linkedAccounts": {
"activityAccount": [
{
"profileIdList": [
{
"id": "679003"
}
],
"profile": {
"customer": {
"personName": [
{
"givenName": "Thomas"
}
]
},
"telephones": {
"telephoneInfo": [
{
"telephone": "+1 415 555 0100"
}
]
},
"emails": {
"emailInfo": [
{
"email": "eg@example.com"
}
]
}
},
"primary": true
}
],
"fullOverlay": false
},
"indicators": [
{
"indicatorName": "Profiles",
"count": "1"
}
]
},
{
"activityId": {
"id": "221111"
},
"activityDetail": {
"hotelId": "HOTEL2",
"activityClass": "Appointment",
"activityType": "BROCHURE",
"activityPurpose": "127 1",
"activityOwner": "GSS",
"startDateTime": "2020-02-14 08:45:00.0",
"endDateTime": "2020-02-14 09:00:00.0",
"status": {
"completed": false
},
"highPriority": false
},
"linkedAccounts": {
"activityAccount": [
{
"profileIdList": [
{
"id": "783412"
}
],
"profile": {
"customer": {
"personName": [
{
"givenName": "Jenny"
}
]
},
"telephones": {
"telephoneInfo": [
{
"telephone": "+1 415 555 0100"
}
]
},
"emails": {
"emailInfo": [
{
"email": "Jenny@example.com"
}
]
}
},
"primary": true
}
],
"fullOverlay": false
},
"linkedBlocks": [
{
"blockIdList": [
{
"id": "26957"
}
],
"blockName": "Christmas Party"
}
],
"indicators": [
{
"indicatorName": "Profiles",
"count": "2"
},
{
"indicatorName": "Blocks",
"count": "1"
}
]
},
{
"activityId": {
"id": "221112"
},
"activityDetail": {
"hotelId": "HOTEL2",
"activityClass": "Appointment",
"activityType": "BROCHURE",
"activityPurpose": "Brochure Requests",
"activityOwner": "GSS",
"startDateTime": "2020-02-14 08:45:00.0",
"endDateTime": "2020-02-14 09:00:00.0",
"status": {
"completed": false
},
"highPriority": true
},
"linkedContacts": {
"activityContact": [
{
"profileIdList": [
{
"id": "783419"
}
],
"profile": {
"customer": {
"personName": [
{
"givenName": "Sussan "
}
]
},
"telephones": {
"telephoneInfo": [
{
"telephone": "+1 415 555 0100"
}
]
},
"emails": {
"emailInfo": [
{
"email": "email@example.com"
}
]
}
},
"primary": true
}
],
"fullOverlay": false
},
"indicators": [
{
"indicatorName": "Profiles",
"count": "1"
}
]
}
],
"totalPages": "1",
"pageNumber": "1",
"maxFetchCount": "100",
"allRowsFetched": true,
"totalRows": "3"
}
}
},
"204": {
"description": "ActivitiesByMultipleHotelIds not found."
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"405": {
"$ref": "#/responses/405"
},
"406": {
"$ref": "#/responses/406"
},
"413": {
"$ref": "#/responses/413"
},
"414": {
"$ref": "#/responses/414"
},
"415": {
"$ref": "#/responses/415"
},
"500": {
"$ref": "#/responses/500"
},
"502": {
"$ref": "#/responses/502"
},
"503": {
"$ref": "#/responses/503"
}
},
"consumes": [
"application/json;charset=UTF-8"
],
"produces": [
"application/json;charset=UTF-8"
],
"tags": [
"Activity"
]
},
"delete": {
"summary": "Delete activities",
"description": "If you want to delete an activity, use this API. You must know the activity ID for the request. <p><strong>OperationId:</strong>deleteMultipleActivities</p>",
"operationId": "deleteMultipleActivities",
"parameters": [
{
"name": "activityIds",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
"items": {
"type": "string"
},
"required": false
},
{
"$ref": "#/parameters/authKey"
},
{
"$ref": "#/parameters/externalData"
},
{
"$ref": "#/parameters/x-app-key"
},
{
"$ref": "#/parameters/x-request-id"
},
{
"$ref": "#/parameters/x-originating-application"
},
{
"$ref": "#/parameters/x-hotelid"
},
{
"$ref": "#/parameters/x-externalsystem"
},
{
"$ref": "#/parameters/Accept-Language"
}
],
"responses": {
"200": {
"headers": {
"Content-Language": {
"type": "string",
"description": "Audience language",
"pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*",
"x-example": "en-GB"
},
"Location": {
"type": "string",
"description": "Location of newly created resource"
}
},
"description": "HATEOAS links which help the consumer to navigate to resources",
"schema": {
"$ref": "#/definitions/status"
}
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"405": {
"$ref": "#/responses/405"
},
"406": {
"$ref": "#/responses/406"
},
"413": {
"$ref": "#/responses/413"
},
"414": {
"$ref": "#/responses/414"
},
"415": {
"$ref": "#/responses/415"
},
"500": {
"$ref": "#/responses/500"
},
"502": {
"$ref": "#/responses/502"
},
"503": {
"$ref": "#/responses/503"
}
},
"consumes": [
"application/json;charset=UTF-8"
],
"produces": [
"application/json;charset=UTF-8"
],
"tags": [
"Activity"
]
},
"put": {
"summary": "Operation to update multiple activities",
"description": "You can use this API to bulk update activities <p><strong>OperationId:</strong>putBulkActivities</p>",
"operationId": "putBulkActivities",
"parameters": [
{
"name": "putBulkActivities",
"in": "body",
"required": true,
"description": "Request object that will Change a list of activities.",
"schema": {
"allOf": [
{
"$ref": "#/definitions/activitiesBulkUpdate"
}
]
}
},
{
"$ref": "#/parameters/authKey"
},
{
"$ref": "#/parameters/externalData"
},
{
"$ref": "#/parameters/x-app-key"
},
{
"$ref": "#/parameters/x-request-id"
},
{
"$ref": "#/parameters/x-originating-application"
},
{
"$ref": "#/parameters/x-hotelid"
},
{
"$ref": "#/parameters/x-externalsystem"
},
{
"$ref": "#/parameters/Accept-Language"
}
],
"responses": {
"200": {
"headers": {
"Content-Language": {
"type": "string",
"description": "Audience language",
"pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*",
"x-example": "en-GB"
},
"Location": {
"type": "string",
"description": "Location of newly created resource"
}
},
"description": "Status/Info of the processed activities.",
"schema": {
"$ref": "#/definitions/activitiesBulkUpdateStatus"
}
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"405": {
"$ref": "#/responses/405"
},
"406": {
"$ref": "#/responses/406"
},
"413": {
"$ref": "#/responses/413"
},
"414": {
"$ref": "#/responses/414"
},
"415": {
"$ref": "#/responses/415"
},
"500": {
"$ref": "#/responses/500"
},
"502": {
"$ref": "#/responses/502"
},
"503": {
"$ref": "#/responses/503"
}
},
"consumes": [
"application/json;charset=UTF-8"
],
"produces": [
"application/json;charset=UTF-8"
],
"tags": [
"Activity"
]
}
},
"/activities/activitiesCompletion": {
"post": {
"summary": "Complete activities",
"description": "Use this API to mark multiple Activities as completed in 1 request. You must know the OPERA Activity ID's for this API. <p><strong>OperationId:</strong>postMultipleActivitiesCompletion</p>",
"operationId": "postMultipleActivitiesCompletion",
"parameters": [
{
"name": "activitiesToChange",
"in": "body",
"required": true,
"description": "Request object for changing Activities.",
"schema": {
"allOf": [
{
"$ref": "#/definitions/activitiesToChange"
},
{
"example": {
"activitiesInformation": [
{
"activityId": {
"id": "88029"
},
"activityDetail": {
"hotelId": "HOTEL1",
"status": {
"completed": true,
"completedOn": "2020-02-11 12:01:00.0",
"completedBy": "BEN@HOTEL1"
},
"notes": "completing from external system",
"activityResult": "24"
}
},
{
"activityId": {
"id": "88030"
},
"activityDetail": {
"hotelId": "PROP1",
"status": {
"completed": true,
"completedOn": "2020-02-11 12:01:00.0",
"completedBy": "BEN@HOTEL1"
},
"notes": "completing from external system",
"activityResult": "25"
}
}
]
}
}
]
}
},
{
"$ref": "#/parameters/authKey"
},
{
"$ref": "#/parameters/externalData"
},
{
"$ref": "#/parameters/x-app-key"
},
{
"$ref": "#/parameters/x-request-id"
},
{
"$ref": "#/parameters/x-originating-application"
},
{
"$ref": "#/parameters/x-hotelid"
},
{
"$ref": "#/parameters/x-externalsystem"
},
{
"$ref": "#/parameters/Accept-Language"
}
],
"responses": {
"201": {
"headers": {
"Content-Language": {
"type": "string",
"description": "Audience language",
"pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*",
"x-example": "en-GB"
},
"Location": {
"type": "string",
"description": "Location of newly created resource"
}
},
"description": "HATEOAS links which help the consumer to navigate to resources",
"schema": {
"$ref": "#/definitions/status"
}
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"405": {
"$ref": "#/responses/405"
},
"406": {
"$ref": "#/responses/406"
},
"413": {
"$ref": "#/responses/413"
},
"414": {
"$ref": "#/responses/414"
},
"415": {
"$ref": "#/responses/415"
},
"500": {
"$ref": "#/responses/500"
},
"502": {
"$ref": "#/responses/502"
},
"503": {
"$ref": "#/responses/503"
}
},
"consumes": [
"application/json;charset=UTF-8"
],
"produces": [
"application/json;charset=UTF-8"
],
"tags": [
"Activity"
]
}
},
"/activities/emails": {
"get": {
"summary": "Get Emails",
"description": "Use this API to retrieve emails which have been received from an external system and stored in OPERA. They are stored against accounts, contacts and blocks in OPERA. <p><strong>OperationId:</strong>getEmails</p> <p>The maximum allowable limit for this API is <strong>200</strong>.</p> <p>This API allows a time span of <strong>90</strong> days.</p>",
"operationId": "getEmails",
"deprecated": true,
"parameters": [
{
"name": "limit",
"in": "query",
"required": false,
"description": "Indicates maximum number of records a Web Service should return.",
"type": "integer"
},
{
"name": "offset",
"in": "query",
"default": 0,
"required": false,
"description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.",
"type": "integer"
},
{
"name": "code",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"items": {
"type": "string"
},
"required": false
},
{
"name": "id",
"in": "query",
"required": false,
"description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
"type": "string"
},
{
"name": "idExtension",
"in": "query",
"required": false,
"description": "Additional identifying value assigned by the creating system.",
"type": "integer"
},
{
"name": "idContext",
"in": "query",
"required": false,
"description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
"type": "string"
},
{
"name": "type",
"in": "query",
"required": false,
"description": "A reference to the type of object defined by the UniqueID element.",
"type": "string"
},
{
"name": "accountIdId",
"in": "query",
"required": false,
"description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
"type": "string"
},
{
"name": "accountIdIdExtension",
"in": "query",
"required": false,
"description": "Additional identifying value assigned by the creating system.",
"type": "integer"
},
{
"name": "accountIdIdContext",
"in": "query",
"required": false,
"description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
"type": "string"
},
{
"name": "accountIdType",
"in": "query",
"required": false,
"description": "A reference to the type of object defined by the UniqueID element.",
"type": "string"
},
{
"name": "contactIdId",
"in": "query",
"required": false,
"description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
"type": "string"
},
{
"name": "contactIdIdExtension",
"in": "query",
"required": false,
"description": "Additional identifying value assigned by the creating system.",
"type": "integer"
},
{
"name": "contactIdIdContext",
"in": "query",
"required": false,
"description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
"type": "string"
},
{
"name": "contactIdType",
"in": "query",
"required": false,
"description": "A reference to the type of object defined by the UniqueID element.",
"type": "string"
},
{
"name": "blockIdId",
"in": "query",
"required": false,
"description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
"type": "string"
},
{
"name": "blockIdIdExtension",
"in": "query",
"required": false,
"description": "Additional identifying value assigned by the creating system.",
"type": "integer"
},
{
"name": "blockIdIdContext",
"in": "query",
"required": false,
"description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
"type": "string"
},
{
"name": "blockIdType",
"in": "query",
"required": false,
"description": "A reference to the type of object defined by the UniqueID element.",
"type": "string"
},
{
"name": "emailSubject",
"in": "query",
"required": false,
"description": "Subject of the email.",
"type": "string"
},
{
"name": "senderLastName",
"in": "query",
"required": false,
"description": "Family name or last name of the Sender.",
"type": "string
# --- truncated at 32 KB (221 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle-hospitality/refs/heads/main/openapi/oracle-hospitality-property-v1-act.json