APIs which offer external systems to config and use values different than what are configured in opera Compatible with OPERA Cloud release 26.2.0.0. 10 operation(s) documented; base path /dvm/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 DataValueMapping Service API",
"description": "APIs which offer external systems to config and use values different than what are configured in opera<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": "/dvm/v1",
"produces": [
"application/json"
],
"paths": {
"/externalSystems/{extSystemCode}/hotels/{externalHotelId}/conversions": {
"get": {
"summary": "Fetch Converted Hotel Code",
"description": "This API allows you to get the converted hotel code <p><strong>OperationId:</strong>getOperaHotelCode</p>",
"operationId": "getOperaHotelCode",
"parameters": [
{
"name": "externalHotelId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000,
"description": ""
},
{
"name": "extSystemCode",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000,
"description": ""
},
{
"name": "operaHotelCode",
"in": "query",
"required": false,
"description": "Opera Resort for which conversion is needed.",
"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 to fetch the opera resort for an interface and given the external resort value or vice versa.",
"schema": {
"$ref": "#/definitions/convertedHotelCode"
}
},
"204": {
"description": "OperaHotelCode 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": [
"DataValueMapping"
]
}
},
"/externalSystems/{extSystemCode}/hotels/{operaHotelId}/convertedValues": {
"get": {
"summary": "Fetch Converted Values",
"description": "This API allows you to get the converted values <p><strong>OperationId:</strong>getConvertedValues</p>",
"operationId": "getConvertedValues",
"parameters": [
{
"name": "operaHotelId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000,
"description": ""
},
{
"name": "extSystemCode",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000,
"description": ""
},
{
"name": "externalHotelId",
"in": "query",
"required": false,
"description": "External value of resort for which conversion is needed.",
"type": "string"
},
{
"name": "conversionCode",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Enumeration of the different conversion codes needed for data value mapping.",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"AccountType",
"ActionCode",
"ActionType",
"ActivityLocation",
"ActivityStatus",
"ActivityType",
"ActivityTypeSc",
"AddressTypes",
"ArrangementCode",
"BlockCancellationCodes",
"BlockCodes",
"BlockConversion",
"BlockRanking",
"BlockRateOverrideReason",
"BookingStatus",
"BookingType",
"BusiinessSegment",
"CalendarEvent",
"CancellationCodes",
"CategoryCode",
"CatItemrate",
"CatRate",
"CatServing",
"CatSetup",
"ChannelCodes",
"ComboRoom",
"CommentType",
"CompetitionCode",
"CountryCode",
"CurrencyCode",
"DayType",
"DepartmentId",
"DeptNoteCode",
"DiscountReason",
"DocumentType",
"EventType",
"FitContractType",
"Frequency",
"FunctionSpaceLocation",
"FunctionSpaceRateType",
"GenderMf",
"GtdReq",
"GuestPreferenceCode",
"GuestPreferenceType",
"IndustryCode",
"InfluenceCode",
"LanguageCodes",
"MarketingCity",
"MarketingRegion",
"MarketCode",
"MeetingRoomtype",
"MembershipLevel",
"MembershipType",
"MembershipTypeAirline",
"Nationality",
"OcrmBounceType",
"OcrmEventType",
"OtaGuestPreferenceCode",
"PaymentMethod",
"PhoneType",
"PosFamilyGroup",
"PosMajorGroup",
"PosMenuDef",
"PosRevenueCenter",
"PriceCode",
"ProductCode",
"ProfilePriority",
"ProfileSource",
"ProfileType",
"RateCategory",
"RateCode",
"RateProgram",
"RateToRateBlock",
"RateType",
"ReasonCode",
"Relationship",
"ReservationStatus",
"ReservationType",
"ResvBookingMethod",
"RevenueGroups",
"RevenueType",
"Room",
"RoomsPotential",
"RoomCategoryLabel",
"RoomClass",
"RoomPool",
"RoomRepairsReasonCode",
"RoomStatusReasons",
"RoutingCode",
"Scope",
"ScopeCity",
"ScAccPriority",
"ScAccRoomsPot",
"ScAccSource",
"ScDestination",
"ScFunctionSpace",
"ScFunctionSpaceRateCode",
"ScFunctionSpaceSetup",
"ScRevenueTypes",
"ScSetupCode",
"ScTaskCode",
"ScTerritory",
"ServiceRequestType",
"SgiLanguage",
"SgiRequestCodes",
"SgiTitle",
"SourceCode",
"State",
"Title",
"TraceCode",
"TraceDepartment",
"TransportTypes",
"TravelAgentCommissionCodes",
"TravelAgentCurrencyCodes",
"Trxgenerates",
"TrxCode",
"VipLevel",
"WaitlistCodes",
"WebuserSecurityQuestion"
]
},
"required": false
},
{
"name": "valueToBeConverted",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Value to be converted. It can be opera or external value.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "masterValue",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Master value is supposed to be Opera value.",
"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"
}
},
"description": "Response for all the converted values.",
"schema": {
"$ref": "#/definitions/convertedValues"
}
},
"204": {
"description": "ConvertedValues 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": [
"DataValueMapping"
]
}
},
"/externalSystems/{extSystemCode}/hotels/{operaHotelId}/defaultValues": {
"get": {
"summary": "Fetch Default values",
"description": "This API allows you to get default values <p><strong>OperationId:</strong>getDefaultValues</p>",
"operationId": "getDefaultValues",
"parameters": [
{
"name": "operaHotelId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000,
"description": ""
},
{
"name": "extSystemCode",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000,
"description": ""
},
{
"$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 for all the converted values.",
"schema": {
"$ref": "#/definitions/defaultValues"
}
},
"204": {
"description": "DefaultValues 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": [
"DataValueMapping"
]
}
},
"/externalSystems/{externalSystem}/conversionCodes": {
"get": {
"summary": "Fetch Data Value Mapping Conversion Codes",
"description": "API to fetch Data Value Mapping Conversion Codes for a given external system. Filters include optional hotelId and group (XML Type).<p><strong>OperationId:</strong>getDvmConversionCodes</p>",
"operationId": "getDvmConversionCodes",
"parameters": [
{
"name": "externalSystem",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Identifier of the external system."
},
{
"name": "hotelId",
"in": "query",
"required": false,
"type": "string",
"minLength": 1,
"maxLength": 20,
"description": "Unique OPERA internal ID used to identify a Hotel in OPERA."
},
{
"name": "group",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi",
"description": "List of XML Types (groups) to filter conversion codes."
},
{
"name": "conversionCode",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi",
"description": "List of specific conversion codes to filter."
},
{
"name": "configuredOnly",
"in": "query",
"required": false,
"type": "string",
"default": "N",
"description": "If 'Y', returns only configured conversion codes for the interface. Otherwise, returns all conversion codes."
},
{
"$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": {
"description": "Response to fetch Data Value Mapping Conversion Codes.",
"headers": {
"Content-Language": {
"type": "string",
"description": "Audience language",
"pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*",
"x-example": "en-GB"
}
},
"schema": {
"$ref": "#/definitions/fetchDvmConversionCodes"
}
},
"204": {
"description": "No conversion codes found for the given filters."
},
"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": [
"DataValueMapping"
]
}
},
"/externalSystems/{externalSystem}/conversionCodes/{conversionCode}/dataValueMappings": {
"get": {
"summary": "Fetch Data Value Mappings for specific conversion code.",
"description": "Retrieve mappings for a specific conversion code configured for external system, hotelId and Global mappings.<p><strong>OperationId:</strong>getDataValueMappings</p>",
"operationId": "getDataValueMappings",
"parameters": [
{
"name": "externalSystem",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Identifier of the external system."
},
{
"name": "conversionCode",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 80,
"description": "Type of Conversion Code configured in OPERA."
},
{
"name": "hotelId",
"in": "query",
"required": false,
"type": "string",
"minLength": 1,
"maxLength": 20,
"description": "Unique OPERA hotel Id used to identify a Hotel in OPERA."
},
{
"name": "scope",
"in": "query",
"required": false,
"type": "string",
"default": "All",
"description": "Fetch data based on scope: Filtered by All(default), Global, hotelId."
},
{
"name": "mappingIds",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi",
"description": "List of mapping Id's to filter."
},
{
"name": "searchText",
"in": "query",
"required": false,
"type": "string",
"description": "Search string to filter by OPERA value, external value, or description."
},
{
"$ref": "#/parameters/authKey"
},
{
"$ref": "#/parameters/x-app-key"
},
{
"$ref": "#/parameters/x-request-id"
},
{
"$ref": "#/parameters/x-originating-application"
},
{
"$ref": "#/parameters/Accept-Language"
}
],
"responses": {
"200": {
"description": "Retrieve Data Value Mapping response",
"headers": {
"Content-Language": {
"type": "string",
"description": "Audience language",
"pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*",
"x-example": "en-GB"
}
},
"schema": {
"$ref": "#/definitions/fetchDvmMappings"
}
},
"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": [
"DataValueMapping"
]
},
"post": {
"summary": "Create Conversion Code Mappings",
"description": "API to create Data Value Mapping (DVM) Conversion Codes by External System and Conversion Code. <p><strong>OperationId:</strong>postDataValueMappings</p>",
"operationId": "postDataValueMappings",
"parameters": [
{
"name": "externalSystem",
"in": "path",
"required": true,
"type": "string",
"description": "Unique ID used to identify an external system."
},
{
"name": "conversionCode",
"in": "path",
"required": true,
"type": "string",
"description": "Type of conversion code configured in the system."
},
{
"name": "conversionCodeMappingsToBeCreated",
"in": "body",
"required": true,
"description": "Request Object to Create Conversion Code Mappings.",
"schema": {
"$ref": "#/definitions/dvmConversionCodeMappingsToBeCreated"
}
},
{
"$ref": "#/parameters/authKey"
},
{
"$ref": "#/parameters/externalData"
},
{
"$ref": "#/parameters/x-app-key"
},
{
"$ref": "#/parameters/x-request-id"
},
{
"$ref": "#/parameters/x-originating-application"
},
{
"$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": "Response Object for creating Conversion Code Mappings.",
"schema": {
"$ref": "#/definitions/createdDvmConversionCodeMappings"
}
},
"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": [
"DataValueMapping"
]
},
"put": {
"summary": "Update Conversion Code Mappings",
"description": "API to update existing Data Value Mapping (DVM) Conversion Code records for a given External System and Conversion Code. <p><strong>OperationId:</strong>putDataValueMappings</p>",
"operationId": "putDataValueMappings",
"parameters": [
{
"name": "externalSystem",
"in": "path",
"required": true,
"type": "string",
"description": "Unique Id used to identify an external system."
},
{
"name": "conversionCode",
"in": "path",
"required": true,
"type": "string",
"description": "Conversion Code configured in OPERA."
},
{
"name": "conversionCodeMappingsToBeUpdated",
"in": "body",
"required": true,
"description": "Request to update existing Conversion Code Mappings.",
"schema": {
"$ref": "#/definitions/dvmConversionCodeMappingsToBeUpdated"
}
},
{
"$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": {
"description": "Response for updating Conversion Code Mappings.",
"schema": {
"$ref": "#/definitions/updatedDvmConversionCodeMappings"
},
"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"
}
}
},
"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": [
"DataValueMapping"
]
},
"delete": {
"summary": "Remove Conversion Codes Mappings",
"description": "API to Delete Interface Mapping Conversion Codes by providing one or more Mapping IDs as query parameter. <p><strong>OperationId:</strong>deleteDataValueMappings</p>",
"operationId": "deleteDataValueMappings",
"parameters": [
{
"name": "externalSystem",
"in": "path",
"required": true,
"type": "string",
"description": "External System code"
},
{
"name": "conversionCode",
"in": "path",
"required": true,
"type": "string",
"description": "Conversion Code"
},
{
"name": "mappingIds",
"in": "query",
"required": true,
"type": "array",
"collectionFormat": "multi",
"items": {
"type": "integer"
},
"description": "List of Mapping IDs to delete"
},
{
"$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/Accept-Language"
}
],
"responses": {
"200": {
"description": "Id's deleted and any failures with reasons.",
"headers": {
"Content-Language": {
"type": "string",
"description": "Audience language",
"pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*",
"x-example": "en-GB"
}
},
"schema": {
"$ref": "#/
# --- truncated at 32 KB (69 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle-hospitality/refs/heads/main/openapi/oracle-hospitality-property-v1-dvm.json