previewBulkOperation

POST

/api/v1/screens/bulk/preview

curl --request POST \
  --url https://example.com/api/v1/screens/bulk/preview \
  --header 'Content-Type: application/json' \
  --data '{ "screenIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "action": "example", "playlistId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "layoutId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "enabled": true, "commandType": "example", "commandPayload": {} }'

Preview a fleet bulk operation without applying it: per-screen current and next state, whether each screen changes, and why a screen is blocked. Requires an Owner or Administrator with the write scope. Preview is a read of what would change, so it needs no CSRF token.

Request Body^required

Media typeapplication/json

object

screenIds

required

Array<string>

action

required

string

playlistId

string format: uuid

layoutId

string format: uuid

enabled

boolean

commandType

string

commandPayload

object

key

additional properties

any

Example^generated

{
  "screenIds": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ],
  "action": "example",
  "playlistId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "layoutId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "enabled": true,
  "commandType": "example",
  "commandPayload": {}
}

Responses

200

Bulk operation preview

Media typeapplication/json

object

data

required

What an operator confirms. The counts add up to the screen list and are never computed twice.

object

action

required

string

Allowed values: assign_playlist assign_layout clear_assignment set_enabled send_command

screens

required

Array<object>

One screen inside a bulk preview or result. Current and Next are written for a person to read, not parsed.

object

screenId

required

string format: uuid

name

required

string

location

string

current

required

string

next

required

string

changes

required

boolean

blocked

string

fromGroup

string

selected

required

boolean

applied

boolean

error

string

changeCount

required

integer

unchangedCount

required

integer

blockedCount

required

integer

groupAddedCount

required

integer

warnings

required

Array<string>

reversible

required

boolean

undoWindowMinutes

required

integer

Example

{
  "data": {
    "action": "assign_playlist"
  }
}

400

Invalid request body

401

Dashboard authentication required

403

Insufficient role or screen scope

422

Bulk operation invalid