APIs for adding, updating, and deleting stationery reports in OPERA Cloud. Compatible with OPERA Cloud release 26.2.0.0. 12 operation(s) documented; base path /rep/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 Report Master Data Management API",
"description": "APIs for adding, updating, and deleting stationery reports in OPERA Cloud.<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": "/rep/config/v1",
"produces": [
"application/json"
],
"paths": {
"/allReportGroups": {
"get": {
"summary": "Operation to fetch all report groups.",
"description": " <p><strong>OperationId:</strong>getAllReportGroups</p>",
"operationId": "getAllReportGroups",
"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": "id",
"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": "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. Refer to OpenTravel Code List Unique ID Type (UIT).",
"type": "string"
},
{
"name": "moduleName",
"in": "query",
"required": false,
"type": "string",
"description": "Used for Character Strings, length 0 to 20."
},
{
"$ref": "#/parameters/authKey"
},
{
"$ref": "#/parameters/externalData"
},
{
"$ref": "#/parameters/x-app-key"
},
{
"$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": "This response provides the result of fetching report groups.",
"schema": {
"$ref": "#/definitions/retrievedReportGroups"
}
},
"204": {
"description": "ReportGroups 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": [
"Report"
]
}
},
"/allReports": {
"get": {
"summary": "Return reports for integration purpose.",
"description": "Use this API to return all reports based on search criteria such as excludeGroup, includeInternalReports, includeRnAReports, includeUnpublished, includeWatermarkDetails, limit, multiPropertyOnly, protectedReportParam, scheduled, name, group, hotel, id, idContext, type. <p><strong>OperationId:</strong>getAllReports</p>",
"operationId": "getAllReports",
"parameters": [
{
"name": "excludeGroup",
"minLength": 0,
"maxLength": 2000,
"in": "query",
"required": false,
"description": "Indicates whether a report group should be excluded",
"type": "string"
},
{
"name": "includeInternalReports",
"in": "query",
"required": false,
"description": "Indicates whether sample internal reports are to be included",
"type": "boolean"
},
{
"name": "includeRnAReports",
"in": "query",
"required": false,
"description": "Indicates whether RnA reports are to be included",
"type": "boolean"
},
{
"name": "includeUnpublished",
"in": "query",
"required": false,
"description": "Indicates whether protected reports should be included",
"type": "boolean"
},
{
"name": "includeWatermarkDetails",
"in": "query",
"required": false,
"description": "Indicates whether the watermark details is to be populated. This is needed only for the configuration and not for the actual execution.",
"type": "boolean"
},
{
"name": "limit",
"in": "query",
"required": false,
"description": "Indicates maximum number of records a Web Service should return.",
"type": "integer"
},
{
"name": "multiPropertyOnly",
"in": "query",
"required": false,
"description": "Indicates whether the result set should only include multi-property reports.",
"type": "boolean"
},
{
"name": "protectedReportParam",
"in": "query",
"required": false,
"description": "Indicates whether protected reports should be included",
"type": "boolean"
},
{
"name": "scheduled",
"in": "query",
"required": false,
"description": "Indicates that only reports that can be scheduled are included",
"type": "boolean"
},
{
"name": "name",
"minLength": 0,
"maxLength": 2000,
"in": "query",
"required": false,
"description": "Partial report name or description to search.",
"type": "string"
},
{
"name": "group",
"minLength": 0,
"maxLength": 2000,
"in": "query",
"required": false,
"description": "Report group to limit search.",
"type": "string"
},
{
"name": "hotel",
"minLength": 0,
"maxLength": 2000,
"in": "query",
"required": false,
"description": "Hotel code to search reports for.",
"type": "string"
},
{
"name": "id",
"minLength": 0,
"maxLength": 80,
"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": "idContext",
"minLength": 0,
"maxLength": 80,
"in": "query",
"required": false,
"description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
"type": "string"
},
{
"name": "type",
"minLength": 0,
"maxLength": 80,
"in": "query",
"required": false,
"description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT).",
"type": "string"
},
{
"$ref": "#/parameters/authKey"
},
{
"$ref": "#/parameters/externalData"
},
{
"$ref": "#/parameters/x-app-key"
},
{
"$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": "This type contains a collection of report modules which match the requested criteria. The object also may include a standard SUCCESS element or a WARNINGS or ERRORS collection.",
"schema": {
"$ref": "#/definitions/reports"
}
},
"204": {
"description": "Reports 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": [
"Report"
]
}
},
"/genericReports": {
"post": {
"summary": "Create generic reports.",
"description": "Use this API to create generic reports. <p><strong>OperationId:</strong>postGenericReports</p>",
"operationId": "postGenericReports",
"parameters": [
{
"name": "genericReports",
"in": "body",
"required": true,
"description": "This request provides End of Day reports to be created.",
"schema": {
"allOf": [
{
"$ref": "#/definitions/genericReports"
}
]
}
},
{
"$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": [
"Report"
]
},
"delete": {
"summary": "Delete generic reports.",
"description": "Use this API to delete generic reports based on hotelId, Id, contextId. <p><strong>OperationId:</strong>deleteGenericReports</p>",
"operationId": "deleteGenericReports",
"parameters": [
{
"name": "hotelId",
"minLength": 0,
"maxLength": 2000,
"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": "id",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"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.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "idContext",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
"items": {
"type": "string"
},
"required": false
},
{
"name": "type",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT).",
"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": [
"Report"
]
},
"put": {
"summary": "Update generic reports.",
"description": "Use this API to update generic reports. <p><strong>OperationId:</strong>changeGenericReports</p>",
"operationId": "changeGenericReports",
"parameters": [
{
"name": "genericReports",
"in": "body",
"required": true,
"description": "This request provides generic reports to be updated.",
"schema": {
"allOf": [
{
"$ref": "#/definitions/genericReports"
}
]
}
},
{
"$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": "This response provides the result of updating reports.",
"schema": {
"$ref": "#/definitions/genericReports"
}
},
"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": [
"Report"
]
}
},
"/reportParameters": {
"get": {
"summary": "Return report parameters.",
"description": "Use this API to return report parameters based on search criteria such as id, idContext, type. <p><strong>OperationId:</strong>getReportParameters</p>",
"operationId": "getReportParameters",
"parameters": [
{
"name": "id",
"minLength": 0,
"maxLength": 80,
"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": "idContext",
"minLength": 0,
"maxLength": 80,
"in": "query",
"required": false,
"description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
"type": "string"
},
{
"name": "type",
"minLength": 0,
"maxLength": 80,
"in": "query",
"required": false,
"description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT).",
"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": "The Fetch Report Parameters result object contains a collection of report parameters which allow/require user input prior to running the report.",
"schema": {
"$ref": "#/definitions/reportParameters"
}
},
"204": {
"description": "ReportParameters 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": [
"Report"
]
}
},
"/reportTextConfiguration/copy": {
"put": {
"summary": "Operation to copy report text configuration.",
"description": " <p><strong>OperationId:</strong>copyReportTextConfiguration</p>",
"operationId": "copyReportTextConfiguration",
"parameters": [
{
"name": "reportTextConfigurationsCopy",
"in": "body",
"required": true,
"description": "Request object to copy the Report Text Configuration from Source Property to Destination Properties.",
"schema": {
"allOf": [
{
"$ref": "#/definitions/reportTextConfigurationsCopy"
}
]
}
},
{
"$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/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": [
"Report"
]
}
},
"/reports": {
"get": {
"summary": "Return reports.",
"description": "Use this API to return reports based on search criteria such as excludeGroup, includeInternalReports, includeRnAReports, includeUnpublished, includeWatermarkDetails, limit, multiPropertyOnly, protectedReportParam, scheduled, name, group, hotel, id, idContext, type. <p><strong>OperationId:</strong>getReports</p>",
"operationId": "getReports",
"parameters": [
{
"name": "excludeGroup",
"minLength": 0,
"maxLength": 2000,
"in": "query",
"required": false,
"description": "Indicates whether a report group should be excluded",
"type": "string"
},
{
"name": "includeInternalReports",
"in": "query",
"required": false,
"description": "Indicates whether sample internal reports are to be included",
"type": "boolean"
},
{
"name": "includeRnAReports",
"in": "query",
"required": false,
"description": "Indicates whether RnA reports are to be included",
"type": "boolean"
},
{
"name": "includeUnpublished",
"in": "query",
"required": false,
"description": "Indicates whether protected reports should be included",
"type": "boolean"
},
{
"name": "includeWatermarkDetails",
"in": "query",
"required": false,
"description": "Indicates whether the watermark details is to be populated. This is needed only for the configuration and not for the actual execution.",
"type": "boolean"
},
{
"name": "limit",
"in": "query",
"required": false,
"description": "Indicates maximum number of records a Web Service should return.",
"type": "integer"
},
{
"name": "multiPropertyOnly",
"in": "query",
"required": false,
"description": "Indicates whether the result set should only include multi-property reports.",
"type": "boolean"
},
{
"name": "protectedReportParam",
"in": "query",
"required": false,
"description": "Indicates whether protected reports should be included",
"type": "boolean"
},
{
"name": "scheduled",
"in": "query",
"required": false,
"description": "Indicates that only reports that can be scheduled are included",
"type": "boolean"
},
{
"name": "name",
"minLength": 0,
"maxLength": 2000,
"in": "query",
"required": false,
"description": "Partial report name or description to search.",
"type": "string"
},
{
"name": "group",
"minLength": 0,
"maxLength": 2000,
"in": "query",
"required": false,
"description": "Report group to limit search.",
"type": "string"
},
{
"name": "hotel",
"minLength": 0,
"maxLength": 2000,
"in": "query",
"required": false,
"description": "Hotel code to search reports for.",
"type": "string"
},
{
"name": "id",
"minLength": 0,
"maxLength": 80,
"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": "idContext",
"minLength": 0,
"maxLength": 80,
"in": "query",
"required": false,
"description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
"type": "string"
},
{
"name": "type",
"minLength": 0,
"maxLength": 80,
"in": "query",
"required": false,
"description": "A
# --- truncated at 32 KB (94 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle-hospitality/refs/heads/main/openapi/oracle-hospitality-property-v1-repcfg.json