Get a list of screen configs

Prev Next
Get
/v{version}/ScreenConfigs
Security
API Key: api_key
Header parameter nameX-ApiKey

Api Key

API Key: session_id
Header parameter nameX-Session-Id

Session Id

Path parameters
version
stringRequired

The requested API version

Responses
200

OK

Array of object
object

Information about a screen configuration

AssignedScreenCount
integer (int32)

Number of screens currently assigned.

DefaultScreens
Array of integer

Collection of default screen identifiers.

integer (int32)
Id
integer (int32)

unique Id of the screen configuration

Name
string

Name associated with this instance.

ScreenType
string
Valid values[ "Undefined", "Rs232", "Hdmi", "None" ]
UseIpcPlugin
boolean

Indicates whether the IPC plugin is enabled.

400

Bad request

Expand All
object
ValidationErrors
object
property*
Array of string additionalProperties
string
401

Unauthorized

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
403

Access denied

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
500

Unexpected error

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties