Sign in
Objects

Get room configuration

Return the room configuration (the same shape accepted by the matching PATCH).

This property group applies to Room objects only; requesting it for any other object class returns 400.

get/v1/objects/{object-id}/room

Path parameters

object-idinteger required

Response

Room configuration.

roomType'COMPUTER_ROOM' | 'ELECTRICAL' | 'MECHANICAL' | 'TELECOM' | 'OTHER'

Kind of room.

areanumber

Floor area in square metres, derived from the outline.

heightinteger

Room height; 0 means undeclared.

gridOriginXinteger

X coordinate of floor tile grid origin.

gridOriginYinteger

Y coordinate of floor tile grid origin.

gridTileSizeinteger

Floor tile size; 0 means no grid.

gridLabels'NONE' | 'LETTERS_NUMBERS' | 'NUMBERS_NUMBERS'

Floor tile label scheme (columns x rows).

backgroundImagestring uuid nullable

Image library UUID of floor plan backdrop; null means no backdrop (send null to clear).

backgroundScaleinteger

Backdrop calibration in micrometres per image pixel.

backgroundXinteger

X offset of the backdrop in room coordinates.

backgroundYinteger

Y offset of the backdrop in room coordinates.

Changes

Changed in 1 of the 115 revisions of this API.1