OPERA Cloud Integration Configuration API
APIs catering to Integration Configuration in OPERA Cloud. Operations such as get Hotel Interface Types, or get UDF mappings can be found in this module. Compatible with OPERA Cloud release 26.2.0.0. 50 operation(s) documented; base path /int/config/v1. Harvested verbatim from Oracle's public hospitality-api-docs repository (Swagger 2.0, release 26.2.0.0).
OPERA Cloud Integration Configuration API is one of 135 APIs that Oracle Hospitality publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include BEProcessor, ExternalSystemsConfig, ChainConfig, OEDSConfig, and Property Management. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 50 operations across 31 paths, organized into 4 resource areas, and defines 171 schemas. It is described by OpenAPI 2.0, at version 26.2.0.0.
50 operations
31 paths
171 schemas
9 DELETE21 GET7 POST13 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 50
Across 31 paths, the API surfaces 50 operations — 9 DELETE, 21 GET, 7 POST, 13 PUT. They span 4 resource areas: BEProcessor, ExternalSystemsConfig, ChainConfig, OEDSConfig. Each is listed below with its method, path, parameters, and response codes.
BEProcessor 1
The BEProcessor Service offers capability of creating, managing, and retrieving of BE Processor configuration.
GET
/config/oxi/services/beProcessor/status
Operation to ping.
ExternalSystemsConfig 43
GET
/configuredExternalDevices
Operation to fetch configured external devices.
GET
/deliveryMethods
Operation to fetch delivery methods.
PUT
/deliveryMethods
Operation to change delivery methods.
DELETE
/deliveryMethods
Operation to remove delivery methods.
POST
/deliveryMethods
Operation to create delivery methods.
GET
/externalDevices/configurations
Operation to fetch external device configurations.
PUT
/externalDevices/configurations
Operation to change external device configurations.
GET
/externalSystems/config/ping
Operation to ping.
POST
/externalSystems/{externalSystemCode}/hotels/{hotelId}/publishers
Operation to create publishers.
DELETE
/externalSystems/{externalSystemCode}/hotels/{hotelId}/publishers
Operation to remove publisher.
GET
/externalSystems/{externalSystemCode}/publishers
Operation to fetch publishers.
POST
/hotelInerface
Operation to create hotel interface.
PUT
/hotelInerface
Operation to change hotel interface.
GET
/hotelInterfaceTypes
Operation to fetch hotel interfaces.
DELETE
/hotels/{hotelId}/hotelInerface
Operation to remove hotel interface.
POST
/hotels/{hotelId}/interfaces/{interfaceId}/accounts
Operation to create interface account.
PUT
/hotels/{hotelId}/interfaces/{interfaceId}/accounts/{accountId}
Operation to change interface account.
DELETE
/hotels/{hotelId}/interfaces/{interfaceId}/accounts/{accountId}
Operation to remove interface account.
GET
/hotels/{hotelId}/interfaces/{interfaceId}/roomStatus
Operation to fetch interface room statuses.
PUT
/hotels/{hotelId}/interfaces/{interfaceId}/roomStatus
Operation to change interface room status.
DELETE
/hotels/{hotelId}/interfaces/{interfaceId}/roomStatus
Operation to remove interface room status.
GET
/hotels/{hotelId}/interfaces/{interfaceId}/rooms
Operation to fetch interface rooms.
POST
/hotels/{hotelId}/interfaces/{interfaceId}/rooms
Operation to create interface room.
DELETE
/hotels/{hotelId}/interfaces/{interfaceId}/rooms
Operation to remove interface room.
POST
/hotels/{hotelId}/interfaces/{interfaceId}/rooms/import
Operation to import interface rooms.
PUT
/hotels/{hotelId}/interfaces/{interfaceId}/rooms/{roomId}
Operation to change interface room.
GET
/hotels/{hotelId}/interfaces/{interfaceId}/unitCharges
Operation to fetch interface unit charges.
PUT
/hotels/{hotelId}/interfaces/{interfaceId}/unitCharges
Operation to change interface unit charges.
GET
/hotels/{hotelId}/logos/{logo}
Operation to fetch hotel interface details.
GET
/interfaceControllerRegistry
Operation to fetch hotel interface controller registry.
GET
/interfaceErrors
Operation to fetch hotel interface errors.
GET
/interfaceFailedMessages
Operation to fetch hotel interface failed messages.
PUT
/interfaceRights
Operation to change interface right.
DELETE
/interfaceRights
Operation to remove interface right.
GET
/interfaceRights
Operation to fetch interface rights.
GET
/interfaceSchemas
Operation to fetch hotel interface schemas.
GET
/interfaces/{interfaceId}/databases/{databaseId}/availableResorts
Operation to fetch external database available properties.
GET
/machines
Operation to fetch interface machines.
PUT
/machines/{machineId}
Operation to change interface machine.
DELETE
/machines/{machineId}
Operation to remove interface machine.
GET
/udfMappings
Operation to send a response to the Look up of UDFs.
PUT
/udfMappings
Operation to send a response to the Change in UDF.
PUT
/upsert/hotels/{hotelId}/printers
Operation to create/change printer.
ChainConfig 4
These APIs will allow you to do external configuration under Administration.
GET
/deviceLocations
Get the template device locations
POST
/deviceLocations
Create the template device locations
PUT
/deviceLocations/{deviceLocationId}
Change the template device locations
DELETE
/deviceLocations/{deviceLocationId}
Delete the template device locations
OEDSConfig 2
GET
/oedsApi
Get OEDS API
PUT
/oedsApi
Update OEDS API
Schemas 171
The contract defines 171 schemas that model the data the API accepts and returns. The most detailed are generalInfoType (43 properties), interfaceAdditionalInfoType (25 properties), interfaceRoomType (19 properties), supportedExternalDeviceType (16 properties). Each schema is shown below with its type and property counts.
status
object
Response Body.
2 properties
warningsType
array
Used in conjunction with the Success element to define a business error.
warningType
object
Used when a message has been successfully processed to report any warnings or business errors that occurred.
10 properties
links
array
instanceLink
object
Metadata describing link description objects that MAY appear in the JSON instance representation.
7 properties
exceptionDetailType
object
Complex type that contains error details for a REST call.
9 properties
2 required
errorInstance
object
Complex type that contains error instance details for a REST call.
7 properties
2 required
operaVersion
object
Response for Ping operation.
3 properties
operaVersionNumberType
string
Current Opera Version Number
fetchedDeliveryMethods
object
Response to request to fetch the delivery method for a property/HUB/Chain and its configurations.
3 properties
configuredExternalDeliveryMethodsType
object
External system configuration delivery methods for a property(chain or hub).
9 properties
generalDeliveryMethodType
object
General delivery method SFTPConfigurationType configuration, settings for Email and Fax Delivery of General Letters
3 properties
emailDeliveryConfigurationType
object
Email content configuration template
13 properties
emailDeliveryFormatType
string
Email delivery format
emailDeliveryMethodType
string
Email delivery method type
faxDeliveryConfigurationType
object
Email content configuration template
13 properties
sftpConfigurationsListType
array
Type that holds sftp configurations
sftpConfigurationType
object
Information which uniquely identifies SFTP Configuration
5 properties
queueReservationDeliveryMethodType
object
Queue reservation delivery method configuration, settings for Text Message Delivery of Queue Reservation status
1 property
textMessageDeliveryConfigurationType
object
Text message delivery configuration
11 properties
urlFormatType
string
Url content format
textDeliveryMethodType
string
Text delivery method type
confirmationDeliveryMethodType
object
Confirmation letter delivery method configuration, settings for Text Message, Email and Fax Delivery of Confirmation Letters
3 properties
guestMessageDeliveryMethodType
object
Guest text message configuration, settings for Text Message Delivery of Guest Messages
1 property
billingFolioDeliveryMethodType
object
Billing folio delivery method configuration, settings for Email and Fax Delivery of Guest Folios
2 properties
queueRushDeliveryMethodType
object
Queue rush delivery method configuration, settings for Text Message Delivery of Queue Reservation status
1 property
changeDeliveryMethods
object
Request to change the delivery method for a property/HUB/Chain and its configurations.
3 properties
changedDeliveryMethods
object
Response Body.
2 properties
createDeliveryMethods
object
Request to create the delivery method for a property/HUB/Chain and its configurations.
3 properties
templateDeviceLocationsDetails
object
Response object for fetching template Device locations.
3 properties
templateDeviceLocationsType
array
List of Device locations at template level.
templateDeviceLocationType
object
Contains Common Master configuration detail.
4 properties
translationTextType2000
object
Contains Multiple translated texts and language codes.
2 properties
translationsTextType
array
Language code for the translation.
templateDeviceLocationsCriteria
object
Request object for creating template Device locations.
3 properties
templateDeviceLocationsToBeChanged
object
Request object for changing template Device locations.
3 properties
createPublishers
object
Request to create publishers.
4 properties
externalSystemType
object
External System Information
2 properties
externalSystemCodeType
object
External System Code
1 property
publishersType
array
Information of all the publishers for a given subscriber.
fetchedPublishers
object
Response to request to fetch the external systems
3 properties
fetchedHotelInterfaces
object
Response object for retrieving Hotel Interfaces.
3 properties
hotelInterfacesType
array
Collection of Hotel Interfaces.
hotelInterfaceType
object
10 properties
uniqueID_Type
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
2 properties
hotelInterfaceTypeType
string
XML Posting Interface
hotelInterfaceStatusType
string
Status of the Hotel Interface either STOPPED or RUNNING.
changeInterfaceRight
object
Request object for updating a Hotel Interface Right. It will create the Hotel Interface Right if it does not exist on the database.
3 properties
interfaceRightType
object
6 properties
changedInterfaceRight
object
Response Body.
2 properties
fetchedInterfaceRights
array
Collection of Hotel Interface Rights.
fetchedExternalDatabaseAvailableProperties
object
Response object for retrieving the Available properties for External Databases.
3 properties
externalDatabaseAssociatedHotelsType
array
Collection of Hotel for external database.
externalDatabaseAssociatedHotelType
object
2 properties
fetchedUDFMappings
object
Message received on an UDFs Lookup.
3 properties
uDFMappingType
object
Generic self-contained request object that is used when updating and fetching UDFs.
5 properties
changeUDFMapping
object
Self-contained Request object that is used when Updating UDFMapping.
3 properties
changedUDFMapping
object
Response Body.
2 properties
conditionGroupType
object
3 properties
logicalOperatorType
string
conditionType
object
4 properties
expressionFieldType
object
6 properties
expressionParameterType
object
3 properties
expressionOperatorType
object
3 properties
hotelInterfaceSchemasType
array
Collection of Hotel Interface Schemas.
hotelInterfaceSchemaType
object
7 properties
hotelInterfaceErrorsType
array
Collection of Hotel Interface Errors.
hotelInterfaceErrorType
object
8 properties
hotelInterfaceFailedMessagesType
array
Collection of Hotel Interface Failed Messages.
hotelInterfaceFailedMessageType
object
6 properties
hotelInterfaceControllerRegsType
array
Collection of Hotel Interface Controller Registry.
hotelInterfaceControllerRegType
object
5 properties
fetchedHotelInterfaceSchemas
object
Response object for retrieving Hotel Interface Schemas.
8 properties
fetchedHotelInterfaceErrors
object
Response object for retrieving Hotel Interface Errors.
8 properties
fetchedHotelInterfaceFailedMessages
object
Response object for retrieving Hotel Interface Failed Messages.
8 properties
fetchedHotelInterfaceControllerRegistry
object
Response object for retrieving Hotel Interface Controller Registry.
3 properties
arDeliveryMethodType
object
Delivery Method configuration for Email and Fax Delivery for Accounts Receivables.
2 properties
otherFolioDeliveryMethodType
object
Delivery Method configuration for Email and Fax Delivery for Other Folios
2 properties
configuredExternalDevices
object
Collection of hotels and the external devices that were configured for the hotel.
2 properties
deviceType
string
hotelExternalDevicesType
object
Type for the external device supported by the hotel.
2 properties
supportedExternalDevicesType
array
supportedExternalDeviceType
object
External device details.
16 properties
fiscalPartnerCodeType
string
Used for fiscal partner codes. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.
deviceCode
string
externalDeviceConfigurationType
object
Type for the configurations available to the device.
4 properties
deviceMappingType
object
Type that contains the codes used in/provided by the external device and their counterpart in OPERA.
4 properties
deviceConfigurationType
object
Type that contains the parameters and configurations used by the device.
5 properties
hotelInterfaceDetailType
object
13 properties
interfaceCustomDataInfoType
object
This type holds the custom data of a hotel interface.
3 properties
interfaceCustomDataDetailsType
array
Collection of custom data details of a hotel interface.
interfaceCustomDataDetailType
object
This gives information of custom detail of a hotel interface.
2 properties
interfaceCommunicationInfoType
object
1 property
tCPConfigType
object
2 properties
workstationSetupType
array
List of workstations of a hotel interface.
interfaceWorkstationType
object
9 properties
importRoomsType
object
6 properties
interfacePrimaryInfoType
object
12 properties
translationType
object
8 properties
interfaceControlCfgType
object
5 properties
interfaceControlSpecType
object
7 properties
interfaceControlLangType
object
5 properties
interfaceControlArticleType
object
6 properties
transactionCodeInfoType
object
10 properties
itemizerType
object
4 properties
postingAccountType
object
8 properties
transactionCodeDetailType
object
13 properties
itemizerShortInfoType
object
3 properties
generalInfoType
object
43 properties
sVTransactionType
string
Status of the Hotel Interface either STOPPED or RUNNING.
interfaceExportDataInfoType
object
This type holds the export data of a hotel interface.
2 properties
interfaceExportDataDetailsType
array
Collection of export data details of a hotel interface.
interfaceExportDataDetailType
object
This gives information of export detail of a hotel interface.
6 properties
interfaceAdditionalInfoType
object
25 properties
telephoneChargeType
string
Auto Choose
ifcMenuTypeType
string
Data Card System
classOfServiceType
object
9 properties
definedNameFormatType
object
5 properties
postingInfoType
object
13 properties
maskDialNumberType
string
Mask the dialled digits as per the room configuration.
interfaceRoomType
object
19 properties
dataLineType
string
Line Out
doNotDisturbType
string
Do Not Disturb is set to available and freely switchable.
messageWaitingType
string
Message Waiting is set to available and freely switchable.
classOfServiceConfigType
string
Class Of Service is set to available and freely switchable.
directInwardDialType
string
Direct Inward Dial is set to available and freely switchable.
importInterfaceRoomsType
object
15 properties
roomMaskSetupType
object
6 properties
dMLCommandType
string
A data manipulation language command for deleting an existing record.
interfaceAccountType
object
3 properties
interfaceMachineType
object
5 properties
interfaceRoomStatusType
object
8 properties
interfaceUnitChargesType
object
Collection of Hotel Interface Unit Charges.
3 properties
interfaceUnitChargeType
object
6 properties
fetchedConfiguredExternalDevices
object
3 properties
fetchedExternalDeviceConfigurations
object
3 properties
changeExternalDeviceConfigurations
object
Request to change the external device activated for the hotel and its configurations.
3 properties
changedExternalDeviceConfigurations
object
Response Body.
2 properties
hotelInterface
object
Request object for creating a new Hotel Interface.
3 properties
fetchedHotelInterfaceDetails
object
Response object for retrieving the details of a Hotel Interface.
3 properties
fetchedInterfaceRooms
array
Collection of Hotel Interface Rooms.
createInterfaceRoom
object
Request object for creating an Interface Room of a Hotel Interface record.
3 properties
changeInterfaceRoom
object
Request object for updating an Interface Room of a Hotel Interface record.
3 properties
changedInterfaceRoom
object
Response Body.
2 properties
importInterfaceRooms
object
Request object for importing the Interface Rooms for a Hotel Interface record.
5 properties
createInterfaceAccount
object
Request object for creating an Interface Account of a Hotel Interface record.
3 properties
changeInterfaceAccount
object
Request object for updating an Interface Account of a Hotel Interface record.
3 properties
changedInterfaceAccount
object
Response Body.
2 properties
fetchedInterfaceMachines
array
Collection of Hotel Interface Machines.
changeInterfaceMachine
object
Request object for updating a Hotel Interface Machine. If it does not exist, then creates the Hotel Interface Machine.
3 properties
changedInterfaceMachine
object
Response Body.
2 properties
fetchedInterfaceRoomStatuses
array
Collection of Hotel Interface Room Statuses.
changeInterfaceRoomStatus
object
Request object for updating a Hotel Interface Room Status. If it does not exist, then creates the Hotel Interface Room Status.
3 properties
changedInterfaceRoomStatus
object
Response Body.
2 properties
fetchedInterfaceUnitCharges
object
Response object for retrieving the Interface Unit Charges.
3 properties
changeInterfaceUnitCharges
object
Request object for updating Hotel Interface Unit Charges.
3 properties
changedInterfaceUnitCharges
object
Response Body.
2 properties
payByLinkDeliveryMethodType
object
Pay By Link delivery method configuration, settings for Email containing payment url
1 property
managedByOptions
string
Describes of the Configuration is Managed by Enterprise or Property.
codeListType
array
printerSetupType
object
Entity schema to persist Printers.
14 properties
printerOutputType
string
changePrinter
object
Request object for updating a new Printer and Print Task
3 properties
changedPrinter
object
Response Body.
2 properties
oedsConfigData
object
Response for all OEDS API searched.
3 properties
oedsConfigUpdate
object
Request for all OEDS API update.
1 property
oedsConfigType
object
Contains OEDS APIs information
5 properties
oedsConfigDataStatus
object
Response Body.
2 properties
opiInfoType
object
3 properties
pspEndpointValue
object
Generic endpoint configuration.
4 properties
pspEndpointParamValue
object
Parameter key-value for PSP endpoint.
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Oracle Hospitality 12
Other APIs Oracle Hospitality publishes across the network.
OPERA Cloud Distribution ARI Publication
OPERA Cloud Distribution Outbound Lookup
OPERA Cloud Distribution Content Notification
OPERA Cloud Distribution Book
OPERA Cloud Distribution Content
OPERA Cloud Distribution Property Controls
OPERA Cloud Distribution Reservation Service
OPERA Cloud Distribution Authentication API
OPERA Cloud Distribution Onboarding
OPERA Cloud Distribution Reservation Notification
OPERA Cloud Distribution Shop
Nor1 Integrated Upsell API
#BEProcessor#ExternalSystemsConfig#ChainConfig#OEDSConfig#Property Management#OPERA Cloud
Where this information came from
This is an independent, third-party profile of OPERA Cloud Integration Configuration API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.