applyDisplayGroupControl

POST

/api/v1/screen-groups/{id}/display-control

curl --request POST \
  --url https://example.com/api/v1/screen-groups/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/display-control \
  --header 'Content-Type: application/json' \
  --header 'X-CSRF-Token: example' \
  --data '{ "commandType": "display_power_on", "fingerprint": "example" }'

Apply display group control. Requires an authenticated dashboard user.

Parameters

Path Parameters

id

required

string format: uuid

Header Parameters

X-CSRF-Token

required

string

Request Body^required

Media typeapplication/json

object

commandType

required

string

Allowed values: display_power_on display_power_off display_mute display_unmute

fingerprint

required

string

>= 64 characters <= 64 characters

Responses

202

Typed commands queued for eligible members

Media typeapplication/json

object

data

required

object

groupId

required

string format: uuid

commandType

required

string

Allowed values: display_power_on display_power_off display_mute display_unmute

selectedCount

required

integer

supportedCount

required

integer

queuedCount

required

integer

failedCount

required

integer

unsupportedCount

required

integer

results

required

Array<object>

object

screenId

required

string format: uuid

name

required

string

state

required

string

Allowed values: queued skipped failed

reason

string

id

string format: uuid

Example

{
  "data": {
    "commandType": "display_power_on",
    "results": [
      {
        "state": "queued"
      }
    ]
  }
}

409

Capability preview is stale

422

Unsupported group action