GET v1/automationstatus?location={location}&exclude={exclude}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
location

integer

Required

exclude

string

None.

Body Parameters

None.

Response Information

Resource Description

AutomationStatusResource
NameDescriptionTypeAdditional information
DeviceStatus

Collection of DeviceStatusDto

None.

OutputPatches

Collection of OutputPatchDto

None.

PassthroughStatus

Collection of PassthroughStatusDto

None.

NetworkStreamStatus

Collection of NetworkStreamStatus

None.

RouterStatus

RouterStatus

None.

AllowedActions

Collection of AllowedActionsDto

None.

CustomActionEvents

Collection of CustomActionEventDto

None.

Response Formats

application/json, text/json

Sample:
{
  "deviceStatus": [
    {
      "id": 1,
      "device": 1,
      "level": "unknown",
      "errorDescription": "sample string 2",
      "action": "noOp",
      "statusDescription": "sample string 3",
      "positionInFrames": 4,
      "frameRate": 5.1,
      "droppedFrameCount": 6,
      "filePath": "sample string 7",
      "fileName": "sample string 7",
      "automationOverriden": true,
      "audioMeters": [
        {
          "value": 1,
          "peak": 2,
          "clipped": true
        },
        {
          "value": 1,
          "peak": 2,
          "clipped": true
        }
      ],
      "encoderVideoPresent": true,
      "encoderVideoResolutionValid": true,
      "encoderConfiguredResolution": "eNotSupported",
      "encoderDetectedResolution": "eNotSupported",
      "decoderOutputResolution": "eNotSupported",
      "digitalFile": 1,
      "isLegacy": true,
      "networkStreamStatus": 1,
      "transcribeActive": true,
      "transcribeStart": "2025-05-23T16:06:38.968071-04:00",
      "transcribeJob": "sample string 13",
      "transcribeLanguage": "sample string 14",
      "translationLanguage": "sample string 15",
      "videoServerMeterReadings": [
        {
          "path": "sample string 1",
          "audioLevel": [
            1.1,
            2.1
          ]
        },
        {
          "path": "sample string 1",
          "audioLevel": [
            1.1,
            2.1
          ]
        }
      ],
      "outputs": [
        {
          "id": 1,
          "type": "sample string 2",
          "internalId": "sample string 3"
        },
        {
          "id": 1,
          "type": "sample string 2",
          "internalId": "sample string 3"
        }
      ],
      "videoResolution": "sample string 16"
    },
    {
      "id": 1,
      "device": 1,
      "level": "unknown",
      "errorDescription": "sample string 2",
      "action": "noOp",
      "statusDescription": "sample string 3",
      "positionInFrames": 4,
      "frameRate": 5.1,
      "droppedFrameCount": 6,
      "filePath": "sample string 7",
      "fileName": "sample string 7",
      "automationOverriden": true,
      "audioMeters": [
        {
          "value": 1,
          "peak": 2,
          "clipped": true
        },
        {
          "value": 1,
          "peak": 2,
          "clipped": true
        }
      ],
      "encoderVideoPresent": true,
      "encoderVideoResolutionValid": true,
      "encoderConfiguredResolution": "eNotSupported",
      "encoderDetectedResolution": "eNotSupported",
      "decoderOutputResolution": "eNotSupported",
      "digitalFile": 1,
      "isLegacy": true,
      "networkStreamStatus": 1,
      "transcribeActive": true,
      "transcribeStart": "2025-05-23T16:06:38.968071-04:00",
      "transcribeJob": "sample string 13",
      "transcribeLanguage": "sample string 14",
      "translationLanguage": "sample string 15",
      "videoServerMeterReadings": [
        {
          "path": "sample string 1",
          "audioLevel": [
            1.1,
            2.1
          ]
        },
        {
          "path": "sample string 1",
          "audioLevel": [
            1.1,
            2.1
          ]
        }
      ],
      "outputs": [
        {
          "id": 1,
          "type": "sample string 2",
          "internalId": "sample string 3"
        },
        {
          "id": 1,
          "type": "sample string 2",
          "internalId": "sample string 3"
        }
      ],
      "videoResolution": "sample string 16"
    }
  ],
  "outputPatches": [
    {
      "id": 1,
      "device": 1,
      "output": 1,
      "automationOverriden": true
    },
    {
      "id": 1,
      "device": 1,
      "output": 1,
      "automationOverriden": true
    }
  ],
  "passthroughStatus": [
    {
      "device": 1,
      "id": 1,
      "partners": [
        1,
        2
      ],
      "passthroughRole": "none"
    },
    {
      "device": 1,
      "id": 1,
      "partners": [
        1,
        2
      ],
      "passthroughRole": "none"
    }
  ],
  "networkStreamStatus": [
    {
      "id": 1,
      "networkStream": 1,
      "address": "sample string 2",
      "connected": true,
      "streaming": true,
      "detectedResolution": "eNotSupported"
    },
    {
      "id": 1,
      "networkStream": 1,
      "address": "sample string 2",
      "connected": true,
      "streaming": true,
      "detectedResolution": "eNotSupported"
    }
  ],
  "routerStatus": {
    "level": "unknown",
    "errorDescription": "sample string 1"
  },
  "allowedActions": [
    {
      "device": 1,
      "actions": [
        "noOp",
        "noOp"
      ]
    },
    {
      "device": 1,
      "actions": [
        "noOp",
        "noOp"
      ]
    }
  ],
  "customActionEvents": [
    {
      "id": "sample string 1",
      "fired": "2025-05-23T16:06:38.9720605-04:00",
      "completed": "2025-05-23T16:06:38.9720605-04:00",
      "customActionId": 3,
      "customActionName": "sample string 4",
      "status": "running",
      "statusMessage": "sample string 5"
    },
    {
      "id": "sample string 1",
      "fired": "2025-05-23T16:06:38.9720605-04:00",
      "completed": "2025-05-23T16:06:38.9720605-04:00",
      "customActionId": 3,
      "customActionName": "sample string 4",
      "status": "running",
      "statusMessage": "sample string 5"
    }
  ]
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.