Oracle Hospitality

Oracle Hospitality External Systems Config API

The ExternalSystemsConfig API from Oracle Hospitality — 27 operation(s) for externalsystemsconfig.

GitHub OpenAPI

Operations 43

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /configuredExternalDevices List external devices configured at a hotel · Operation to fetch configured external devices #
Ask an LLM
“Which external devices, like fiscal printers or payment terminals, are actually set up at my property?”
“Can I list only the active configured devices for a given device type?”
Tell an agent
List the configured external devices at hotel {hotelId}.
Show configured devices of type {deviceType} for fiscal partner {fiscalPartnerCode}.
GET /deliveryMethods Fetch delivery methods · Operation to fetch delivery methods #
Ask an LLM
“What delivery methods, like email or fax, are available for sending documents from a hotel?”
“Can I see delivery methods for a central reservations office, including inactive ones?”
Tell an agent
List the delivery methods for hotel {hotelId}.
Show delivery methods for CRO {croCode}, including inactive ones.
PUT /deliveryMethods Change existing delivery methods · Operation to change delivery methods #
Ask an LLM
“How do I edit a delivery method that's already configured?”
“Can I update several existing delivery methods in one request?”
Tell an agent
Update the existing delivery methods with {deliveryMethods}.
Change the current delivery method settings for hotel {hotelId}.
DELETE /deliveryMethods Remove delivery methods · Operation to remove delivery methods #
Ask an LLM
“How do I delete a delivery method a hotel no longer uses?”
“Can I remove a delivery method by its configuration id?”
Tell an agent destructive · confirm first
Delete delivery method type {type} at hotel {hotelId}.
Remove the delivery method with configuration id {configurationId}.
POST /deliveryMethods Create delivery methods · Operation to create delivery methods #
Ask an LLM
“How do I add a new way to deliver confirmations and folios, such as a new email channel?”
“What's needed to set up a new delivery method?”
Tell an agent
Create delivery methods {deliveryMethods}.
Add a new delivery method for hotel {hotelId}.
GET /externalDevices/configurations Fetch external device configuration settings · Operation to fetch external device configurations #
Ask an LLM
“Where do I read the configuration settings and parameters behind external devices?”
“Can I look up device configuration records by device code and device area?”
Tell an agent
Fetch the external device configuration records for hotel {hotelId}.
Find device configuration records for device code {deviceCode} in area {deviceArea}.
PUT /externalDevices/configurations Change external device configurations · Operation to change external device configurations #
Ask an LLM
“How do I update the settings for an external device like a fiscal printer?”
“Can I change several device configuration records at once?”
Tell an agent
Update external device configurations with {externalDeviceConfigurations}.
Change the external device configuration at hotel {hotelId}.
GET /externalSystems/config/ping Ping the external systems config service · Operation to ping #
Ask an LLM
“Is the external systems configuration service reachable?”
“How can I health-check the interface config service before changing settings?”
Tell an agent
Ping the external systems config service.
Check the external systems config service is up for hotel {hotelId}.
POST /externalSystems/{externalSystemCode}/hotels/{hotelId}/publishers Add publishers for an external system at a hotel · Operation to create publishers #
Ask an LLM
“How do I register which hotels publish data to an external system subscriber?”
“Can I set up a hotel as a publisher for an external system?”
Tell an agent
Add publishers for external system {externalSystemCode} at hotel {hotelId}.
Make {publishers} publish to subscriber {subscriber} on {externalSystemCode} for {hotelId}.
DELETE /externalSystems/{externalSystemCode}/hotels/{hotelId}/publishers Remove a publisher from an external system · Operation to remove publisher #
Ask an LLM
“How do I stop a hotel from publishing data to an external system?”
“Can I remove a single publisher by code for one subscriber hotel?”
Tell an agent destructive · confirm first
Remove publisher {code} from external system {externalSystemCode} at hotel {hotelId}.
Delete the publisher for subscriber hotel {subscriberHotelId} on {externalSystemCode}, hotel {hotelId}.
GET /externalSystems/{externalSystemCode}/publishers List publishers for an external system · Operation to fetch publishers #
Ask an LLM
“Which hotels are publishing data to a given external system?”
“Can I see the publishers of an external system filtered to one hotel?”
Tell an agent
List the publishers for external system {externalSystemCode}.
Show publishers on {externalSystemCode} for hotel {hotelId}.
POST /hotelInerface Create a hotel interface · Operation to create hotel interface #
Ask an LLM
“How do I set up a new interface between OPERA and a hotel system such as a PBX?”
“What details do I need to add a brand-new hotel interface?”
Tell an agent
Create a new hotel interface with {details}.
Add a new interface for hotel {hotelId}.
PUT /hotelInerface Change a hotel interface · Operation to change hotel interface #
Ask an LLM
“How do I edit the settings of an existing hotel interface, like the PBX or door lock link?”
“Can I modify an interface that's already configured for a property?”
Tell an agent
Update the existing hotel interface with {details}.
Change the configured interface settings at hotel {hotelId}.
GET /hotelInterfaceTypes List hotel interfaces by type · Operation to fetch hotel interfaces #
Ask an LLM
“Which interfaces are configured across my hotels, grouped by interface type?”
“Can I list hotel interfaces for specific logo codes, including inactive ones?”
Tell an agent
List the interfaces configured at hotels {hotelIds}.
Show hotel interfaces of type {interfaceTypes}, including external system info.
DELETE /hotels/{hotelId}/hotelInerface Remove a hotel interface · Operation to remove hotel interface #
Ask an LLM
“How do I delete an interface a hotel no longer uses?”
“Can I remove one hotel interface by its logo code?”
Tell an agent destructive · confirm first
Delete interface {logo} at hotel {hotelId}.
Remove the decommissioned interface from hotel {hotelId}.
POST /hotels/{hotelId}/interfaces/{interfaceId}/accounts Create an account on a hotel interface · Operation to create interface account #
Ask an LLM
“How do I add a posting account to an interface, mapping it to a transaction code?”
“What's needed to create an interface account for charges coming from a POS?”
Tell an agent
Create an account on interface {interfaceId} at hotel {hotelId}.
Add account {account} to interface {interfaceId} for {hotelId}.
PUT /hotels/{hotelId}/interfaces/{interfaceId}/accounts/{accountId} Change an interface account · Operation to change interface account #
Ask an LLM
“How do I edit an existing account on an interface?”
“Can I change the transaction mapping on one interface account?”
Tell an agent
Update account {accountId} on interface {interfaceId} at hotel {hotelId}.
Change interface account {accountId} ({interfaceId}, {hotelId}) to {account}.
DELETE /hotels/{hotelId}/interfaces/{interfaceId}/accounts/{accountId} Remove an interface account · Operation to remove interface account #
Ask an LLM
“How do I delete an account from a hotel interface?”
“Can I remove the interface account tied to a specific sales outlet?”
Tell an agent destructive · confirm first
Delete account {accountId} from interface {interfaceId} at hotel {hotelId}.
Remove interface account {accountId} for outlet {salesOutlet} on {interfaceId}, hotel {hotelId}.
GET /hotels/{hotelId}/interfaces/{interfaceId}/roomStatus Fetch an interface's room status mappings · Operation to fetch interface room statuses #
Ask an LLM
“How are room statuses translated for a housekeeping or PBX interface?”
“Which room status codes does an interface map to OPERA housekeeping statuses?”
Tell an agent
List the room status mappings for interface {interfaceId} at hotel {hotelId}.
Show how interface {interfaceId} translates room statuses at {hotelId}.
PUT /hotels/{hotelId}/interfaces/{interfaceId}/roomStatus Change an interface room status mapping · Operation to change interface room status #
Ask an LLM
“How do I change the code an interface sends for a room's housekeeping status?”
“Can I edit the custom room status translation on an interface?”
Tell an agent
Update the room status mapping on interface {interfaceId} at hotel {hotelId}.
Set room status translation {details} on interface {interfaceId}, hotel {hotelId}.
DELETE /hotels/{hotelId}/interfaces/{interfaceId}/roomStatus Remove an interface room status mapping · Operation to remove interface room status #
Ask an LLM
“How do I delete a room status translation from an interface?”
“Can I remove the mapping for one housekeeping status on an interface?”
Tell an agent destructive · confirm first
Delete room status mapping {interfaceRoomStatusId} from interface {interfaceId} at hotel {hotelId}.
Remove the {housekeepingStatus} status translation on interface {interfaceId}, hotel {hotelId}.
GET /hotels/{hotelId}/interfaces/{interfaceId}/rooms List rooms mapped to an interface · Operation to fetch interface rooms #
Ask an LLM
“Which rooms and phone lines are mapped to a PBX interface?”
“Can I list interface rooms within a room number range?”
Tell an agent
List the rooms on interface {interfaceId} at hotel {hotelId}.
Show interface {interfaceId} rooms from {fromRoom} to {toRoom} at {hotelId}.
POST /hotels/{hotelId}/interfaces/{interfaceId}/rooms Add a room to an interface · Operation to create interface room #
Ask an LLM
“How do I map a single new room and its line to an interface?”
“What do I send to add one room entry on a PBX interface?”
Tell an agent
Add a room entry to interface {interfaceId} at hotel {hotelId}.
Map room {room} onto interface {interfaceId} for {hotelId}.
DELETE /hotels/{hotelId}/interfaces/{interfaceId}/rooms Remove a room from an interface · Operation to remove interface room #
Ask an LLM
“How do I unmap a room or phone line from an interface?”
“Can I delete an interface room by room number and line number?”
Tell an agent destructive · confirm first
Remove room {roomNumber} from interface {interfaceId} at hotel {hotelId}.
Delete line {lineNumber} of room {roomNumber} on interface {interfaceId}, hotel {hotelId}.
POST /hotels/{hotelId}/interfaces/{interfaceId}/rooms/import Bulk import rooms into an interface · Operation to import interface rooms #
Ask an LLM
“How do I bulk-load all the hotel's rooms into an interface instead of adding them one by one?”
“Can I run a targeted import of rooms into a PBX interface?”
Tell an agent
Import the hotel's rooms into interface {interfaceId} at hotel {hotelId}.
Run a targeted room import {targetedImport} into interface {interfaceId} for {hotelId}.
PUT /hotels/{hotelId}/interfaces/{interfaceId}/rooms/{roomId} Change a room mapped to an interface · Operation to change interface room #
Ask an LLM
“How do I edit the line or class-of-service settings on a room already mapped to an interface?”
“Can I update one interface room by its id?”
Tell an agent
Update interface room {roomId} on interface {interfaceId} at hotel {hotelId}.
Change interface room {roomId} ({interfaceId}, {hotelId}) to {room}.
GET /hotels/{hotelId}/interfaces/{interfaceId}/unitCharges Fetch an interface's unit charges · Operation to fetch interface unit charges #
Ask an LLM
“What unit charges are set for call accounting on a telephone interface?”
“Where can I see the per-unit rates an interface uses to bill calls?”
Tell an agent
Show the unit charges for interface {interfaceId} at hotel {hotelId}.
Get unit charges for logo {logo} on interface {interfaceId}, hotel {hotelId}.
PUT /hotels/{hotelId}/interfaces/{interfaceId}/unitCharges Change an interface's unit charges · Operation to change interface unit charges #
Ask an LLM
“How do I change the per-unit call charges on a telephone interface?”
“Can I update the unit charge table for an interface?”
Tell an agent
Update the unit charges on interface {interfaceId} at hotel {hotelId}.
Set unit charges {details} for interface {interfaceId}, hotel {hotelId}.
GET /hotels/{hotelId}/logos/{logo} Get details of one hotel interface by logo · Operation to fetch hotel interface details #
Ask an LLM
“How do I see the full configuration of one specific interface at a hotel?”
“Can I fetch a single interface's details by its logo code?”
Tell an agent
Show the details of interface {logo} at hotel {hotelId}.
Get interface {logo} configuration for {hotelId} with fetch instructions {fetchInstructions}.
GET /interfaceControllerRegistry Fetch the interface controller registry · Operation to fetch hotel interface controller registry #
Ask an LLM
“Which interface controllers are registered and on which machines?”
“Can I check the controller registry entries for one machine?”
Tell an agent
Show the interface controller registry for machine {machine}.
List all registered interface controllers.
GET /interfaceErrors List hotel interface errors · Operation to fetch hotel interface errors #
Ask an LLM
“Which interfaces are throwing errors across my hotels?”
“Can I page through interface errors filtered by interface type?”
Tell an agent
List interface errors for hotels {hotelIds}.
Show the first {limit} interface errors for interface type {interfaceTypes}.
GET /interfaceFailedMessages List failed interface messages · Operation to fetch hotel interface failed messages #
Ask an LLM
“Which messages to or from an interface failed to deliver?”
“Can I see failed interface messages for specific logo codes?”
Tell an agent
List the failed interface messages for hotels {hotelIds}.
Show failed messages for interface logos {logoCodes}.
PUT /interfaceRights Change an interface right · Operation to change interface right #
Ask an LLM
“How do I grant or change a right on an interface?”
“Can I update the description of an interface right?”
Tell an agent
Update the interface right with {details}.
Change an interface right at hotel {hotelId}.
DELETE /interfaceRights Remove an interface right · Operation to remove interface right #
Ask an LLM
“How do I revoke a right from an interface?”
“Can I remove a single interface right by its code?”
Tell an agent destructive · confirm first
Remove right {right} from interface {id} at hotel {hotelId}.
Delete interface right code {code}.
GET /interfaceRights Fetch interface rights · Operation to fetch interface rights #
Ask an LLM
“What permissions or rights does an interface have at a property?”
“Can I look up the rights granted for one interface id?”
Tell an agent
List the interface rights at hotel {hotelId}.
Show the rights for interface {id} of type {type}.
GET /interfaceSchemas List hotel interface schemas · Operation to fetch hotel interface schemas #
Ask an LLM
“Which interface schemas are defined for my hotels?”
“Can I page through interface schemas filtered by interface type?”
Tell an agent
List the interface schemas for hotels {hotelIds}.
Show interface schemas for type {interfaceTypes}, {limit} at a time.
GET /interfaces/{interfaceId}/databases/{databaseId}/availableResorts List properties available in an external database · Operation to fetch external database available properties #
Ask an LLM
“Which properties can be linked to an interface's external database?”
“Can I see the resorts an external database exposes for one interface?”
Tell an agent
List available properties in database {databaseId} for interface {interfaceId}.
Show which of hotels {hotelIds} are available in external database {databaseId}, interface {interfaceId}.
GET /machines List interface machines · Operation to fetch interface machines #
Ask an LLM
“Which machines run interface programs, and on what ports?”
“Where can I see every machine registered for interfaces?”
Tell an agent
List all interface machines.
Show the interface machines registered for hotel {hotelId}.
PUT /machines/{machineId} Change an interface machine · Operation to change interface machine #
Ask an LLM
“How do I change the controller or VNC port on an interface machine?”
“Can I edit one interface machine's settings by id?”
Tell an agent
Update interface machine {machineId}.
Change interface machine {machineId} to {details}.
DELETE /machines/{machineId} Remove an interface machine · Operation to remove interface machine #
Ask an LLM
“How do I delete a machine that no longer runs interfaces?”
“Can I remove an interface machine record by id?”
Tell an agent destructive · confirm first
Delete interface machine {machineId}.
Remove machine {machineId} running program {program}.
GET /udfMappings Look up user-defined field mappings · Operation to send a response to the Look up of UDFs #
Ask an LLM
“How are user-defined fields (UDFs) mapped for interfaces?”
“Can I look up the mapping for one UDF by name?”
Tell an agent
Show the mapping for UDF {uDFName}.
List UDF mappings of type {type}.
PUT /udfMappings Change a user-defined field mapping · Operation to send a response to the Change in UDF #
Ask an LLM
“How do I change where a user-defined field maps for an interface?”
“Can I update a UDF mapping?”
Tell an agent
Update the UDF mapping to {uDFMapping}.
Change the user-defined field mapping for hotel {hotelId}.
PUT /upsert/hotels/{hotelId}/printers Create or change a hotel printer · Operation to create/change printer #
Ask an LLM
“How do I set up or update a printer for a hotel?”
“Can I add a printer or change its setup in one call?”
Tell an agent
Create or update the printer setup at hotel {hotelId}.
Upsert printer {printerSetup} for hotel {hotelId}.

Documentation

📖
Documentation
https://docs.oracle.com/cd/F29336_01/doc.201/f27480/c_oracle_hospitality_distribution_apis.htm
📖
Documentation
https://docs.oracle.com/cd/F29336_01/doc.201/f27480/c_oracle_hospitality_nor1_integrated_upsell_apis.htm
📖
Documentation
https://docs.oracle.com/cd/F29336_01/doc.201/f27480/c_property_apis.htm

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/oracle-hospitality/refs/heads/main/openapi/oracle-hospitality-externalsystemsconfig-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/oracle-hospitality:oracle-hospitality-externalsystemsconfig-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

oracle-hospitality-externalsystemsconfig-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: OPERA Cloud Integration Configuration External Systems…
  description: '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.


    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.'
  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
servers:
- url: /int/config/v1
tags:


# --- truncated at 32 KB (234 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle-hospitality/refs/heads/main/openapi/oracle-hospitality-externalsystemsconfig-api-openapi.yml