Skip to navigation
VOS APIPlayout Backend

Insert a primary event

Authentication

AuthorizationBearer

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

Path parameters

channelIdstringRequired
ID of the channel

Request

Event properties
asRunExtraStatusstringOptional

Additional information about the As-Run status for past events

asRunStatusenumOptional

As-Run status for past events

assetIdstringOptional

Identifier for the asset to be played; a live source name, filename for file assets (the uri of the asset in asset library, with or without file path and extension), or asset title for recorded assets

assetTitlestringOptional
Text or additional information about the asset, usually the material title
audioProfileNamestringOptional
The grooming profile to be used for file assets, to allow the audio tracks of the file to be selected. Grooming profiles are defined in the Asset Acquisition application. Not applicable to live events and recorded assets
descriptionstringOptional
Descriptive text that may contain additional information about the event
durationstringOptional

Length of the event (hh:mm:ss.sss)

endModeenumOptional

Specifies how the event will end (Duration or Manual)

Allowed values:
eventTypeenumOptional

Event type, File (including recorded file) or Live

Allowed values:
materialTypestringOptional

Material type of the asset. Special values Program, Avail, and Commercial are used for SCTE-35 generation

previousIdstringOptional
scte35WindowEndstringOptional

End time of the SCTE-35 validity window (YYYY-MM-DDThh:mm:ss.sssZ), in UTC. This event and following events in the same ad pod (material type is COMMERCIAL or AVAIL, and start mode is FOLLOW) are skipped if we don't receive SCTE-35 trigger with splice-time before this time, or if we don't receive SCTE-35 trigger x seconds before this time (x is 2 seconds if the event after the ad-pod is a prepared live source, otherwise it can be up to 32 seconds). Used only when the startMode is EXTERNAL

scte35WindowStartstringOptional

Start time of the SCTE-35 validity window (YYYY-MM-DDThh:mm:ss.sssZ), in UTC. Any SCTE-35 trigger with a splice-time before this time is ignored. Used only when the startMode is EXTERNAL

sequenceIdstringOptional

Sequence id (UUID)

somstringOptional

Indicates the position in the asset to start playback (hh:mm:ss.sss). When the SomType is RELATIVE, the SOM value is the offset from the start of asset. When the SomType is ABSOLUTE, it is the timecode value for the starting position in the asset. An empty or blank value is treated as zero offset

somTypeenumOptional
The type of SOM, which determines how the SOM value is used. When the SomType is RELATIVE, the SOM value is the offset from the start of asset. When the SomType is ABSOLUTE, the Som value is the timecode value for the starting position in the asset
Allowed values:
startModeenumOptional

Specifies how the event will start (Fixed Time, Follow, Manual Take, or External SCTE-35 trigger)

Allowed values:
startTimestringOptional

Event start date/time in UTC (YYYY-MM-DDThh:mm:ss.sssZ). The start time will be automatically calculated for all events except those with Fixed start mode

startTriggerstringOptional
Start trigger name
tcDurationstringOptional

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

tcErrorDurationstringOptional

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

tcScte35WindowEndstringOptional

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

tcScte35WindowStartstringOptional

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

tcSomstringOptional

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

tcStartTimestringOptional

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

upidstringOptional

The uPid value is inserted in the segmentation_upid field of the segmentation descriptor in generated SCTE-35 messages. SCTE-35 messages are generated for events with material type PROGRAM, AVAIL, or COMMERCIAL. It is a hexadecimal string, e.g. "0x000000002C11422B" with or without the leading "0x"

upidTypeintegerOptional

The uPid type is inserted in the segmentation_upid_type field of the segmentation descriptor in generated SCTE-35 messages. SCTE-35 messages are generated for events with material type PROGRAM, AVAIL, or COMMERCIAL

Response

OK

Errors

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