Objects

Update room configuration

Update the room configuration: room type, outline, height, floor tile grid and floor plan backdrop. Passive elements and the derived area are read-only here; passive elements are managed through /v1/objects/{object-id}/floor-plan/passive-elements. Merge-patch semantics: any subset of fields can be sent; omitted fields are left unchanged.

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

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

Path parameters

object-idinteger required

Request body

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.

Response

Room configuration updated; full updated object returned.

aliasstring

Object alias

categoryinteger

Object category ID

class'AccessPoint' | 'AgentPolicyLogParser' | 'Asset' | 'AssetGroup' | 'AssetRoot' | 'BusinessService' | 'BusinessServiceProto' | 'BusinessServiceRoot' | 'Chassis' | 'Cluster' | 'Condition' | 'Container' | 'CoolingZone' | 'Dashboard' | 'DashboardGroup' | 'DashboardRoot' | 'Facility' | 'Generic' | 'Interface' | 'MobileDevice' | 'Network' | 'NetworkMap' | 'NetworkMapGroup' | 'NetworkMapRoot' | 'NetworkService' | 'Node' | 'NodeLink' | 'PowerDomain' | 'Rack' | 'Report' | 'ReportGroup' | 'ReportRoot' | 'Room' | 'Sensor' | 'ServiceCheck' | 'ServiceRoot' | 'Subnet' | 'Template' | 'TemplateGroup' | 'TemplateRoot' | 'VPNConnector' | 'Zone'
guidstring uuid

Object GUID

idinteger

Object ID

namestring

Object name

timestampstring date-time

Object last change timestamp

status0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8

Changes