Sign in
Objects

Get room floor plan

Retrieve the complete floor plan of a room in a single call: room geometry (outline, derived area, tile grid, backdrop), passive elements, and all racks located in the room with their footprint, placement and status. Racks are filtered by the requesting user's read access. Racks with placed set to false have not been positioned on the plan yet and their coordinates should be ignored.

get/v1/objects/{object-id}/floor-plan

Path parameters

object-idinteger required

Room object ID

Response

Room floor plan

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.

roomIdinteger

Room object ID

namestring

Room object name

Changes