Returns all of the framework in the system.

GET

/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

Responses

200

OK

object

frameworks

Array<object>

nullable

object

id

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

x

number format: double

y

number format: double

z

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>

400

Bad Request

object

message

string

nullable

code

string

nullable

429

Too Many Requests

object

message

string

nullable

code

string

nullable

503

Service Unavailable

object

message

string

nullable

code

string

nullable

504

Gateway Timeout

object

message

string

nullable

code

string

nullable