map

Get all detected objects of a map

Returns all objects, e.g. stains or pets, which have been detected by the cleaning robot on the map identified by mapId.

get/homeappliances/{haId}/map/maps/{mapId}/cleaningStatus/objects

Request

  • Base URL: https://api.home-connect.com/api
  • URL: https://api.home-connect.com/api/homeappliances/{haId}/map/maps/{mapId}/cleaningStatus/objects
  • 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

List of detected objects

mapIdinteger required

The map identifier this object is part of.

objectIdinteger required

Identifier of this object.

type'Service.Map.ObjectType.Pet' | 'Service.Map.ObjectType.Stain' | 'Service.Map.ObjectType.Stain.Dry' | 'Service.Map.ObjectType.Stain.Heavy' | 'Service.Map.ObjectType.Stain.Light' | 'Service.Map.ObjectType.Stain.Mixed' | 'Service.Map.ObjectType.Stain.Particle' | 'Service.Map.ObjectType.Stain.Water' | 'Service.Map.ObjectType.Unspecified' required

The type of recognized object.

status'Shown' | 'HiddenOnce' | 'ShownButPreviouslyHidden' | 'HiddenPermanently' required

Display status of the recognized object.

confidencenumber required

Confidence score of the recognition (0.0 to 1.0)

imageIdstring

UUID identifier of an image of the detected object.

Changes

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