List of all embedded resources that should be expanded in the response. Possible values are: property, unitGroup, connectedUnits. All other values will be silently ignored.
pageSizeinteger
Page size. If this is not set or not positive, the pageNumber is ignored and all items are returned.
conditionstring
Return units with a specific condition
isOccupiedboolean
Return only occupied or vacant units
pageNumberinteger
Page number, 1-based. Default value is 1 (if this is not set or not positive). Results in 204 if there are no items on that page.
propertyIdstring
Return units for specific property
textSearchstring
This will filter all units where the provided text is contained in the unit name. The search is case insensitive.
unitGroupIdstring
Return units for the specific unit group - <b>DEPRECATED: This property will be removed 20.04.2022. Use `UnitGroupIds` instead</b>
unitGroupIdsarray
Return units with the specific unit groups
maintenanceTypestring
Return units with the specific maintenance type
unitAttributeIdsarray
Return units with the specific unit attributes
Observable output
data
Required
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulboolean
Required
Whether or not the action execution was successful or not