Live view management

Create live view

Create a new live view

post/v1/liveviews

Request

Request body

idstring required

The primary key of liveview

modelKey'liveview' required

The model key of the liveview

namestring required

The name of this live view.

isDefaultboolean required

Whether this live view is the default one for all viewers.

isGlobalboolean required

Whether this live view is global and available system-wide to all users

ownerstring required

The primary key of user

layoutnumber required

The number of slots this live view contains. Which as a consequence also affects the layout of the live view.

Example request

{
  "id": "66d025b301ebc903e80003ea",
  "owner": "66d025b301ebc903e80003ea",
  "layout": 9,
  "slots": [
    {
      "cameras": [
        "66d025b301ebc903e80003ea"
      ],
      "cycleInterval": 10
    }
  ]
}

Response

Success response

idstring required

The primary key of liveview

modelKey'liveview' required

The model key of the liveview

namestring required

The name of this live view.

isDefaultboolean required

Whether this live view is the default one for all viewers.

isGlobalboolean required

Whether this live view is global and available system-wide to all users

ownerstring required

The primary key of user

layoutnumber required

The number of slots this live view contains. Which as a consequence also affects the layout of the live view.

Example response

{
  "id": "66d025b301ebc903e80003ea",
  "owner": "66d025b301ebc903e80003ea",
  "layout": 9,
  "slots": [
    {
      "cameras": [
        "66d025b301ebc903e80003ea"
      ],
      "cycleInterval": 10
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.