map

Get the map configuration restrictions

Returns the restrictions of the home appliance regarding maps, rooms and zones, e.g. which properties are supported and which values are allowed.

get/homeappliances/{haId}/map/config/restrictions

Request

  • Base URL: https://api.home-connect.com/api
  • URL: https://api.home-connect.com/api/homeappliances/{haId}/map/config/restrictions
  • Auth: OAuth 2 (authorization code, authorization URL https://api.home-connect.com/security/oauth/authorize, token URL https://api.home-connect.com/security/oauth/token, scopes: CleaningRobot-Map)

Response

Configuration restrictions of the home appliance

room.floorType.supportedboolean

Signals support for property floorType of resource /map/maps/{mapId}/rooms/{roomId}. If not present, it is assumed the appliance does not support saving floor types.

room.floorType.allowedValuesstring[]

List of valid values for property floorType of resource /map/maps/{mapId}/rooms/{roomId}. If not present, it is assumed the appliance imposes no restrictions on valid values.

room.roomType.allowedValuesstring[]

List of valid values for property roomType of resource /map/maps/{mapId}/rooms/{roomId}. If not present, it is assumed the appliance imposes no restrictions on valid values.

maps.isSaved.maxCountinteger

Maximum number of entries in resource /map/maps with flag isSaved == true. If not present, it is assumed the appliance imposes no restrictions on the number of saved maps.

maps.editableboolean

Controls if editing maps is allowed at this moment.

maps.rooms.editableboolean

Controls if editing rooms is allowed at this moment. If no value is given, it follows the value of maps.editable.

maps.rooms.splitmerge.editableboolean

Controls if splitting or merging rooms is allowed at this moment. If no value is given, it follows the value of maps.rooms.editable.

maps.zones.maxCountinteger

Maximum number of entries in resource /map/maps/{mapId}/zones. If not present, 'null' or '0', the appliance does not support saved zones. Unlimited saved zones are signalled with '-1'.

maps.zones.editableboolean

Controls if creating, editing or deleting zones is allowed at this moment. If no value is given, it follows the value of maps.editable.

Changes

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