QueryServer API - Get | Pixotope Help Center

AvailableTools [GET]

AvailableTools

Aggregates available tools from all connected DRM servers.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get AvailableTools

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "AvailableTools",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "AvailableTools"
}

JSON

{
  "Value": {}
}

CaptureCameraImagesProgress [GET]

CaptureCameraImagesProgress

Tracks progress and blurriness metrics for camera image capture operation.

No parameters — message is always {}.

Value

Progress	NUMBER	The progress.
Blurriness	NUMBER	The blurriness.

Example - Get CaptureCameraImagesProgress

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "CaptureCameraImagesProgress",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "CaptureCameraImagesProgress"
}

JSON

{
  "Value": {
    "Progress": 0,
    "Blurriness": 0
  }
}

DaemonEvents [GET]

DaemonEvents

Aggregates EngineIsStarting events from all connected daemons.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get DaemonEvents

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "DaemonEvents",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "DaemonEvents"
}

JSON

{
  "Value": {}
}

IOEffects [GET]

IOEffects

Aggregates IO effects (sharpen, visualizer, depth/normal generation, BPE) for all machine media.

No parameters — message is always {}.

Value

Result

OBJECT[]

The result.

Example - Get IOEffects

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "IOEffects",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "IOEffects"
}

JSON

{
  "Value": [
    {}
  ]
}

LOWPRIO_CombinedSystemInfo [GET]

LOWPRIO_CombinedSystemInfo

Aggregates system information from all connected clients with low priority updates.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get LOWPRIO_CombinedSystemInfo

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "LOWPRIO_CombinedSystemInfo",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "LOWPRIO_CombinedSystemInfo"
}

JSON

{
  "Value": {}
}

MachineGroups [GET]

MachineGroups

Maps connected machines to their default, custom, and feature group memberships.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get MachineGroups

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "MachineGroups",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "MachineGroups"
}

JSON

{
  "Value": {}
}

MachineOutputtingKey [GET]

MachineOutputtingKey

Determines which machines are outputting keyed video based on chromakey settings.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get MachineOutputtingKey

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "MachineOutputtingKey",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "MachineOutputtingKey"
}

JSON

{
  "Value": {}
}

NetworkAdapters [GET]

NetworkAdapters

Aggregates network adapter information from all connected daemons.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get NetworkAdapters

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "NetworkAdapters",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "NetworkAdapters"
}

JSON

{
  "Value": {}
}

Presets [GET]

Presets

Returns all presets from the store.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get Presets

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "Presets",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "Presets"
}

JSON

{
  "Value": {}
}

ProjectsInfos [GET]

ProjectsInfos

Aggregates project paths, projects, and favourite shows from all connected daemons.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get ProjectsInfos

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ProjectsInfos",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ProjectsInfos"
}

JSON

{
  "Value": {}
}

TimecodeReport [GET]

TimecodeReport

Generates timecode report from engine system information.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get TimecodeReport

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "TimecodeReport",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "TimecodeReport"
}

JSON

{
  "Value": {}
}

TotalDataSources [GET]

TotalDataSources

Returns count of total data sources in the data mapper.

No parameters — message is always {}.

Value

Count

STRING

The count.

Example - Get TotalDataSources

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "TotalDataSources",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "TotalDataSources"
}

JSON

{
  "Value": {}
}

AsyncComputeInfo [GET]

AsyncComputeInfo

Returns default async compute info structure with inactive status.

No parameters — message is always {}.

Value

QSComputeStatus	STRING	The qscompute status.
CurrentGeoComputeExecuter	OBJECT	The current geo compute executer.
DownloadProgress	OBJECT	The download progress.
JobID	OBJECT	The job id.

Example - Get AsyncComputeInfo

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "AsyncComputeInfo",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "AsyncComputeInfo"
}

JSON

{
  "Value": {}
}

CloudAsyncJobInfo [GET]

CloudAsyncJobInfo

Aggregates cloud async compute job information including progress, queue, ETA, and upload status.

No parameters — message is always {}.

Value

DRMComputeStatus	STRING	The drmcompute status.
ComputeCurrentQueue	STRING	The compute current queue.
ComputeETA	STRING	The compute eta.
UploadProgress	STRING	The upload progress.
CaptureCameraImagesProgress	STRING	The capture camera images progress.

Example - Get CloudAsyncJobInfo

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "CloudAsyncJobInfo",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "CloudAsyncJobInfo"
}

JSON

{
  "Value": {}
}

ComputeAsyncJobsUsage [GET]

ComputeAsyncJobsUsage

Calculates total cloud async compute jobs used in the current month.

No parameters — message is always {}.

Value

TotalJobsThisMonth

STRING

The total jobs this month.

Example - Get ComputeAsyncJobsUsage

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ComputeAsyncJobsUsage",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ComputeAsyncJobsUsage"
}

JSON

{
  "Value": {}
}

TriggerGetCloudJobUsage [GET]

TriggerGetCloudJobUsage

Generates a unique UUID to trigger cloud job usage refresh.

No parameters — message is always {}.

Value

Value

STRING

The value.

Example - Get TriggerGetCloudJobUsage

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "TriggerGetCloudJobUsage",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "TriggerGetCloudJobUsage"
}

JSON

{
  "Value": {}
}

ColorMatchingInProgress [GET]

ColorMatchingInProgress

Checks if any color matching operation is currently in progress.

No parameters — message is always {}.

Value

InProgress

STRING

The in progress.

Example - Get ColorMatchingInProgress

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ColorMatchingInProgress",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ColorMatchingInProgress"
}

JSON

{
  "Value": {}
}

ColorMatchingProfiles [GET]

ColorMatchingProfiles

Retrieves available color matching profiles from AR/XR pipelines.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get ColorMatchingProfiles

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ColorMatchingProfiles",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ColorMatchingProfiles"
}

JSON

{
  "Value": {}
}

ColorMatchingProgress [GET]

ColorMatchingProgress

Tracks the progress percentage of ongoing color matching operations.

No parameters — message is always {}.

Value

Progress

STRING

The progress.

Example - Get ColorMatchingProgress

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ColorMatchingProgress",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ColorMatchingProgress"
}

JSON

{
  "Value": {}
}

ColorMatchingStatuses [GET]

ColorMatchingStatuses

Aggregates color matching calibration status, progress, and state for all pipelines.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get ColorMatchingStatuses

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ColorMatchingStatuses",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ColorMatchingStatuses"
}

JSON

{
  "Value": {}
}

ConnectedBackupHandler [GET]

ConnectedBackupHandler

Returns connected BackupHandler service.

No parameters — message is always {}.

Value

Result

STRING

The result.

Example - Get ConnectedBackupHandler

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ConnectedBackupHandler",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ConnectedBackupHandler"
}

JSON

{
  "Value": "result"
}

ConnectedClientMachines [GET]

ConnectedClientMachines

Returns list of connected client machines (non-server machines).

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get ConnectedClientMachines

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ConnectedClientMachines",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ConnectedClientMachines"
}

JSON

{
  "Value": [
    "item1",
    "item2"
  ]
}

ConnectedCTS [GET]

ConnectedCTS

Returns list of connected CTS (Camera Tracking System) services filtered by running daemons.

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get ConnectedCTS

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ConnectedCTS",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ConnectedCTS"
}

JSON

{
  "Value": [
    "item1",
    "item2"
  ]
}

ConnectedDaemons [GET]

ConnectedDaemons

Returns list of connected Daemon services.

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get ConnectedDaemons

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ConnectedDaemons",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ConnectedDaemons"
}

JSON

{
  "Value": [
    "item1",
    "item2"
  ]
}

ConnectedDiagnostics [GET]

ConnectedDiagnostics

Returns list of connected Diagnostics services filtered by running daemons.

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get ConnectedDiagnostics

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ConnectedDiagnostics",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ConnectedDiagnostics"
}

JSON

{
  "Value": [
    "item1",
    "item2"
  ]
}

ConnectedDirectors [GET]

ConnectedDirectors

Returns list of connected Director services filtered by running daemons.

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get ConnectedDirectors

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ConnectedDirectors",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ConnectedDirectors"
}

JSON

{
  "Value": [
    "item1",
    "item2"
  ]
}

ConnectedEngines [GET]

ConnectedEngines

Returns list of connected Engine services filtered by running daemons.

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get ConnectedEngines

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ConnectedEngines",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ConnectedEngines"
}

JSON

{
  "Value": [
    "item1",
    "item2"
  ]
}

ConnectedGateways [GET]

ConnectedGateways

Returns list of connected Gateway services filtered by running daemons.

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get ConnectedGateways

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ConnectedGateways",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ConnectedGateways"
}

JSON

{
  "Value": [
    "item1",
    "item2"
  ]
}

ConnectedLicenseDRMs [GET]

ConnectedLicenseDRMs

Returns list of connected License DRM services filtered by running daemons.

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get ConnectedLicenseDRMs

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ConnectedLicenseDRMs",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ConnectedLicenseDRMs"
}

JSON

{
  "Value": [
    "item1",
    "item2"
  ]
}

ConnectedMachines [GET]

ConnectedMachines

Returns list of machine names extracted from connected daemons.

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get ConnectedMachines

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ConnectedMachines",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ConnectedMachines"
}

JSON

{
  "Value": [
    "item1",
    "item2"
  ]
}

ConnectedPipelines [GET]

ConnectedPipelines

Returns list of connected Pipeline services filtered by running daemons.

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get ConnectedPipelines

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ConnectedPipelines",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ConnectedPipelines"
}

JSON

{
  "Value": [
    "item1",
    "item2"
  ]
}

ConnectedZones [GET]

ConnectedZones

Returns list of connected ZoneTracking services filtered by running daemons.

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get ConnectedZones

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ConnectedZones",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ConnectedZones"
}

JSON

{
  "Value": [
    "item1",
    "item2"
  ]
}

CurrentDaemon [GET]

CurrentDaemon

Returns the daemon service of the current machine.

No parameters — message is always {}.

Value

Result

STRING

The result.

Example - Get CurrentDaemon

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "CurrentDaemon",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "CurrentDaemon"
}

JSON

{
  "Value": "result"
}

CurrentDirector [GET]

CurrentDirector

Returns the director service of the current machine.

No parameters — message is always {}.

Value

Result

STRING

The result.

Example - Get CurrentDirector

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "CurrentDirector",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "CurrentDirector"
}

JSON

{
  "Value": "result"
}

CurrentGateway [GET]

CurrentGateway

Returns the gateway service of the current machine.

No parameters — message is always {}.

Value

Result

STRING

The result.

Example - Get CurrentGateway

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "CurrentGateway",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "CurrentGateway"
}

JSON

{
  "Value": "result"
}

CurrentLicenseDRM [GET]

CurrentLicenseDRM

Returns the license DRM service of the current machine.

No parameters — message is always {}.

Value

Result

STRING

The result.

Example - Get CurrentLicenseDRM

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "CurrentLicenseDRM",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "CurrentLicenseDRM"
}

JSON

{
  "Value": "result"
}

CurrentMachineTools [GET]

CurrentMachineTools

Returns available tools from the current machine.

No parameters — message is always {}.

Value

Result

OBJECT[]

The result.

Example - Get CurrentMachineTools

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "CurrentMachineTools",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "CurrentMachineTools"
}

JSON

{
  "Value": [
    {}
  ]
}

DynamicCameras [GET]

DynamicCameras

Provides dynamic query data for cameras including name, type, tracking protocol, and camera set.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get DynamicCameras

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "DynamicCameras",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "DynamicCameras"
}

JSON

{
  "Value": {}
}

DynamicIOBotEntities [GET]

DynamicIOBotEntities

Provides dynamic query data for Pixotope Space IOBot entities.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get DynamicIOBotEntities

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "DynamicIOBotEntities",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "DynamicIOBotEntities"
}

JSON

{
  "Value": {}
}

DynamicIOBotPresets [GET]

DynamicIOBotPresets

Provides dynamic query data for Pixotope Space IOBot presets grouped by entity.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get DynamicIOBotPresets

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "DynamicIOBotPresets",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "DynamicIOBotPresets"
}

JSON

{
  "Value": {}
}

DynamicLevels [GET]

DynamicLevels

Provides dynamic query data for available levels across all projects.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get DynamicLevels

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "DynamicLevels",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "DynamicLevels"
}

JSON

{
  "Value": {}
}

DynamicMachines [GET]

DynamicMachines

Provides dynamic query data for machines including hostname, name, IP, color, render group, and server status.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get DynamicMachines

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "DynamicMachines",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "DynamicMachines"
}

JSON

{
  "Value": {}
}

DynamicNDISources [GET]

DynamicNDISources

Provides dynamic query data for available NDI sources from all pipelines.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get DynamicNDISources

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "DynamicNDISources",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "DynamicNDISources"
}

JSON

{
  "Value": {}
}

DynamicProjects [GET]

DynamicProjects

Provides dynamic query data for available projects across all machines.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get DynamicProjects

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "DynamicProjects",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "DynamicProjects"
}

JSON

{
  "Value": {}
}

DynamicVideoInputs [GET]

DynamicVideoInputs

Provides dynamic query data for video input routing items.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get DynamicVideoInputs

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "DynamicVideoInputs",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "DynamicVideoInputs"
}

JSON

{
  "Value": {}
}

DynamicVideoOutputs [GET]

DynamicVideoOutputs

Provides dynamic query data for video output routing items.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get DynamicVideoOutputs

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "DynamicVideoOutputs",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "DynamicVideoOutputs"
}

JSON

{
  "Value": {}
}

DynamicWebcamSources [GET]

DynamicWebcamSources

Provides dynamic query data for available webcam sources from all pipelines.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get DynamicWebcamSources

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "DynamicWebcamSources",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "DynamicWebcamSources"
}

JSON

{
  "Value": {}
}

CombinedEngineWorlds [GET]

CombinedEngineWorlds

Aggregates current world information from all ready engines.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get CombinedEngineWorlds

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "CombinedEngineWorlds",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "CombinedEngineWorlds"
}

JSON

{
  "Value": {}
}

EngineCameraPreviews [GET]

EngineCameraPreviews

Aggregates engine camera preview data from all ready engines.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get EngineCameraPreviews

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "EngineCameraPreviews",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "EngineCameraPreviews"
}

JSON

{
  "Value": {}
}

EngineOptions [GET]

EngineOptions

Aggregates DLSS availability status for all ready engines.

No parameters — message is always {}.

Value

DLSSAvailable

STRING

The dlssavailable.

Example - Get EngineOptions

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "EngineOptions",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "EngineOptions"
}

JSON

{
  "Value": {}
}

EngineStates [GET]

EngineStates

Aggregates engine state including pixel streaming enabled, engine starting, and engine running status for all machines.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get EngineStates

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "EngineStates",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "EngineStates"
}

JSON

{
  "Value": {}
}

EnginesVideowallTransitionReady [GET]

EnginesVideowallTransitionReady

Checks if all engines are ready for videowall transition.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get EnginesVideowallTransitionReady

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "EnginesVideowallTransitionReady",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "EnginesVideowallTransitionReady"
}

{"Value":}

ReadyEngines [GET]

ReadyEngines

Filters connected engines to return only those that are ready.

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get ReadyEngines

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ReadyEngines",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ReadyEngines"
}

JSON

{
  "Value": [
    "item1",
    "item2"
  ]
}

InputSources [GET]

InputSources

Aggregates formatted input sources (NDI, AJA cards, webcams) from all connected pipelines.

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get InputSources

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "InputSources",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "InputSources"
}

JSON

{
  "Value": [
    "item1",
    "item2"
  ]
}

RunningPipeline [GET]

RunningPipeline

Returns the currently running pipeline, either current or first connected.

No parameters — message is always {}.

Value

Result

STRING

The result.

Example - Get RunningPipeline

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "RunningPipeline",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "RunningPipeline"
}

JSON

{
  "Value": ""
}

VideoOptions [GET]

VideoOptions

Retrieves video format options (colorspaces, formats, resolutions, framerates) from running pipeline.

No parameters — message is always {}.

Value

ColorspacesCategories	OBJECT	The colorspaces categories.
Secondary	STRING	The secondary.

Example - Get VideoOptions

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "VideoOptions",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "VideoOptions"
}

JSON

{
  "Value": {}
}

CameraSystems [GET]

CameraSystems

Calls GetCameraSystems query with machines, cameras, and tracking statuses to aggregate camera system data.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get CameraSystems

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "CameraSystems",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "CameraSystems"
}

JSON

{
  "Value": {}
}

VideoInputs [GET]

VideoInputs

Aggregates all video routing items (both inputs and outputs) from all machines.

No parameters — message is always {}.

Value

Result

OBJECT[]

The result.

Example - Get VideoInputs

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "VideoInputs",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "VideoInputs"
}

JSON

{
  "Value": [
    {}
  ]
}

VideoIOInputs [GET]

VideoIOInputs

Filters VideoInputs to return only input-type video routing items.

No parameters — message is always {}.

Value

Result

OBJECT[]

The result.

Example - Get VideoIOInputs

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "VideoIOInputs",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "VideoIOInputs"
}

JSON

{
  "Value": [
    {}
  ]
}

VideoIOOutputs [GET]

VideoIOOutputs

Filters VideoInputs to return only output-type video routing items.

No parameters — message is always {}.

Value

Result

OBJECT[]

The result.

Example - Get VideoIOOutputs

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "VideoIOOutputs",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "VideoIOOutputs"
}

JSON

{
  "Value": [
    {}
  ]
}

HealthThresholds [GET]

HealthThresholds

Returns configured health thresholds and default threshold values.

No parameters — message is always {}.

Value

Thresholds	STRING	The thresholds.
DefaultThresholds	STRING	The default thresholds.

Example - Get HealthThresholds

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "HealthThresholds",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "HealthThresholds"
}

JSON

{
  "Value": {}
}

HealthyEngines [GET]

HealthyEngines

Returns list of machines that have healthy engine metrics.

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get HealthyEngines

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "HealthyEngines",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "HealthyEngines"
}

JSON

{
  "Value": [
    "item1",
    "item2"
  ]
}

HealthyMachines [GET]

HealthyMachines

Returns list of unique machine names from connected pipelines.

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get HealthyMachines

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "HealthyMachines",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "HealthyMachines"
}

JSON

{
  "Value": [
    "item1",
    "item2"
  ]
}

HealthySystemInfo [GET]

HealthySystemInfo

Evaluates machines health to determine if they have critical issues.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get HealthySystemInfo

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "HealthySystemInfo",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "HealthySystemInfo"
}

JSON

{
  "Value": {}
}

MachinesHealth [GET]

MachinesHealth

Processes and aggregates machine health metrics from diagnostics, pipeline, and engine services.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get MachinesHealth

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "MachinesHealth",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "MachinesHealth"
}

JSON

{
  "Value": {}
}

ParameterThresholds [GET]

ParameterThresholds

Returns parameter thresholds for machine health monitoring from store.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get ParameterThresholds

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ParameterThresholds",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ParameterThresholds"
}

JSON

{
  "Value": {}
}

ValidInvalidMachines [GET]

ValidInvalidMachines

Calculates valid and invalid machines based on health metrics and critical failover settings.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get ValidInvalidMachines

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ValidInvalidMachines",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ValidInvalidMachines"
}

JSON

{
  "Value": {}
}

RenderGroupMachines [GET]

RenderGroupMachines

Aggregates render group machines including host, clients, grouped machines, and available machine names.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get RenderGroupMachines

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "RenderGroupMachines",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "RenderGroupMachines"
}

JSON

{
  "Value": {}
}

AllSelectedGroupMachines [GET]

AllSelectedGroupMachines

Returns all selected machines from grouped render machines.

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get AllSelectedGroupMachines

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "AllSelectedGroupMachines",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "AllSelectedGroupMachines"
}

JSON

{
  "Value": [
    "item1",
    "item2"
  ]
}

GroupedRenderMachines [GET]

GroupedRenderMachines

Groups render machines by machine groups with selected and available machines for main and backup.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get GroupedRenderMachines

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "GroupedRenderMachines",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "GroupedRenderMachines"
}

JSON

{
  "Value": {}
}

RenderClientsGroupInfo [GET]

RenderClientsGroupInfo

Combines grouped render machines with detailed machine info for selected and available machines.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get RenderClientsGroupInfo

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "RenderClientsGroupInfo",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "RenderClientsGroupInfo"
}

JSON

{
  "Value": {}
}

RenderClientsMachineInfo [GET]

RenderClientsMachineInfo

Aggregates render client machine information including color and machine group memberships.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get RenderClientsMachineInfo

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "RenderClientsMachineInfo",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "RenderClientsMachineInfo"
}

JSON

{
  "Value": {}
}

RenderMachineGroups [GET]

RenderMachineGroups

Processes render machine groups by filtering routing lengths and checking for out-of-sync states.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get RenderMachineGroups

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "RenderMachineGroups",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "RenderMachineGroups"
}

JSON

{
  "Value": {}
}

ValidRenderMachineGroups [GET]

ValidRenderMachineGroups

Filters and returns valid render machine groups based on connected machines.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get ValidRenderMachineGroups

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ValidRenderMachineGroups",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ValidRenderMachineGroups"
}

JSON

{
  "Value": {}
}

ActivatedBackupMachines [GET]

ActivatedBackupMachines

Manages automatic failover by activating backup machines when main machines become unhealthy.

No parameters — message is always {}.

Value

Result

OBJECT[]

The result.

Example - Get ActivatedBackupMachines

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ActivatedBackupMachines",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ActivatedBackupMachines"
}

JSON

{
  "Value": [
    {}
  ]
}

AutomaticFailover [GET]

AutomaticFailover

Returns the automatic failover setting from the store.

No parameters — message is always {}.

Value

Result

BOOLEAN

The result.

Example - Get AutomaticFailover

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "AutomaticFailover",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "AutomaticFailover"
}

JSON

{
  "Value": true
}

FailoverController [GET]

FailoverController

Controls failover process by activating backup machines and updating machine groups and XR mappings.

No parameters — message is always {}.

Value

Result

BOOLEAN

The result.

Example - Get FailoverController

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "FailoverController",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "FailoverController"
}

JSON

{
  "Value": true
}

VidehubUpdates [GET]

VidehubUpdates

Generates Videohub routing updates for failover scenarios and out-of-sync corrections.

No parameters — message is always {}.

Value

Result

OBJECT[]

The result.

Example - Get VidehubUpdates

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "VidehubUpdates",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "VidehubUpdates"
}

JSON

{
  "Value": [
    {}
  ]
}

VideohubController [GET]

VideohubController

Syncs Videohub routings when automatic failover is enabled and Videohub is connected.

No parameters — message is always {}.

Value

Result

BOOLEAN

The result.

Example - Get VideohubController

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "VideohubController",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "VideohubController"
}

JSON

{
  "Value": true
}

RenderClientsMappingInfo [GET]

RenderClientsMappingInfo

Aggregates render client mapping information for main and backup machines in each group.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get RenderClientsMappingInfo

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "RenderClientsMappingInfo",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "RenderClientsMappingInfo"
}

JSON

{
  "Value": {}
}

RenderMappingUsedSources [GET]

RenderMappingUsedSources

Returns all used videohub sources and destinations from render machine groups.

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get RenderMappingUsedSources

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "RenderMappingUsedSources",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "RenderMappingUsedSources"
}

JSON

{
  "Value": [
    "item1",
    "item2"
  ]
}

ResetMachinesGroupsMapping [GET]

ResetMachinesGroupsMapping

Resets machine group routings based on video outputs and connected machines.

No parameters — message is always {}.

Value

Result

BOOLEAN

The result.

Example - Get ResetMachinesGroupsMapping

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ResetMachinesGroupsMapping",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ResetMachinesGroupsMapping"
}

JSON

{
  "Value": true
}

VideohubSources [GET]

VideohubSources

Returns Videohub input/output sources and their state including routing and lock status.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get VideohubSources

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "VideohubSources",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "VideohubSources"
}

JSON

{
  "Value": {}
}

VideohubState [GET]

VideohubState

Returns Videohub state including input/output labels, locks, and routing from current daemon.

No parameters — message is always {}.

Value

InputLabels

STRING

The input labels.

Example - Get VideohubState

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "VideohubState",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "VideohubState"
}

JSON

{
  "Value": {}
}

VideoOutputsPerMachine [GET]

VideoOutputsPerMachine

Aggregates video outputs grouped by machine name.

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get VideoOutputsPerMachine

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "VideoOutputsPerMachine",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "VideoOutputsPerMachine"
}

JSON

{
  "Value": [
    "item1",
    "item2"
  ]
}

ActiveBackupServer [GET]

ActiveBackupServer

Returns active server, whether it is main or backup.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get ActiveBackupServer

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ActiveBackupServer",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ActiveBackupServer"
}

JSON

{
  "Value": {}
}

AvailableServerBackups [GET]

AvailableServerBackups

Filters and aggregates available server backup machines.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get AvailableServerBackups

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "AvailableServerBackups",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "AvailableServerBackups"
}

JSON

{
  "Value": {}
}

BackupMachineLoaders [GET]

BackupMachineLoaders

Returns the loaders per machine.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get BackupMachineLoaders

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "BackupMachineLoaders",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "BackupMachineLoaders"
}

JSON

{
  "Value": {}
}

BackupNetworkStatus [GET]

BackupNetworkStatus

Returns the network status of the server backup.

No parameters — message is always {}.

Value

Healthy	STRING	The healthy.
Configured	STRING	The configured.
UnhealthyReasons	STRING	The unhealthy reasons.
BackupMachineDisconnected	STRING	The backup machine disconnected.

Example - Get BackupNetworkStatus

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "BackupNetworkStatus",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "BackupNetworkStatus"
}

JSON

{
  "Value": {}
}

EnabledBackupClient [GET]

EnabledBackupClient

Returns the enabled backup client info.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get EnabledBackupClient

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "EnabledBackupClient",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "EnabledBackupClient"
}

JSON

{
  "Value": {}
}

MainServerInfo [GET]

MainServerInfo

Returns the main server idle info.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get MainServerInfo

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "MainServerInfo",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "MainServerInfo"
}

JSON

{
  "Value": {}
}

ServerBackupClients [GET]

ServerBackupClients

Filters and aggregates server backup client information with daemon details.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get ServerBackupClients

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ServerBackupClients",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ServerBackupClients"
}

JSON

{
  "Value": {}
}

ServerBackupInProgress [GET]

ServerBackupInProgress

Returns the loading status, backup handler loaders, and backup machine loaders.

No parameters — message is always {}.

Value

Loading	STRING	The loading.
BackupMachineLoaders	STRING	The backup machine loaders.

Example - Get ServerBackupInProgress

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ServerBackupInProgress",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ServerBackupInProgress"
}

JSON

{
  "Value": {}
}

ServerBackups [GET]

ServerBackups

Aggregates server backup information for all client machines.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get ServerBackups

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ServerBackups",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ServerBackups"
}

JSON

{
  "Value": {}
}

ServerBackupsInfo [GET]

ServerBackupsInfo

Aggregates server backup information for all client machines.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get ServerBackupsInfo

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ServerBackupsInfo",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ServerBackupsInfo"
}

JSON

{
  "Value": {}
}

VideohubAutoConnect [GET]

VideohubAutoConnect

Manages Videohub auto-connect by connecting or disconnecting based on stored settings.

No parameters — message is always {}.

Value

Result

BOOLEAN

The result.

Example - Get VideohubAutoConnect

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "VideohubAutoConnect",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "VideohubAutoConnect"
}

JSON

{
  "Value": false
}

VideohubConnectionInfo [GET]

VideohubConnectionInfo

Returns Videohub connection information including auto-connect setting and IP address.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get VideohubConnectionInfo

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "VideohubConnectionInfo",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "VideohubConnectionInfo"
}

JSON

{
  "Value": {}
}

VideohubConnectionStatus [GET]

VideohubConnectionStatus

Returns Videohub server connection status from the current daemon.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get VideohubConnectionStatus

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "VideohubConnectionStatus",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "VideohubConnectionStatus"
}

JSON

{
  "Value": {}
}

CustomDirectors [GET]

CustomDirectors

Aggregates custom director information (name, color, title) for all daemons.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get CustomDirectors

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "CustomDirectors",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "CustomDirectors"
}

JSON

{
  "Value": {}
}

DaemonInfos [GET]

DaemonInfos

Aggregates daemon information including machine info, meta info, custom directors, and network details.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get DaemonInfos

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "DaemonInfos",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "DaemonInfos"
}

JSON

{
  "Value": {}
}

DaemonIsBusy [GET]

DaemonIsBusy

Aggregates daemon is busy information from all daemons.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get DaemonIsBusy

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "DaemonIsBusy",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "DaemonIsBusy"
}

JSON

{
  "Value": {}
}

DaemonRoles [GET]

DaemonRoles

Aggregates role information from all connected daemons.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get Roles

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "Roles",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "Roles"
}

JSON

{
  "Value": {}
}

DirectorInfos [GET]

DirectorInfos

Aggregates director startup information from all daemons.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get DirectorInfos

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "DirectorInfos",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "DirectorInfos"
}

JSON

{
  "Value": {}
}

InstallerInfos [GET]

InstallerInfos

Aggregates installer type information from all connected daemons.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get InstallerInfos

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "InstallerInfos",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "InstallerInfos"
}

JSON

{
  "Value": {}
}

LicenseInfos [GET]

LicenseInfos

Aggregates license information including user email and activated license names from DRM servers.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get LicenseInfos

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "LicenseInfos",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "LicenseInfos"
}

JSON

{
  "Value": {}
}

PathsInfo [GET]

PathsInfo

Aggregates path information (machine paths and synced paths) from all daemons.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get PathsInfo

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "PathsInfo",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "PathsInfo"
}

JSON

{
  "Value": {}
}

PixotopeVersions [GET]

PixotopeVersions

Aggregates Pixotope version information from all connected daemons.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get PixotopeVersions

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "PixotopeVersions",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "PixotopeVersions"
}

JSON

{
  "Value": {}
}

Roles [GET]

Roles

Aggregates role information from all connected daemons.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get Roles

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "Roles",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "Roles"
}

JSON

{
  "Value": {}
}

CombinedMatroxAdapters [GET]

CombinedMatroxAdapters

Aggregates Matrox adapter information from all connected Matrox services.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get CombinedMatroxAdapters

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "CombinedMatroxAdapters",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "CombinedMatroxAdapters"
}

JSON

{
  "Value": {}
}

CombinedNMOSConfig [GET]

CombinedNMOSConfig

Aggregates NMOS persistent state configuration from all connected Matrox services.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get CombinedNMOSConfig

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "CombinedNMOSConfig",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "CombinedNMOSConfig"
}

JSON

{
  "Value": {}
}

CombinedNMOSConnStatus [GET]

CombinedNMOSConnStatus

Aggregates NMOS connection status from all connected Matrox services.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get CombinedNMOSConnStatus

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "CombinedNMOSConnStatus",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "CombinedNMOSConnStatus"
}

JSON

{
  "Value": {}
}

MachineFeatures [GET]

MachineFeatures

Returns machine features supported by each machine tool.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get MachineFeatures

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "MachineFeatures",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "MachineFeatures"
}

JSON

{
  "Value": {}
}

ManageNetworkGroups [GET]

ManageNetworkGroups

Manages Pixotope Network client groups by updating server group info.

No parameters — message is always {}.

Value

Result

BOOLEAN

The result.

Example - Get ManageNetworkGroups

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ManageNetworkGroups",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ManageNetworkGroups"
}

JSON

{
  "Value": false
}

NetworkFeatures [GET]

NetworkFeatures

Returns network features supported by the server machine.

No parameters — message is always {}.

Value

SupportLargeNetwork	STRING	The support large network.
SupportManyCameras	STRING	The support many cameras.
SupportThirdPartyTracking	STRING	The support third party tracking.
EnginePresent	STRING	The engine present.
DualCamerasPresent	STRING	The dual cameras present.
XRPresent	STRING	The xrpresent.
ChromaKeyerPresent	STRING	The chroma keyer present.

Example - Get NetworkFeatures

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "NetworkFeatures",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "NetworkFeatures"
}

JSON

{
  "Value": {}
}

ManageIOBotConnection [GET]

ManageIOBotConnection

Manages IOBot connection/disconnection based on stored connection info.

No parameters — message is always {}.

Value

Result

BOOLEAN

The result.

Example - Get ManageIOBotConnection

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ManageIOBotConnection",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ManageIOBotConnection"
}

JSON

{
  "Value": true
}

PixotopeSpaceConnectiomStatus [GET]

PixotopeSpaceConnectiomStatus

Returns IOBot connection status for the current daemon.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get PixotopeSpaceConnectiomStatus

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "PixotopeSpaceConnectiomStatus",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "PixotopeSpaceConnectiomStatus"
}

JSON

{
  "Value": {}
}

PixotopeSpaceConnectionInfo [GET]

PixotopeSpaceConnectionInfo

Returns stored Pixotope Space IOBot connection information (IP and port).

No parameters — message is always {}.

Value

IPAddress	STRING	The ipaddress.
Port	STRING	The port.

Example - Get PixotopeSpaceConnectionInfo

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "PixotopeSpaceConnectionInfo",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "PixotopeSpaceConnectionInfo"
}

JSON

{
  "Value": {}
}

PixotopeSpaceEntities [GET]

PixotopeSpaceEntities

Returns IOBot entities from the current daemon.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get PixotopeSpaceEntities

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "PixotopeSpaceEntities",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "PixotopeSpaceEntities"
}

JSON

{
  "Value": {}
}

PixotopeSpacePresets [GET]

PixotopeSpacePresets

Returns IOBot presets grouped by entity from the current daemon.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get PixotopeSpacePresets

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "PixotopeSpacePresets",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "PixotopeSpacePresets"
}

JSON

{
  "Value": {}
}

AvailableSRTPorts [GET]

AvailableSRTPorts

Calculates available SRT ports for each machine based on used ports in Routing.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get AvailableSRTPorts

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "AvailableSRTPorts",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "AvailableSRTPorts"
}

JSON

{
  "Value": {}
}

AvailableUDPPorts [GET]

AvailableUDPPorts

Calculates available UDP ports for each machine based on used ports in LocalChains.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get AvailableUDPPorts

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "AvailableUDPPorts",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "AvailableUDPPorts"
}

JSON

{
  "Value": {}
}

CameraTrackingProtocols [GET]

CameraTrackingProtocols

Retrieves supported camera tracking protocols from connected CTS.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get CameraTrackingProtocols

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "CameraTrackingProtocols",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "CameraTrackingProtocols"
}

JSON

{
  "Value": {}
}

PipelineTrackingStatuses [GET]

PipelineTrackingStatuses

Aggregates tracking statuses for all connected pipelines.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get PipelineTrackingStatuses

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "PipelineTrackingStatuses",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "PipelineTrackingStatuses"
}

JSON

{
  "Value": {}
}

ZoneMachineCheckpoints [GET]

ZoneMachineCheckpoints

Retrieves all zone checkpoints per machine.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get ZoneMachineCheckpoints

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ZoneMachineCheckpoints",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ZoneMachineCheckpoints"
}

{"Value":{"<MachineName>":{"<CheckpointName>":{...}}}}

ZoneStates [GET]

ZoneStates

Retrieves all zone states.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get ZoneStates

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ZoneStates",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ZoneStates"
}

JSON

{
  "Value": {}
}

VideoFilesInfo [GET]

VideoFilesInfo

Aggregates video file information (folder, loopback, running, stopped status) for all machine routings.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get VideoFilesInfo

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "VideoFilesInfo",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "VideoFilesInfo"
}

JSON

{
  "Value": {}
}

WebRTCNetworkConfig [GET]

WebRTCNetworkConfig

Aggregates WebRTC network configuration from store machines.

No parameters — message is always {}.

Value

WebRTCInterface	STRING	The web rtcinterface.
WebRTCPort	STRING	The web rtcport.

Example - Get WebRTCNetworkConfig

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "WebRTCNetworkConfig",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "WebRTCNetworkConfig"
}

JSON

{
  "Value": {}
}

Endpoints [GET]

Endpoints

Aggregates available endpoints from all relays.

No parameters — message is always {}.

Value

State	BOOLEAN	The state.
PersistentState	BOOLEAN	The persistent state.
Calls	STRING	The calls.
Fields	STRING	The fields.

Example - Get Endpoints

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "Endpoints",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "Endpoints"
}

JSON

{
  "Value": {}
}

Relays

AvailableTools

CaptureCameraImagesProgress

DaemonEvents

IOEffects

LOWPRIO_CombinedSystemInfo

MachineGroups

MachineOutputtingKey

NetworkAdapters

Presets

ProjectsInfos

TimecodeReport

TotalDataSources

Cloud Async Compute

AsyncComputeInfo

CloudAsyncJobInfo

ComputeAsyncJobsUsage

TriggerGetCloudJobUsage

Color Matching

ColorMatchingInProgress

ColorMatchingProfiles

ColorMatchingProgress

ColorMatchingStatuses

Connected Clients

ConnectedBackupHandler

ConnectedClientMachines

ConnectedCTS

ConnectedDaemons

ConnectedDiagnostics

ConnectedDirectors

ConnectedEngines

ConnectedGateways

ConnectedLicenseDRMs

ConnectedMachines

ConnectedPipelines

ConnectedZones

Current Machine

CurrentDaemon

CurrentDirector

CurrentGateway

CurrentLicenseDRM

CurrentMachineTools

Dynamic Queries

DynamicCameras

DynamicIOBotEntities

DynamicIOBotPresets

DynamicLevels

DynamicMachines

DynamicNDISources

DynamicProjects

DynamicVideoInputs

DynamicVideoOutputs

DynamicWebcamSources

Engine

CombinedEngineWorlds

EngineCameraPreviews

EngineOptions

EngineStates

EnginesVideowallTransitionReady

ReadyEngines

Formats

InputSources

RunningPipeline

VideoOptions

Inputs

CameraSystems

VideoInputs

VideoIOInputs

VideoIOOutputs

Machine Health

HealthThresholds

HealthyEngines

HealthyMachines

HealthySystemInfo

MachinesHealth

ParameterThresholds

ValidInvalidMachines

Machines

RenderGroupMachines

Render Clients Info