previewDisplayGroupControl

GET

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

const url = 'https://example.com/api/v1/screen-groups/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/display-control/preview?commandType=display_power_on';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/api/v1/screen-groups/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/display-control/preview?commandType=display_power_on'

Preview display group control. Requires an authenticated dashboard user.

Parameters

Path Parameters

required

string format: uuid

Query Parameters

commandType

required

string

Allowed values: display_power_on display_power_off display_mute display_unmute

Responses

200

Capability coverage and apply fingerprint

application/json

object

data

required

object

groupId

required

string format: uuid

groupName

required

string

commandType

required

string

Allowed values: display_power_on display_power_off display_mute display_unmute

selectedCount

required

integer

supportedCount

required

integer

unsupportedCount

required

integer

eligibleCount

required

integer

fingerprint

required

string

screens

required

Null for groups with no members; Studio reads an empty selection.

Array<object> | null

object

screenId

required

string format: uuid

name

required

string

provider

required

string

capabilities

required

object

key

additional properties

string

supported

required

boolean

eligible

required

boolean

reason

string

Example

{
  "data": {
    "commandType": "display_power_on"
  }
}

404

Display Group not found

422

Unsupported group action