APIs catering to the managing export master data configuration. 22 operation(s) documented; base path /exp/config/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 Export Configuration API",
"description": "APIs catering to the managing export master data configuration. <br /><The exports feature in OPERA Cloud provides the ability to create and export data files, such as back office data, to third-party interfaces and receiving systems.<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": "/exp/config/v1",
"produces": [
"application/json"
],
"paths": {
"/availableExports": {
"get": {
"summary": "Operation to fetch exports available.",
"description": "Use this API to return available exports based on search criteria such as fetchColumns, fetchDataSetup, fetchDestinationSetup, fetchGenerateConfiguration, limit, exportFileId, idExtension, idContext, type, hotelIds, fileGroup, includeInactive, includeComponents. <p><strong>OperationId:</strong>getExportsAvailable</p>",
"operationId": "getExportsAvailable",
"parameters": [
{
"name": "fetchColumns",
"in": "query",
"required": false,
"type": "boolean"
},
{
"name": "fetchDataSetup",
"in": "query",
"required": false,
"type": "boolean"
},
{
"name": "fetchDestinationSetup",
"in": "query",
"required": false,
"type": "boolean"
},
{
"name": "fetchGenerateConfiguration",
"in": "query",
"required": false,
"type": "boolean"
},
{
"name": "limit",
"in": "query",
"required": false,
"description": "Indicates maximum number of records a Web Service should return.",
"type": "integer"
},
{
"name": "exportFileId",
"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": "hotelIds",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"description": "Hotel code.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "fileGroup",
"in": "query",
"required": false,
"type": "string",
"description": "Enumeration of export file groups.",
"uniqueItems": true,
"enum": [
"Miscellaneous",
"Memberships",
"Country",
"Delphi",
"BackOffice",
"BackOfficeRevenue",
"BackOfficeCityLedger",
"BackOfficeMarketStatistics",
"BackOfficeDailyStatistics",
"CommissionEft"
]
},
{
"name": "includeInactive",
"in": "query",
"required": false,
"description": "Indicates whether inactive records should be returned.",
"type": "boolean"
},
{
"name": "match",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "includeComponents",
"in": "query",
"required": false,
"description": "Indicate whether component exports should be included in the request.",
"type": "boolean"
},
{
"$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 including a list of available exports.",
"schema": {
"$ref": "#/definitions/exportsAvailable"
}
},
"204": {
"description": "ExportsAvailable 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": [
"Export"
]
}
},
"/columnsAndFunctions": {
"get": {
"summary": "Operation to fetch export columns and functions.",
"description": "Use this API to return export columns and functions based on search criteria such as fetchDbColumns, fetchOperaApis, fetchPrePostProcedures, dataSource, exportFileId, category. <p><strong>OperationId:</strong>getExportColumnsAndFunctions</p>",
"operationId": "getExportColumnsAndFunctions",
"parameters": [
{
"name": "fetchDbColumns",
"in": "query",
"required": false,
"type": "boolean"
},
{
"name": "fetchOperaApis",
"in": "query",
"required": false,
"type": "boolean"
},
{
"name": "fetchPrePostProcedures",
"in": "query",
"required": false,
"type": "boolean"
},
{
"name": "dataSource",
"in": "query",
"required": false,
"description": "Data source for which we are supposed to get columns and pre post procedures",
"type": "string"
},
{
"name": "exportFileId",
"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": "category",
"in": "query",
"required": false,
"type": "string",
"description": "Enumeration of API Categories.",
"uniqueItems": true,
"enum": [
"Exports",
"CustomNumbers"
]
},
{
"$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 that contains columns, pre post functions and export functions.",
"schema": {
"$ref": "#/definitions/exportColumnsAndFunctionsDetails"
}
},
"204": {
"description": "ExportColumnsAndFunctions 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": [
"Export"
]
}
},
"/exportMappingCodes": {
"post": {
"summary": "Operation to create export mapping codes.",
"description": " <p><strong>OperationId:</strong>postExportMappingCodes</p>",
"operationId": "postExportMappingCodes",
"parameters": [
{
"name": "exportMappingCodes",
"in": "body",
"required": true,
"description": "Request to create export mapping code for a given export.",
"schema": {
"allOf": [
{
"$ref": "#/definitions/exportMappingCodes"
}
]
}
},
{
"$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": [
"Export"
]
},
"put": {
"summary": "Operation to update export mapping codes.",
"description": " <p><strong>OperationId:</strong>putExportMappingCodes</p>",
"operationId": "putExportMappingCodes",
"parameters": [
{
"name": "exportMappingCodes",
"in": "body",
"required": true,
"description": "Request to create export mapping code for a given export.",
"schema": {
"allOf": [
{
"$ref": "#/definitions/exportMappingCodes"
}
]
}
},
{
"$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": "Response Body.",
"schema": {
"$ref": "#/definitions/exportMappingCodesDetails"
}
},
"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": [
"Export"
]
}
},
"/exportMappingLinkedTypes": {
"put": {
"summary": "Operation to update export mapping linked types.",
"description": " <p><strong>OperationId:</strong>putExportMappingLinkedTypes</p>",
"operationId": "putExportMappingLinkedTypes",
"parameters": [
{
"name": "exportMappingLinkedTypes",
"in": "body",
"required": true,
"description": "Request to fetch codes linked to export mapping codes.",
"schema": {
"allOf": [
{
"$ref": "#/definitions/exportMappingLinkedTypes"
}
]
}
},
{
"$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": "Response Body.",
"schema": {
"$ref": "#/definitions/exportMappingLinkedTypesDetails"
}
},
"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": [
"Export"
]
}
},
"/exportMappings": {
"get": {
"summary": "Operation to fetch export mappings by chain.",
"description": " <p><strong>OperationId:</strong>getExportMappingsByChain</p>",
"operationId": "getExportMappingsByChain",
"parameters": [
{
"name": "hotelId",
"in": "query",
"required": false,
"type": "string",
"description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X."
},
{
"name": "exportMappingConfigs",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Enumeration of Types allowed for Export Mapping",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"TransactionCodes",
"MarketCodes",
"PackageCodes",
"PaymentMethods",
"ProfileIdTypes",
"StatisticCodes",
"PropertyCodes",
"CountryCodes",
"NationalityCodes",
"StateCodes",
"DistrictCodes",
"CityCodes",
"CountryCities",
"PurposeOfStayCodes",
"TransportationCodes",
"CancelReasons",
"Gender",
"RoomTypes",
"IdCountryCodes"
]
},
"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"
}
},
"description": "Response to fetch the export definitions for a given export.",
"schema": {
"$ref": "#/definitions/fetchExportMappings"
}
},
"204": {
"description": "ExportMappingsByChain 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": [
"Export"
]
}
},
"/exportSchedules": {
"post": {
"summary": "Operation to create export schedules.",
"description": "Use this API to create export schedules. <p><strong>OperationId:</strong>postExportSchedules</p>",
"operationId": "postExportSchedules",
"parameters": [
{
"name": "exportSchedulesCriteria",
"in": "body",
"required": true,
"description": "Request to create export schedules",
"schema": {
"allOf": [
{
"$ref": "#/definitions/exportSchedulesCriteria"
}
]
}
},
{
"$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": [
"Export"
]
},
"delete": {
"summary": "Operation to remove export schedules.",
"description": "Use this API to delete export schedules based on the jobNames. <p><strong>OperationId:</strong>removeExportSchedules</p>",
"operationId": "removeExportSchedules",
"parameters": [
{
"name": "jobNames",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Unique name that identifies export schedule",
"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": [
"Export"
]
}
},
"/exportSchedules/{exportFileId}": {
"put": {
"summary": "Operation to change export schedules.",
"description": " <p><strong>OperationId:</strong>changeExportSchedulesByChain</p>",
"operationId": "changeExportSchedulesByChain",
"parameters": [
{
"name": "exportFileId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000,
"description": "Unique ID of export file."
},
{
"name": "exportSchedulesToBeChanged",
"in": "body",
"required": true,
"description": "Request object for changing export schedules",
"schema": {
"allOf": [
{
"$ref": "#/definitions/exportSchedulesToBeChanged"
}
]
}
},
{
"$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": "Response Body.",
"schema": {
"$ref": "#/definitions/exportSchedulesStatus"
}
},
"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":
# --- truncated at 32 KB (160 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle-hospitality/refs/heads/main/openapi/oracle-hospitality-property-v1-expcfg.json