Sign in
Objects

Update room passive element

Update an existing room passive element using merge-patch semantics: only fields present in the request are changed. The element type is immutable. Requires MODIFY access to the room object.

patch/v1/objects/{object-id}/floor-plan/passive-elements/{element-id}

Path parameters

object-idinteger required

Room object ID

element-idinteger required

Passive element ID

Request body

idinteger

Element ID (assigned by the server; ignored on input).

namestring
type'COLUMN' | 'WALL' | 'RAMP' | 'STAIRS' | 'DOOR' | 'OTHER'

Element type (default OTHER). Immutable after creation.

xinteger

X coordinate of footprint reference corner.

yinteger

Y coordinate of footprint reference corner.

rotationinteger

Rotation in degrees.

widthinteger
depthinteger

Response

Passive element updated

idinteger

Element ID (assigned by the server; ignored on input).

namestring
type'COLUMN' | 'WALL' | 'RAMP' | 'STAIRS' | 'DOOR' | 'OTHER'

Element type (default OTHER). Immutable after creation.

xinteger

X coordinate of footprint reference corner.

yinteger

Y coordinate of footprint reference corner.

rotationinteger

Rotation in degrees.

widthinteger
depthinteger

Changes

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