Skip to content

This page describes Revolution release 3.1.0.

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

Updates an existing misc item in the system and returns it as stored.


PUT
/api/v1/{tenantId}/simulator/misc-items

Only users set a video camera’s camera.feedUrl, camera.feedType, camera.username and camera.password: a plugin or AI client must leave camera.feedUrl and camera.feedType unchanged and camera.username and camera.password out, or the write is refused with 400 CAMERA_FEED_NOT_ALLOWED. A left-out camera.username or camera.password keeps the stored one. A camera moved to an Exacq address where another camera has a login takes that login. The answer to a plugin or AI client leaves camera.username and camera.password out.

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

tenantId
required
string
object
miscItem
object
id
string
nullable
simulatorPosition
Array<number>
nullable >= 6 items <= 6 items
isTransformLocked

While true, an update that moves the misc item is refused with TRANSFORM_LOCKED. Leave it out to keep the stored lock; a user or plugin may send false in the same update to unlock and move, and an AI client’s false is refused with TRANSFORM_UNLOCK_NOT_ALLOWED.

boolean
nullable
modelAlias
required
string
name
string
nullable
camera

Null on every misc item whose modelAlias is not ‘videoCamera’.

object
description
string
nullable <= 500 characters
feedUrl
string
nullable <= 2048 characters
horizontalFovDeg
required
number format: double
>= 10 <= 150
aspectRatio
required
number format: double
>= 0.25 <= 4
feedType

How the feed is read; null reads it from the form of feedUrl.

string
nullable
Allowed values: exacq jpegSnapshot mjpeg hls whep
username

The feed’s shared user name, set by users only. A plugin or AI client is never given it: leave it out or null to keep it, else CAMERA_FEED_NOT_ALLOWED.

string
nullable <= 256 characters
password

The feed’s password. A plugin or AI client is never given it: leave it out or null to keep it, else CAMERA_FEED_NOT_ALLOWED.

string
nullable <= 256 characters
modelAlias
string
Allowed values: airCompressor bottle human miniTable pc placeholderBox videoCamera

OK

object
miscItem
object
id
string
nullable
simulatorPosition
Array<number>
nullable >= 6 items <= 6 items
isTransformLocked

While true, an update that moves the misc item is refused with TRANSFORM_LOCKED. Leave it out to keep the stored lock; a user or plugin may send false in the same update to unlock and move, and an AI client’s false is refused with TRANSFORM_UNLOCK_NOT_ALLOWED.

boolean
nullable
modelAlias
required
string
name
string
nullable
camera

Null on every misc item whose modelAlias is not ‘videoCamera’.

object
description
string
nullable <= 500 characters
feedUrl
string
nullable <= 2048 characters
horizontalFovDeg
required
number format: double
>= 10 <= 150
aspectRatio
required
number format: double
>= 0.25 <= 4
feedType

How the feed is read; null reads it from the form of feedUrl.

string
nullable
Allowed values: exacq jpegSnapshot mjpeg hls whep
username

The feed’s shared user name, set by users only. A plugin or AI client is never given it: leave it out or null to keep it, else CAMERA_FEED_NOT_ALLOWED.

string
nullable <= 256 characters
password

The feed’s password. A plugin or AI client is never given it: leave it out or null to keep it, else CAMERA_FEED_NOT_ALLOWED.

string
nullable <= 256 characters

Bad Request

object
message
string
nullable
code
string
nullable
retryable
boolean
nullable
field
string
nullable
data
nullable

Not Found

object
message
string
nullable
code
string
nullable
retryable
boolean
nullable
field
string
nullable
data
nullable

Too Many Requests

object
message
string
nullable
code
string
nullable
retryable
boolean
nullable
field
string
nullable
data
nullable

Service Unavailable

object
message
string
nullable
code
string
nullable
retryable
boolean
nullable
field
string
nullable
data
nullable

Gateway Timeout

object
message
string
nullable
code
string
nullable
retryable
boolean
nullable
field
string
nullable
data
nullable