Skip to navigation
VOS APIPlayout Backend

Insert a secondary event

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

channelIdstringRequired
ID of the channel
primaryIdstringRequired
ID of the primary event

Request

Event properties
asRunExtraStatusstringOptional

Additional As-Run status information for past events

asRunStatusenumOptional

As-Run status for past events

assetIdstringOptional
File name for the graphic to be played, the filename extension is optional
assetTitlestringOptional
Text or additional information about the graphic, usually the material title
audioProfileNamestringOptional
Name of the grooming profile to be used, allows the audio tracks of a .wav file to be selected. Grooming profiles are defined in the Asset Acquisition application
descriptionstringOptional
Descriptive text that may contain additional information about the event
durationstringOptional

Length of the event (hh:mm:ss.sss), only used when the end mode is Duration

endModeenumOptional

Determines how the end timing for the secondary event will be calculated. DURATION secondary event will end at the secondary start time + duration, OFFSETFROMEND secondary will end at an offset from the end time of the primary event, NOEND secondary will be terminated by a future secondary event on the same layer

Allowed values:
endOffsetstringOptional

End offset, ([+-]hh:mm:ss.sss), only used when the end mode is OffsetFromEnd. Can be positive or negative, blank or empty is interpreted as zero offset

layerintegerOptional

Layer used for the logo/graphics, 1 to 8. If missing, the value 1 is used. When graphics overlap, the graphic on the higher layer has priority

startModeenumOptional
Indicates how the start timing for the secondary event will be calculated, offset from the start or end of the primary event
Allowed values:
startOffsetstringOptional

Start offset ([+-]hh:mm:ss.sss), only used when the start mode is OffsetFromStart. Can be positive or negative, blank or empty is interpreted as zero offset

stopAnimationLeadTimestringOptional

Duration of the graphic's outro sequence (hh:mm:ss.sss), applies to 3-point animation graphics. The outro will be started this time before the secondary event ends

tcDurationstringOptional

Equivalent to duration, but in timecode format (hh:mm:ss[:;]ff)

tcEndOffsetstringOptional

Equivalent to endOffset, but in timecode format ([+-]hh:mm:ss[:;]ff)

tcStartOffsetstringOptional

Equivalent to startOffset, but in timecode format ([+-]hh:mm:ss[:;]ff)

tcStopAnimationLeadTimestringOptional

Equivalent to stopAnimationLeadTime, but in timecode format (hh:mm:ss[:;]ff)

templateFieldslist of objectsOptional
Additional information that can be passed to HTML graphic templates

Response

OK
asRunExtraStatusstringOptional

Additional As-Run status information for past events

asRunStatusenumOptional

As-Run status for past events

assetIdstringOptional
File name for the graphic to be played, the filename extension is optional
assetStatusenumOptional
Indicates that the graphic is ready to play, or if there is a problem
Allowed values:
assetTitlestringOptional
Text or additional information about the graphic, usually the material title
audioProfileNamestringOptional
Name of the grooming profile to be used, allows the audio tracks of a .wav file to be selected. Grooming profiles are defined in the Asset Acquisition application
descriptionstringOptional
Descriptive text that may contain additional information about the event
durationstringOptional

Length of the event (hh:mm:ss.sss), only used when the end mode is Duration

endModeenumOptional

Determines how the end timing for the secondary event will be calculated. DURATION secondary event will end at the secondary start time + duration, OFFSETFROMEND secondary will end at an offset from the end time of the primary event, NOEND secondary will be terminated by a future secondary event on the same layer

Allowed values:
endOffsetstringOptional

End offset, ([+-]hh:mm:ss.sss), only used when the end mode is OffsetFromEnd. Can be positive or negative, blank or empty is interpreted as zero offset

idstringOptional

Event id (UUID)

layerintegerOptional

Layer used for the logo/graphics, 1 to 8. If missing, the value 1 is used. When graphics overlap, the graphic on the higher layer has priority

originenumOptional

Origin (creator) of the event. Events can be created by the operator or traffic/scheduling system

Allowed values:
overlapErrorbooleanOptional
Indicates there is an overlap between 2 or more events on the same layer. The error is flagged on all of the overlapping events
startModeenumOptional
Indicates how the start timing for the secondary event will be calculated, offset from the start or end of the primary event
Allowed values:
startOffsetstringOptional

Start offset ([+-]hh:mm:ss.sss), only used when the start mode is OffsetFromStart. Can be positive or negative, blank or empty is interpreted as zero offset

startTimestringOptional

Event start date/time in UTC (YYYY-MM-DDThh:mm:ss.sss). This value is calculated and cannot be edited

stateenumOptional
Event execution state. IDLE for future events, ONAIR, or DONE for past events
Allowed values:
stopAnimationLeadTimestringOptional

Duration of the graphic's outro sequence (hh:mm:ss.sss), applies to 3-point animation graphics. The outro will be started this time before the secondary event ends

tcDurationstringOptional

Equivalent to duration, but in timecode format (hh:mm:ss[:;]ff)

tcEndOffsetstringOptional

Equivalent to endOffset, but in timecode format ([+-]hh:mm:ss[:;]ff)

tcStartOffsetstringOptional

Equivalent to startOffset, but in timecode format ([+-]hh:mm:ss[:;]ff)

tcStartTimestringOptional

Equivalent to startTime, but in timecode format (YYYY-MM-DD hh:mm:ss[:;]ff)

tcStopAnimationLeadTimestringOptional

Equivalent to stopAnimationLeadTime, but in timecode format (hh:mm:ss[:;]ff)

templateFieldslist of objectsOptional
Additional information that can be passed to HTML graphic templates
timingErrorbooleanOptional
Indicates that a timing error has been detected, e.g. the secondary event's end time is before its start time

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error