Search these docs, or ask Revo a question — answers link the pages they came from.

Creates a new framework in the system.

POST

/api/v1/{tenantId}/simulator/framework

Plugin API access: this operation accepts a plugin JWT (PluginBearer) for its own tenant.

Authorizations

PluginBearer

Parameters

Path Parameters

tenantId

required

string

Request Body

object

framework

object

string

nullable

simulatorPosition

Array<number>

nullable

isTransformLocked

While true, an update that moves the framework or changes its size, offset, bottom shelf or bottom frame is refused with TRANSFORM_LOCKED. Leave it out to keep the stored lock; send false in the same update to unlock and move.

boolean

nullable

definitionKey

string

nullable

standardParams

object

width

number format: double

height

number format: double

length

number format: double

offset

object

number format: double

shelfConfig

object

positions

string

nullable

isBottomShelfPresent

boolean

isBottomFramePresent

boolean

nullable

supports

object

mode

string

nullable

count

integer format: int32

nullable

positions

string

nullable

preloadGenericModels

Array<string>

nullable

type

string

nullable

transformMatrix

Deprecated: read simulatorPosition instead. The 4x4 transform of simulatorPosition, column-major as three.js Matrix4.elements, for clients that still place a framework by its matrix. Read-only: a create or update request may send it back as read, but one whose matrix does not match its simulatorPosition is refused with 400 OUTDATED_CLIENT, so move a framework by simulatorPosition alone. Absent when the framework has no valid simulatorPosition.

Array<number>

Responses

string

nullable