Oracle Hospitality Housekeeping API

These APIs allows for retrieving and managing a room's housekeeping data and front office status, for example update room 101 to be Out Of Order. Additionally, you can view room discrepancies between housekeeping and front office statuses, view and update task sheets and create a room service request.

Operations 60

GET /hotels/{hotelId}/attendants/houseKeepingTasks Get the housekeeping attendants schedule #
DELETE /hotels/{hotelId}/attendants/houseKeepingTasks Delete housekeeping attendant schedule #
POST /hotels/{hotelId}/autoTaskSheets Auto generate the task sheets #
GET /hotels/{hotelId}/conditions Get rooms condition #
PUT /hotels/{hotelId}/conditions Set rooms condition #
GET /hotels/{hotelId}/forecastTaskSchedules Get facility forecast #
DELETE /hotels/{hotelId}/houseKeepingTasks/{taskCodesBreakOutId} Delete all the hotel task sheets for an existing Task Sheet Set. #
GET /hotels/{hotelId}/houseKeepingtasks Get the existing task sheets #
GET /hotels/{hotelId}/housekeepingDiscrepancies Get hotel housekeeping discrepant rooms #
GET /hotels/{hotelId}/housekeepingOverview Get housekeeping rooms overview #
DELETE /hotels/{hotelId}/maintenances/{mainteananceId} Delete the maintenances for rooms #
PUT /hotels/{hotelId}/maintenances/{mainteananceId}/resolve Resolve maintenances for rooms #
PUT /hotels/{hotelId}/maintenances/{mainteananceId}/unResolve unResolve the maintenances for rooms #
PUT /hotels/{hotelId}/moveTaskRooms Move the task rooms #
GET /hotels/{hotelId}/reservations/{reservationId}/houseKeepingNotes Get the guest housekeeping instructions #
PUT /hotels/{hotelId}/reservations/{reservationId}/houseKeepingNotes Set guest housekeeping instructions #
GET /hotels/{hotelId}/reservations/{reservationId}/houseKeepingTaskSchedules Get reservation housekeeping schedule #
POST /hotels/{hotelId}/reservations/{reservationId}/houseKeepingTaskSchedules Create reservation housekeeping tasks #
PUT /hotels/{hotelId}/reservations/{reservationId}/houseKeepingTaskSchedules Update reservation housekeeping tasks #
DELETE /hotels/{hotelId}/reservations/{reservationId}/houseKeepingTaskSchedules Delete reservation housekeeping task #
PUT /hotels/{hotelId}/reservations/{reservationId}/houseKeepingTaskSchedules/reset Reset reservation housekeeping schedule #
PUT /hotels/{hotelId}/reservations/{reservationId}/houseKeepingTaskSchedules/shift Shift reservation housekeeping schedule #
DELETE /hotels/{hotelId}/rooms/cleaningPriority Delete room cleaning priority #
POST /hotels/{hotelId}/rooms/maintenanceCodes/{maintenanceCode} Create maintenances for rooms #
GET /hotels/{hotelId}/rooms/maintenances Get the maintenance rooms #
GET /hotels/{hotelId}/rooms/outOfOrderRooms Get Out of Order Rooms #
PUT /hotels/{hotelId}/rooms/outOfOrderRooms Complete rooms Out Of Order #
POST /hotels/{hotelId}/rooms/outOfOrderRooms Set multiple rooms to Out Of Order #
PUT /hotels/{hotelId}/rooms/outOfServiceRooms Complete Rooms Out of Service #
GET /hotels/{hotelId}/rooms/outOfServiceRooms Get Out of Service Rooms #
POST /hotels/{hotelId}/rooms/outOfServiceRooms Set multiple rooms to Out Of Service #
PUT /hotels/{hotelId}/rooms/status Update Housekeeping Room Status #
PUT /hotels/{hotelId}/rooms/{roomId}/cleaningPriority Set the room cleaning priority #
PUT /hotels/{hotelId}/rooms/{roomId}/maintenances/{maintenanceId} Change maintenances for rooms #
PUT /hotels/{hotelId}/rooms/{roomId}/sheets/{sheetNumber} Cancel servicing task room #
PUT /hotels/{hotelId}/rooms/{roomId}/sheets/{sheetNumber}/complete Complete servicing task room #
PUT /hotels/{hotelId}/rooms/{roomId}/sheets/{sheetNumber}/skip Skip servicing task room #
PUT /hotels/{hotelId}/rooms/{roomId}/sheets/{sheetNumber}/start Start servicing task room #
POST /hotels/{hotelId}/schedules/houseKeepingTasks Create housekeeping attendant schedule #
PUT /hotels/{hotelId}/serviceRequests Set the Guest housekeeping service requests #
GET /hotels/{hotelId}/sheets/{sheetNumber} Get task companion #
PUT /hotels/{hotelId}/taskSheet/{taskSequenceNumber}/complete Complete a task sheet #
PUT /hotels/{hotelId}/taskSheet/{taskSequenceNumber}/reopen Reopen a task sheet #
PUT /hotels/{hotelId}/taskSheetSet/{taskCodesBreakOutId}/complete Complete all the hotel's task sheets for an existing Task Sheet Set. #
PUT /hotels/{hotelId}/taskSheetSet/{taskCodesBreakOutId}/reopen Reopen all the hotel's task sheets for an existing Task Sheet Set. #
GET /hotels/{hotelId}/taskSheetTemplates Get the task sheet templates #
PUT /hotels/{hotelId}/taskSheetTemplates/{taskSheetTemplateCode} Change the task sheet templates #
DELETE /hotels/{hotelId}/taskSheetTemplates/{taskSheetTemplateCode} Delete task sheet templates #
POST /hotels/{hotelId}/taskSheets Create the task sheet #
PUT /hotels/{hotelId}/taskSheets Change the task sheet #
DELETE /hotels/{hotelId}/taskSheets Delete the task sheet #
PUT /hotels/{hotelId}/taskSheets/rooms Change the task sheet rooms #
DELETE /hotels/{hotelId}/taskSheets/rooms Delete task sheet rooms #
POST /hotels/{hotelId}/taskSheets/rooms Create the task sheet rooms #
PUT /hotels/{hotelId}/taskSheets/{sheetNumber}/lock Lock the task sheet #
PUT /hotels/{hotelId}/taskSheets/{sheetNumber}/unlock Unlock the task sheet #
PUT /hotels/{hotelId}/taskSheets/{taskSheetNumber}/end End the service break #
PUT /hotels/{hotelId}/taskSheets/{taskSheetNumber}/start Start the service break #
POST /hotels/{hotelId}/taskSheets/{toTaskSequenceNo}/merge Merge task sheet #
GET /services/houseKeeping/status ping the house keeping service #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/oracle-hospitality-housekeeping-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

oracle-hospitality-housekeeping-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: OPERA Cloud Service Housekeeping 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
servers:
- url: /hsk/v1
tags:
- name: Housekeeping
  description: These APIs allows for retrieving and managing a room's housekeeping data and front office status, for example update room 101 to be Out Of Order.  Additionally, you can view room discrepancies between housekeeping and front office statuses, view and update task sheets and create a room service request.
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
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: scheduleStartDate
        in: query
        required: true
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: scheduleEndDate
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response for fetching the attendants schedule.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/attendantSchedule'
        '204':
          description: HousekeepingAttendantsSchedule not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      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
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: scheduleDate
        in: query
        required: true
        description: Schedule date of attendants' assignment. Used when attendants to scheduled are of the same date.
        schema:
          type: string
          format: date
      - name: attendantId
        in: query
        description: ID of the attendant.
        required: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: HATEOAS links which help the consumer to navigate to resources
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      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
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '201':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: HATEOAS links which help the consumer to navigate to resources
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/taskSheets'
        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.'
        required: true
  /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
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: roomConditionsOnly
        in: query
        required: false
        description: Include rooms with conditions only.
        schema:
          type: boolean
      - name: roomWithoutConditionsOnly
        in: query
        required: false
        description: Include rooms without conditions only.
        schema:
          type: boolean
      - name: room
        in: query
        required: false
        description: Identifier of the room.
        schema:
          type: string
      - name: fromRoomNumber
        in: query
        required: false
        schema:
          type: string
      - name: toRoomNumber
        in: query
        required: false
        schema:
          type: string
      - name: roomConditions
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: roomTypes
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: roomClasses
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: frontOfficeRoomStatus
        in: query
        description: Simple type for front office room status instructions to be used in requests for fetching housekeeping rooms. Valid values are Vacant and Occupied.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Vacant
            - Occupied
          uniqueItems: true
      - name: reservationStatuses
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: roomAssignmentStatus
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Assigned
            - Unassigned
          uniqueItems: true
      - name: floors
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: roomFeatures
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: amSections
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: pmSections
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: buildings
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: housekeepingRoomStatus
        in: query
        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.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Clean
            - Dirty
            - Pickup
            - Inspected
            - OutOfOrder
            - OutOfService
          uniqueItems: true
      - name: roomParityStatus
        in: query
        description: Simple type for room parity instructions to be used in requests for fetching housekeeping rooms. Valid status values are Odd and Even.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Odd
            - Even
          uniqueItems: true
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response element for fetching room conditions.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/rooms'
        '204':
          description: RoomConditions not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      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
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: Response Body.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/roomConditionRequestStatus'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/roomCondition'
        description: Request element for setting room condition.
        required: true
  /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
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: startDate
        in: query
        required: false
        schema:
          type: string
          format: date
      - name: endDate
        in: query
        required: false
        schema:
          type: string
          format: date
      - name: duration
        in: query
        required: false
        schema:
          type: string
      - name: Codes
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: usePriority
        in: query
        required: false
        description: .
        schema:
          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.
        schema:
          type: boolean
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response element for the fetched facility forecast.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/facilityForecast'
        '204':
          description: FacilityForecast not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      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
        description: Indicates Unique Hotel Code for which the task sheets will be deleted.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: taskCodesBreakOutId
        in: path
        required: true
        description: Indicates Unique breakout ID for which the task sheets will be deleted.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of deleted resource
              schema:
                type: string
          description: Additional warnings about the operation.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      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
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: taskDate
        in: query
        required: true
        description: Date for which the Task Assignment information is required.
        schema:
          type: string
          format: date
      - name: attendantInRoomOnly
        in: query
        required: false
        description: Query only rooms with attendant working in them.
        schema:
          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.
        schema:
          type: boolean
      - name: includeReservationInfo
        in: query
        required: false
        description: Setting this to true will include reservation information associated to the room.
        schema:
          type: boolean
      - name: includeComponentRoomsInfo
        in: query
        required: false
        description: Setting this to true will include component rooms information associated to the room.
        schema:
          type: boolean
      - name: includeTaskSheetDetails
        in: query
        required: false
        description: This will include room details for the Task Sheets. If summary information is only required, then this could be set to false. If a Task Sheet Number is included in the Search and this flag is set to true, then the details for that particular Task Sheet will be returned. For all other task sheets, the IncludeTaskSheetsSummary will determine if Summary details are required or not.
        schema:
          type: boolean
      - name: includeScheduledRoomDetails
        in: query
        required: false
        description: 'Set this to true to include reservation information associated with any scheduled room moves. Available when the Advanced Daily Details OPERA Control is active. Note: IncludeReservationInfo must also be set to true to fetch reservation details.'
        schema:
          type: boolean
      - name: includeTaskSheetsSummary
        in: query
        required: false
        description: 'Setting this to true, will return Summary information for the task sheets required. If a Task Sheet Number is included in the Search and IncludeTaskSheetDetails is set to false and IncludeTaskSheetsSummary is false, then only the Summary information for that particular task sheet will be returned. IncludeTaskSheetDetails = True, IncludeTaskSheetsSummary = True : includes all task sheets details and summary IncludeTaskSheetDetails = false, IncludeTaskSheetsSummary = True : includes only summary IncludeTaskSheetDetails = false, IncludeTaskSheetsSummary = false, Task Sheet No =null : no task sheet detail or summary for any of the tasksheets. Returns the Task Assignnment header. IncludeTaskSheetDetails = True, IncludeTaskSheetsSummary = True, Task Sheet No = XX : includes task sheets detail for XX and summary for others. IncludeTaskSheetDetails = false, IncludeTaskSheetsSummary = True, Task Sheet No = XX : includes summary for all including XX. IncludeTaskSheetDetails = false, IncludeTaskSheetsSummary = false, Task Sheet No = XX : includes summary for XX. No information for others.'
        schema:
          type: boolean
      - name: sortByCleaningSequence
        in: query
        required: false
        description: The rooms in the task sheet would be sorted with the cleaning sequence. The normal sort would be done based on the Default Sequence.
        schema:
          type: boolean
      - name: taskCodes
        in: query
        description: The Code for the task.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: taskHotelCodes
        in: query
        description: Property for which the Task Assignment information is required.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: taskSequences
        in: query
        description: Ordering sequence for display.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
      - name: taskDescriptions
        in: query
        description: Description of the Task Code.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: taskInstructions
        in: query
        description: Instructions for this Task Code.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: facilityDepartureTask
        in: query
        description: Indicates if this task code is the Departure Room Default Task to be scheduled on the departure date of the reservations. Defining a Departure Room Default Task is available when the 'Housekeeping Task Scheduling' OPERA Control is active.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: boolean
          maxItems: 4000
      - name: linenChange
        in: query
        description: Indicates if a linen change is necessary.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: boolean
      - name: taskCodesBreakOutId
        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.
        schema:
          type: string
      - name: taskCodesBreakOutIdContext
        in: query
        required: false
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        schema:
          type: string
      - name: taskCodesBreakOutIdType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: attendantId
        in: query
        required: false
        description: Attendant ID for which the Task Sheets are assigned.
        schema:
          type: string
      - name: taskSheetNumber
        in: query
        description: Specific Task Sheet number for which the information is required.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
          maxItems: 4000
      - name: housekeepingRoomStatus
        in: query
        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.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Clean
  

# --- truncated at 32 KB (424 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle-hospitality/refs/heads/main/openapi/oracle-hospitality-housekeeping-api-openapi.yml