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
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” tenantId
required
string
Request Body
Section titled “Request Body ”object
framework
object
id
string
simulatorPosition
Array<number>
isTransformLocked
boolean
definitionKey
string
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
isBottomShelfPresent
boolean
isBottomFramePresent
boolean
supports
object
mode
string
count
integer format: int32
positions
string
preloadGenericModels
Array<string>
type
string
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
Section titled “ Responses ”OK
object
Bad Request
object
message
string
code
string
Conflict
object
message
string
code
string
Too Many Requests
object
message
string
code
string
Service Unavailable
object
message
string
code
string
Gateway Timeout
object
message
string
code
string