Oracle Hospitality Export API is one of 154 APIs that Oracle Hospitality publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Export. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
22 operations
across 18 paths,
and defines 88 schemas.
It is described by OpenAPI 3.2.0, at version 26.2.0.0.
Requests are made against a single base URL, /exp/config/v1.
The identity and technical contract details declared by the specification.
exportScheduleFrequencyMonthlyType
object
If specified then export is scheduled to run Monthly
9 properties
exportMappingMasterInfoType
object
Contains information about the various mapping types and the mapping codes.
4 properties
exportMappingsDetails
object
Response Body.
2 properties
fileDeliveryCommunicationType
string
Enumeration of export file groups.
generatedExports
object
Response object including a list of generated exports.
9 properties
exportScheduleFrequencyHourlyType
object
If specified then export is scheduled to run at hourly intervals
1 property
exportXMLSimpleType
object
Base type that holds information related to xml tag types
6 properties
exportHeaderSummaryType
object
Details of one export.
13 properties
exportScheduleJobNameType
string
Unique name that identifies export schedule
exportColumnLengthType
object
Type that determines the length of the export column
2 properties
expFunctionsType
array
Function parameters
exportXMLAttributeType
object
Base type that holds information related to xml tag types
6 properties
generatedExportStatusType
string
Status indicates whether job is running or not
exportScheduleWeekToRepeatType
string
Frequency for which export schedules needs to be returned
exportColumnInfoType
string
Enumeration of export file groups.
fileDeliveryConfigType
object
18 properties
exportMappingType
object
Details of one export.
5 properties
exportCodeDataType
string
Enumeration of export mapping types.
exportScheduleFrequencyIntervalType
integer
Interval at which export needs to be scheduled
exportGenerateConfigurationType
object
Details of how and when the export is to be executed.
2 properties
generatedExportListType
object
Contains a collection of available export instance records.
4 properties
warningsType
array
Used in conjunction with the Success element to define a business error.
exportColumnsAndFunctionsDetails
object
Response that contains columns, pre post functions and export functions.
3 properties
exportsAvailable
object
Response object including a list of available exports.
3 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
fetchExportMappingCodes
object
3 properties
exportSchedulesType
array
Export Schedule
generatedExportType
object
Information of one generated export.
17 properties
activityLogListType
object
7 properties
instanceLink
object
Metadata describing link description objects that MAY appear in the JSON instance representation.
7 properties
exportConfigurationType
object
Type that hold configuration information related to export
7 properties
exportScheduleFrequencyOnceType
object
If specified then export is scheduled to run only once
1 property
expDataSourceColumnsType
array
Function parameters
exportScheduleType
object
Type that holds all the information related to export schedule
13 properties
status
object
Response Body.
2 properties
exportXMLColumnsType
object
XML Columns type that hold information to all the element and attribute configuations
2 properties
exportXMLComplexWithSourceType
object
XML simple type that holds all the information related to complex element tag
6 properties
exportSchedulesConfigType
object
Export schedules information that are required to configure schedules
2 properties
exportDataSetupType
object
Details of processing data for export being setup.
16 properties
exportSchedulesCriteria
object
Request to create export schedules
3 properties
exportScheduleFrequencyByHourType
integer
Specifies the hour on which the job is to run. Valid values are 0 to 23.
exportType
string
Enumeration of export file groups.
exportScheduleFrequencyWeeklyType
object
If specified then export is scheduled to run Weekly
8 properties
exportSchedulesToBeChanged
object
Request object for changing export schedules
3 properties
exportScheduleFrequencyDailyType
object
If specified then export is scheduled to run daily
2 properties
exportScheduleFrequencyType
object
Frequency at which exports is scheduled to run
6 properties
exportColumnXMLType
string
Enumeration of export column XML types.
scheduleExportGroupType
string
Enumeration of export file groups.
exportComponentType
object
Details of a specific export component.
6 properties
warningType
object
Used when a message has been successfully processed to report any warnings or business errors that occurred.
10 properties
exceptionDetailType
object
Complex type that contains error details for a REST call.
9 properties
2 required
exportMappingConfigType
string
Enumeration of Types allowed for Export Mapping
activityLogType
object
12 properties
exportSchedulesStatus
object
Response Body.
2 properties
exportMappingCodes
object
Request to create export mapping code for a given export.
4 properties
expDataSourceColumnType
object
Information related to database columns
3 properties
exportSchedulesDetails
object
Export Schedules collection matching the crieteria specified in the request
3 properties
exportMappingLinkedCodes
object
Response to fetch codes linked to export mapping codes.
4 properties
exportXMLAttributesType
array
XML attribute type that holds all the information related to attribute tag
exportMappings
object
Request to create export definitions for a given export.
4 properties
exportMappingCodesDetails
object
Response Body.
2 properties
exportListType
object
Contains a collection of available export records.
4 properties
exportColumnsType
array
A collection of export columns.
fetchExportMappings
object
Response to fetch the export definitions for a given export.
4 properties
exportScheduleFrequencyEODType
object
If specified then export is scheduled to run during end of day
8 properties
operaVersionNumberType
string
Current Opera Version Number
exportActivityLog
object
Response object for the request for the export user activity log.
3 properties
exportMappingCodesToLink
object
9 properties
codeType
string
Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.
exportMappingLinkedTypes
object
Request to fetch codes linked to export mapping codes.
4 properties
exportScheduleEODRepeatIntervalType
string
Frequency for which export schedules needs to be run during EOD
expFunctionParamType
object
Parameters related to export functions
4 properties
exportMappingLinkedCodeType
object
Details of linked code.
8 properties
exportColumnDetailType
object
18 properties
exportComponentsType
array
A collection of export components.
expFunctionType
object
Information related to export function
2 properties
errorInstance
object
Complex type that contains error instance details for a REST call.
7 properties
2 required
transportMethodType
string
Enumeration of transport methods used to deliver exports.
exportDestinationType
object
Details of the export's destination and format.
15 properties
exportMappingCodeType
object
Details of one export.
8 properties
exportXMLComplexType
object
XML simple type that holds all the information related to complex element tag
4 properties
exportColumnsAndFunctionsType
object
Contains columns, pre post functions and export functions
3 properties
exportXMLElementsType
array
XML element type that holds all the information related to element tag
exportMappingCodesToLinkType
object
Details of code which is being mapped.
4 properties
exportXMLElementType
object
Type that holds all attributes associated with this tag together
3 properties
operaVersion
object
Response for Ping operation.
3 properties
exportMappingLinkedTypesDetails
object
Response Body.
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Oracle Hospitality publishes across the network.