POST v1/forceevents
Request Information
URI Parameters
None.
Body Parameters
ForceEventsResource| Name | Description | Type | Additional information |
|---|---|---|---|
| ForceEvents | Collection of ForceEventDto |
None. |
Request Formats
application/json, text/json
Sample:
{
"forceEvents": [
{
"deviceAction": {
"device": 1,
"action": "noOp",
"output": 1,
"chapter": 1,
"cue": 1,
"slot": 1,
"title": 1,
"fileKey": "sample string 2",
"streamUrl": "sample string 3",
"propertyName": "sample string 4",
"propertyValue": "sample string 5",
"transcribeLanguage": "sample string 6",
"translateLanguage": "sample string 7",
"networkStreamDestination": 1,
"outputId": 1,
"networkBroadcastEvent": 1
},
"switchEvent": {
"device": 1,
"output": 2
},
"automationOverride": {
"override": true,
"output": 2,
"doLastSwitchOnResume": true
}
},
{
"deviceAction": {
"device": 1,
"action": "noOp",
"output": 1,
"chapter": 1,
"cue": 1,
"slot": 1,
"title": 1,
"fileKey": "sample string 2",
"streamUrl": "sample string 3",
"propertyName": "sample string 4",
"propertyValue": "sample string 5",
"transcribeLanguage": "sample string 6",
"translateLanguage": "sample string 7",
"networkStreamDestination": 1,
"outputId": 1,
"networkBroadcastEvent": 1
},
"switchEvent": {
"device": 1,
"output": 2
},
"automationOverride": {
"override": true,
"output": 2,
"doLastSwitchOnResume": true
}
}
]
}
application/xml, text/xml
Sample:
<Resource xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CablecastAPI.DTOs">
<ForceEvents>
<ForceEvent>
<AutomationOverride>
<DoLastSwitchOnResume>true</DoLastSwitchOnResume>
<Output>2</Output>
<Override>true</Override>
</AutomationOverride>
<DeviceAction>
<Action>NoOp</Action>
<Chapter>1</Chapter>
<Cue>1</Cue>
<Device>1</Device>
<FileKey>sample string 2</FileKey>
<NetworkBroadcastEvent>1</NetworkBroadcastEvent>
<NetworkStreamDestination>1</NetworkStreamDestination>
<Output>1</Output>
<OutputId>1</OutputId>
<PropertyName>sample string 4</PropertyName>
<PropertyValue>sample string 5</PropertyValue>
<Slot>1</Slot>
<StreamUrl>sample string 3</StreamUrl>
<Title>1</Title>
<TranscribeLanguage>sample string 6</TranscribeLanguage>
<TranslateLanguage>sample string 7</TranslateLanguage>
</DeviceAction>
<SwitchEvent>
<Device>1</Device>
<Output>2</Output>
</SwitchEvent>
</ForceEvent>
<ForceEvent>
<AutomationOverride>
<DoLastSwitchOnResume>true</DoLastSwitchOnResume>
<Output>2</Output>
<Override>true</Override>
</AutomationOverride>
<DeviceAction>
<Action>NoOp</Action>
<Chapter>1</Chapter>
<Cue>1</Cue>
<Device>1</Device>
<FileKey>sample string 2</FileKey>
<NetworkBroadcastEvent>1</NetworkBroadcastEvent>
<NetworkStreamDestination>1</NetworkStreamDestination>
<Output>1</Output>
<OutputId>1</OutputId>
<PropertyName>sample string 4</PropertyName>
<PropertyValue>sample string 5</PropertyValue>
<Slot>1</Slot>
<StreamUrl>sample string 3</StreamUrl>
<Title>1</Title>
<TranscribeLanguage>sample string 6</TranscribeLanguage>
<TranslateLanguage>sample string 7</TranslateLanguage>
</DeviceAction>
<SwitchEvent>
<Device>1</Device>
<Output>2</Output>
</SwitchEvent>
</ForceEvent>
</ForceEvents>
</Resource>
Response Information
Resource Description
AutomationStatusResource| Name | Description | Type | Additional 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:22:06.831566-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:22:06.831566-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:22:06.831566-04:00",
"completed": "2025-05-23T16:22:06.831566-04:00",
"customActionId": 3,
"customActionName": "sample string 4",
"status": "running",
"statusMessage": "sample string 5"
},
{
"id": "sample string 1",
"fired": "2025-05-23T16:22:06.831566-04:00",
"completed": "2025-05-23T16:22:06.831566-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.