Sign in
Maintenance

Get a specific maintenance

Get a specific maintenance by ID.<br>You must have at least one of these scopes: 'maintenances.read, maintenances.manage'.

get/operations/v1/maintenances/{id}

Path parameters

idstring required

The ID of the maintenance.

Query parameters

expandstring[]

List of all embedded resources that should be expanded in the response. Possible values are: unit. All other values will be silently ignored.

Response

Return all the data for the maintenance.

idstring required

The id for the scheduled maintenance

fromstring date-time required

Date and time the scheduled maintenance window starts<br />A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

tostring date-time required

Date and time the scheduled maintenance window ends<br />A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

type'OutOfService' | 'OutOfOrder' | 'OutOfInventory' required

The type of maintenance that is planned for the unit. A small repair (OutOfService), a bigger disfunction that does not allow to sell the unit (OutOfOrder) or is it even under construction and should reduce the house count (OutOfInventory)

descriptionstring nullable

The description text for the maintenance

Example response

{
  "id": "APALEO.API.MODULES.COMMON.MODELS.REFERENCES.EMBEDDEDUNITMODEL-SGHZD",
  "unit": {
    "id": "MUC-JQI",
    "name": "A.102",
    "description": "Double room",
    "unitGroupId": "MUC-DBL"
  },
  "from": "2026-09-01T13:48:09+02:00",
  "to": "2026-09-03T13:48:09+02:00",
  "type": "OutOfService",
  "description": "The remote control for the TV needs to be replaced."
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.