APIs to cater for Housekeeping functionality in OPERA Cloud. Housekeeping enables you to schedule daily room cleaning, maintenance, and housekeeping staff activities. It provides information on room status, out of order/out of service rooms, and forecasting. Compatible with OPERA Cloud release 26.2.0.0. 60 operation(s) documented; base path /hsk/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 Housekeeping Service API",
"description": "APIs to cater for Housekeeping functionality in OPERA Cloud. <br /><br />Housekeeping enables you to schedule daily room cleaning, maintenance, and housekeeping staff activities. It provides information on room status, out of order/out of service rooms, and forecasting.<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": "/hsk/v1",
"produces": [
"application/json"
],
"paths": {
"/hotels/{hotelId}/attendants/houseKeepingTasks": {
"get": {
"summary": "Get the housekeeping attendants schedule",
"description": "This API will allow you to get the housekeeping attendants schedule. <p><strong>OperationId:</strong>getHousekeepingAttendantsSchedule</p> <p>This API allows a time span of <strong>30</strong> days.</p>",
"operationId": "getHousekeepingAttendantsSchedule",
"parameters": [
{
"name": "hotelId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000,
"description": ""
},
{
"name": "scheduleStartDate",
"in": "query",
"required": true,
"description": "The starting value of the date range.",
"type": "string",
"format": "date"
},
{
"name": "scheduleEndDate",
"in": "query",
"required": false,
"description": "The ending value of the date range.",
"type": "string",
"format": "date"
},
{
"$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 fetching the attendants schedule.",
"schema": {
"$ref": "#/definitions/attendantSchedule"
}
},
"204": {
"description": "HousekeepingAttendantsSchedule 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": [
"Housekeeping"
]
},
"delete": {
"summary": "Delete housekeeping attendant schedule",
"description": "This API will allow you to delete housekeeping attendant schedule. <p><strong>OperationId:</strong>deleteHousekeepingAttendantSchedule</p>",
"operationId": "deleteHousekeepingAttendantSchedule",
"parameters": [
{
"name": "hotelId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000,
"description": ""
},
{
"name": "scheduleDate",
"in": "query",
"required": true,
"description": "Schedule date of attendants' assignment. Used when attendants to scheduled are of the same date.",
"type": "string",
"format": "date"
},
{
"name": "attendantId",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "ID of the attendant.",
"items": {
"type": "string"
},
"required": true
},
{
"$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": [
"Housekeeping"
]
}
},
"/hotels/{hotelId}/autoTaskSheets": {
"post": {
"summary": "Auto generate the task sheets",
"description": "This API will allow you to Auto generate the task sheets. <p><strong>OperationId:</strong>autoGenerateTaskSheets</p>",
"operationId": "autoGenerateTaskSheets",
"parameters": [
{
"name": "hotelId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000,
"description": ""
},
{
"name": "taskSheets",
"in": "body",
"required": true,
"description": "Request for generating housekeeping Task Sheets automatically. To generate task sheets automatically the minimum required criteria is the Task Date, Task Code, Number of Attendants/Tasksheets required and the Room Statuses. Based on the criteria defined, task sheets will be created and the rooms will be assigned to the Tasksheets. Example: if the criteria defines that Dirty room status to be used to generate 5 sheets, then only those rooms which have the status = Dirty will be used and will be assigned to the 5 sheets.",
"schema": {
"allOf": [
{
"$ref": "#/definitions/taskSheets"
}
]
}
},
{
"$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": [
"Housekeeping"
]
}
},
"/hotels/{hotelId}/conditions": {
"get": {
"summary": "Get rooms condition",
"description": "This API will allow you to get a list of rooms that have a condition set. <p><strong>OperationId:</strong>getRoomConditions</p>",
"operationId": "getRoomConditions",
"parameters": [
{
"name": "hotelId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000,
"description": ""
},
{
"name": "roomConditionsOnly",
"in": "query",
"required": false,
"description": "Include rooms with conditions only.",
"type": "boolean"
},
{
"name": "roomWithoutConditionsOnly",
"in": "query",
"required": false,
"description": "Include rooms without conditions only.",
"type": "boolean"
},
{
"name": "room",
"in": "query",
"required": false,
"description": "Identifier of the room.",
"type": "string"
},
{
"name": "fromRoomNumber",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "toRoomNumber",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "roomConditions",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"items": {
"type": "string"
},
"required": false
},
{
"name": "roomTypes",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"items": {
"type": "string"
},
"required": false
},
{
"name": "roomClasses",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"items": {
"type": "string"
},
"required": false
},
{
"name": "frontOfficeRoomStatus",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Simple type for front office room status instructions to be used in requests for fetching housekeeping rooms. Valid values are Vacant and Occupied.",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"Vacant",
"Occupied"
]
},
"required": false
},
{
"name": "reservationStatuses",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"items": {
"type": "string"
},
"required": false
},
{
"name": "roomAssignmentStatus",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"Assigned",
"Unassigned"
]
},
"required": false
},
{
"name": "floors",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"items": {
"type": "string"
},
"required": false
},
{
"name": "roomFeatures",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"items": {
"type": "string"
},
"required": false
},
{
"name": "amSections",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"items": {
"type": "string"
},
"required": false
},
{
"name": "pmSections",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"items": {
"type": "string"
},
"required": false
},
{
"name": "buildings",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"items": {
"type": "string"
},
"required": false
},
{
"name": "housekeepingRoomStatus",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"Clean",
"Dirty",
"Pickup",
"Inspected",
"OutOfOrder",
"OutOfService"
]
},
"required": false
},
{
"name": "roomParityStatus",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Simple type for room parity instructions to be used in requests for fetching housekeeping rooms. Valid status values are Odd and Even.",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"Odd",
"Even"
]
},
"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 element for fetching room conditions.",
"schema": {
"$ref": "#/definitions/rooms"
}
},
"204": {
"description": "RoomConditions 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": [
"Housekeeping"
]
},
"put": {
"summary": "Set rooms condition",
"description": "This API will allow you to set, change, or delete a condition on rooms. A condition is used to designate rooms that are available for show, set aside for special housekeeping attention, or are to be treated differently for any other reason. <p><strong>OperationId:</strong>setRoomCondition</p>",
"operationId": "setRoomCondition",
"parameters": [
{
"name": "hotelId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000,
"description": ""
},
{
"name": "roomCondition",
"in": "body",
"required": true,
"description": "Request element for setting room condition.",
"schema": {
"allOf": [
{
"$ref": "#/definitions/roomCondition"
}
]
}
},
{
"$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/roomConditionRequestStatus"
}
},
"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": [
"Housekeeping"
]
}
},
"/hotels/{hotelId}/forecastTaskSchedules": {
"get": {
"summary": "Get facility forecast",
"description": "This API will allow you to get facility forecast for Housekeeping attendants and tasks for a current or future start date . <p><strong>OperationId:</strong>getFacilityForecast</p> <p>This API allows a time span of <strong>30</strong> days.</p>",
"operationId": "getFacilityForecast",
"parameters": [
{
"name": "hotelId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000,
"description": ""
},
{
"name": "startDate",
"in": "query",
"required": false,
"type": "string",
"format": "date"
},
{
"name": "endDate",
"in": "query",
"required": false,
"type": "string",
"format": "date"
},
{
"name": "duration",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "Codes",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"items": {
"type": "string"
},
"required": false
},
{
"name": "usePriority",
"in": "query",
"required": false,
"description": ".",
"type": "boolean"
},
{
"name": "includeCreditRules",
"in": "query",
"required": false,
"description": "Selecting to Include Credit Rules will include Item inventory and Specials credits on reservations to the Estimated Total Credits calculation.",
"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 element for the fetched facility forecast.",
"schema": {
"$ref": "#/definitions/facilityForecast"
}
},
"204": {
"description": "FacilityForecast 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": [
"Housekeeping"
]
}
},
"/hotels/{hotelId}/houseKeepingTasks/{taskCodesBreakOutId}": {
"delete": {
"summary": "Delete all the hotel task sheets for an existing Task Sheet Set.",
"description": "Use this API to delete all task sheets for an existing task sheet set for a specific property. Task Sheet Sets can be used to break out the rooms to be cleaned by the housekeeping attendants.<p><strong>OperationId:</strong>deleteHouseKeepingTaskSheets</p>",
"operationId": "deleteHouseKeepingTaskSheets",
"parameters": [
{
"name": "hotelId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000,
"description": "Indicates Unique Hotel Code for which the task sheets will be deleted."
},
{
"name": "taskCodesBreakOutId",
"in": "path",
"required": true,
"description": "Indicates Unique breakout ID for which the task sheets will be deleted.",
"type": "string",
"minLength": 1,
"maxLength": 2000
},
{
"$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 deleted resource"
}
},
"description": "Additional warnings about the operation.",
"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": [
"Housekeeping"
]
}
},
"/hotels/{hotelId}/houseKeepingtasks": {
"get": {
"summary": "Get the existing task sheets",
"description": "This API will allow you to get the existing task sheets. <p><strong>OperationId:</strong>getHouseKeepingTasks</p>",
"operationId": "getHouseKeepingTasks",
"parameters": [
{
"name": "hotelId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000,
"description": ""
},
{
"name": "taskDate",
"in": "query",
"required": true,
"description": "Date for which the Task Assignment information is required.",
"type": "string",
"format": "date"
},
{
"name": "attendantInRoomOnly",
"in": "query",
"required": false,
"description": "Query only rooms with attendant working in them.",
"type": "boolean"
},
{
"name": "generateCleaningSequence",
"in": "query",
"required": false,
"description": "Setting this to true will generate a sequence based on the current condition of the room for cleaning. This sequence would be the same sequence with which the Task Companion works.",
"type": "boolean"
},
{
"name": "includeReservationInfo",
"in": "
# --- truncated at 32 KB (692 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle-hospitality/refs/heads/main/openapi/oracle-hospitality-property-v1-hsk.json