> This page is for Harmonic. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://mediakind.ferndocs.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://mediakind.ferndocs.com/_mcp/server. # Get list of events for a channel GET https://device.example.com:443/cluster1/vos-api/playoutcontrol/v1/events/{channelId} Reference: https://mediakind.ferndocs.com/harmonic/api/vos/playout-backend/get-list-events-channel ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Request ### Path parameters - `channelId` (string, required) — ID of the channel ### Query parameters - `RefEventId` (string, optional) — Default is the Id of the rank #1 event, which is the on-air event (or next event if no on-air event) - `EventOffset` (integer, optional, default: 0) — Signed integer. Applies to the Reference primary event, to identify the first returned event. Default is 0 - `EventsNumber` (integer, optional, default: 0) — Number of returned events. Default is 0: returns the events until the end of the playlist ## Response ### 200 OK - `firstEventRank` (integer, optional) — The position of the first returned event in the playlist. The current on-air event has firstEventRank = 1 - `primaries` (list of com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.playlist.PrimaryElement, optional) ## Errors ### 401 Unauthorized Error Unauthorized - `any` ### 403 Forbidden Error Forbidden - `any` ### 404 Not Found Error Not Found - `any` ## Types ### com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.playlist.PrimaryElement - `primaryData` (com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.playlist.PrimaryProperties, optional) - `secondaries` (list of com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.playlist.SecondaryElement, optional) ### com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.playlist.PrimaryProperties - `asRunExtraStatus` (string, optional) — Additional information about the As-Run status for past events - `asRunStatus` (enum, optional) — As-Run status for past events - Allowed values: `AIRED_OK`, `MISSING_MEDIA`, `TECHNICAL_DIFFICULTY_INVALID_ASSET`, `TECHNICAL_DIFFICULTY_UNEXPECTED_ERROR`, `TECHNICAL_DIFFICULTY_PLAY_RESTARTED`, `TECHNICAL_DIFFICULTY_SYNC_LOSS`, `TECHNICAL_DIFFICULTY_INPUT_SWITCH`, `DID_NOT_AIR_SERVICE_STOPPED`, `DID_NOT_AIR_UNEXPECTED`, `DID_NOT_AIR_EVENT_SKIPPED`, `DID_NOT_AIR_EVENT_DELETED_BY_OPERATOR`, `DID_NOT_AIR_CHANNEL_OVERRIDE`, `DID_NOT_AIR_TIMING_ERROR`, `DID_NOT_AIR_SOM_TC_NOT_IN_ASSET`, `DURATION_DISCREPANCY_ASSET_TOO_SHORT`, `PREEMPTED_BY_NEXT_EVENT`, `PREEMPTED_BY_CHANNEL_OVERRIDE`, `TECHNICAL_DIFFICULTY_LATE_START`, `JOINED_IN_PROGRESS_CHANNEL_OVERRIDE`, `CLEAN_LAYER`, `REDUNDANCY_SWITCH` - `assetId` (string, optional) — 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 - `assetStatus` (enum, optional) — Indicates that the asset or live source is ready to play, or if there is a problem - Allowed values: `UNKNOWN`, `AVAILABLE`, `MISSING`, `MISSINGGROOMINGPROFILE`, `NOTVALID`, `NOTCOMPATIBLE`, `RECORDSTARTTIMEERROR` - `assetStatusReason` (string, optional) — Description of why the asset is not valid or not compatible - `assetTitle` (string, optional) — Text or additional information about the asset, usually the material title - `audioProfileName` (string, optional) — 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 - `description` (string, optional) — Descriptive text that may contain additional information about the event - `duration` (string, optional) — Length of the event (hh:mm:ss.sss) - `durationError` (boolean, optional) — True if the play offset (when relative or absolute SOM is used) + duration is greater than the asset duration, not included if false - `endMode` (enum, optional) — Specifies how the event will end (Duration or Manual) - Allowed values: `DURATION`, `MANUAL` - `errorDuration` (string, optional) — Indicates the duration of the gap or overlap error (hh:mm:ss.sss). Only present if an overlap or gap error is detected - `eventTooShort` (boolean, optional) — True if the event duration is less than the minimum allowed (1 sec) - `eventType` (enum, optional) — Event type, File (including recorded file) or Live - Allowed values: `FILE`, `LIVE`, `COMMENT` - `firstTimecodeInAsset` (string, optional) — First timecode value for the asset, if available (hh:mm:ss[:;]ff). Only present when using absolute (timecode) SOM and somError = true - `formatDescription` (string, optional) — Describes the framerate and resolution of the live source used in the event, only present when invalidFormat = true - `gapError` (boolean, optional) — True if there is a time gap between this event and the preceding event - `groupId` (string, optional) — Group id (UUID), identifies the group of events that make up a looping schedule. All events of the looping schedule have the same group id - `id` (string, optional) — Event id (UUID) - `invalidFormat` (boolean, optional) — True if the framerate or resolution of the live source referenced by the event isn't compatible with the channel's framerate or resolution - `lastTimecodeInAsset` (string, optional) — Last timecode value for the asset + 1 (hh:mm:ss[:;]ff). Only present when using absolute (timecode) SOM, if the first timecode is available and somError = true - `loopNumber` (integer, optional) — Loop number, starting at 1, if the event belongs to a looping schedule - `materialType` (string, optional) — Material type of the asset. Special values Program, Avail, and Commercial are used for SCTE-35 generation - `missingAssetDuration` (string, optional) — Indicates missing duration for the asset to fit the configured SOM and duration (hh:mm:ss.sss). Only present if a duration error is detected - `origin` (enum, optional) — Origin (creator) of the event. Events can be created by the operator or traffic/scheduling system - Allowed values: `UNKNOWN`, `TRAFFIC`, `OPERATOR` - `overlapError` (boolean, optional) — True if start time of this event is before the end time of the preceding event - `scte35WindowEnd` (string, optional) — 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 - `scte35WindowStart` (string, optional) — 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 - `sequenceId` (string, optional) — Sequence id (UUID) - `som` (string, optional) — 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 - `somError` (boolean, optional) — True to indicate the event's SOM Type (ABSOLUTE or RELATIVE) and SOM value specify a starting position that is past the end of the asset - `somType` (enum, optional) — 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: `RELATIVE`, `ABSOLUTE` - `startMode` (enum, optional) — Specifies how the event will start (Fixed Time, Follow, Manual Take, or External SCTE-35 trigger) - Allowed values: `FIXED`, `FOLLOW`, `MANUAL`, `EXTERNAL` - `startTime` (string, optional) — 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 - `startTrigger` (string, optional) — Start trigger name - `state` (enum, optional) — Event execution state. IDLE for future events, ONAIR, or DONE for past events - Allowed values: `UNKNOWN`, `IDLE`, `ONAIR`, `DONE` - `tcDuration` (string, optional) — Equivalent to duration, but in timecode format (hh:mm:ss[:;]ff) - `tcErrorDuration` (string, optional) — Equivalent to errorDuration, but in timecode format (hh:mm:ss[:;]ff) - `tcScte35WindowEnd` (string, optional) — Equivalent to scte35WindowEnd, but in timecode format (YYYY-MM-DD hh:mm:ss[:;]ff) - `tcScte35WindowStart` (string, optional) — Equivalent to scte35WindowStart, but in timecode format (YYYY-MM-DD hh:mm:ss[:;]ff) - `tcSom` (string, optional) — Equivalent to som, but in timecode format (hh:mm:ss[:;]ff) - `tcStartTime` (string, optional) — Equivalent to startTime, but in timecode format (YYYY-MM-DD hh:mm:ss[:;]ff) - `upid` (string, optional) — 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" - `upidType` (integer, optional) — 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 - `waitingForPlayEvent` (boolean, optional) — True if the event requires a Play Next command (MANUAL start mode) or SCTE-35 trigger (EXTERNAL start mode) to start ### com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.playlist.SecondaryElement - `secondaryData` (com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.playlist.SecondaryProperties, optional) ### com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.playlist.SecondaryProperties - `asRunExtraStatus` (string, optional) — Additional As-Run status information for past events - `asRunStatus` (enum, optional) — As-Run status for past events - Allowed values: `AIRED_OK`, `MISSING_MEDIA`, `TECHNICAL_DIFFICULTY_INVALID_ASSET`, `TECHNICAL_DIFFICULTY_UNEXPECTED_ERROR`, `TECHNICAL_DIFFICULTY_PLAY_RESTARTED`, `TECHNICAL_DIFFICULTY_SYNC_LOSS`, `TECHNICAL_DIFFICULTY_INPUT_SWITCH`, `DID_NOT_AIR_SERVICE_STOPPED`, `DID_NOT_AIR_UNEXPECTED`, `DID_NOT_AIR_EVENT_SKIPPED`, `DID_NOT_AIR_EVENT_DELETED_BY_OPERATOR`, `DID_NOT_AIR_CHANNEL_OVERRIDE`, `DID_NOT_AIR_TIMING_ERROR`, `DID_NOT_AIR_SOM_TC_NOT_IN_ASSET`, `DURATION_DISCREPANCY_ASSET_TOO_SHORT`, `PREEMPTED_BY_NEXT_EVENT`, `PREEMPTED_BY_CHANNEL_OVERRIDE`, `TECHNICAL_DIFFICULTY_LATE_START`, `JOINED_IN_PROGRESS_CHANNEL_OVERRIDE`, `CLEAN_LAYER`, `REDUNDANCY_SWITCH` - `assetId` (string, optional) — File name for the graphic to be played, the filename extension is optional - `assetStatus` (enum, optional) — Indicates that the graphic is ready to play, or if there is a problem - Allowed values: `UNKNOWN`, `AVAILABLE`, `MISSING`, `MISSINGGROOMINGPROFILE` - `assetTitle` (string, optional) — Text or additional information about the graphic, usually the material title - `audioProfileName` (string, optional) — 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 - `description` (string, optional) — Descriptive text that may contain additional information about the event - `duration` (string, optional) — Length of the event (hh:mm:ss.sss), only used when the end mode is Duration - `endMode` (enum, optional) — 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: `OFFSETFROMEND`, `DURATION`, `NOEND` - `endOffset` (string, optional) — 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 - `id` (string, optional) — Event id (UUID) - `layer` (integer, optional) — 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 - `origin` (enum, optional) — Origin (creator) of the event. Events can be created by the operator or traffic/scheduling system - Allowed values: `UNKNOWN`, `TRAFFIC`, `OPERATOR` - `overlapError` (boolean, optional) — Indicates there is an overlap between 2 or more events on the same layer. The error is flagged on all of the overlapping events - `startMode` (enum, optional) — Indicates how the start timing for the secondary event will be calculated, offset from the start or end of the primary event - Allowed values: `OFFSETFROMSTART`, `OFFSETFROMEND` - `startOffset` (string, optional) — 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 - `startTime` (string, optional) — Event start date/time in UTC (YYYY-MM-DDThh:mm:ss.sss). This value is calculated and cannot be edited - `state` (enum, optional) — Event execution state. IDLE for future events, ONAIR, or DONE for past events - Allowed values: `UNKNOWN`, `IDLE`, `ONAIR`, `DONE` - `stopAnimationLeadTime` (string, optional) — 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 - `tcDuration` (string, optional) — Equivalent to duration, but in timecode format (hh:mm:ss[:;]ff) - `tcEndOffset` (string, optional) — Equivalent to endOffset, but in timecode format ([+-]hh:mm:ss[:;]ff) - `tcStartOffset` (string, optional) — Equivalent to startOffset, but in timecode format ([+-]hh:mm:ss[:;]ff) - `tcStartTime` (string, optional) — Equivalent to startTime, but in timecode format (YYYY-MM-DD hh:mm:ss[:;]ff) - `tcStopAnimationLeadTime` (string, optional) — Equivalent to stopAnimationLeadTime, but in timecode format (hh:mm:ss[:;]ff) - `templateFields` (list of com.harmonicinc.vos.playout.zookeeper.event.TemplateField, optional) — Additional information that can be passed to HTML graphic templates - `timingError` (boolean, optional) — Indicates that a timing error has been detected, e.g. the secondary event's end time is before its start time ### com.harmonicinc.vos.playout.zookeeper.event.TemplateField - `boxNumber` (integer, optional) — The number of the template box to be written - `value` (string, optional) — The text to be written to the template box ## Examples **Response** ```json { "firstEventRank": 1, "primaries": [ { "primaryData": { "asRunExtraStatus": "string", "asRunStatus": "AIRED_OK", "assetId": "string", "assetStatus": "UNKNOWN", "assetStatusReason": "string", "assetTitle": "string", "audioProfileName": "string", "description": "string", "duration": "string", "durationError": true, "endMode": "DURATION", "errorDuration": "string", "eventTooShort": true, "eventType": "FILE", "firstTimecodeInAsset": "string", "formatDescription": "string", "gapError": true, "groupId": "string", "id": "string", "invalidFormat": true, "lastTimecodeInAsset": "string", "loopNumber": 1, "materialType": "string", "missingAssetDuration": "string", "origin": "UNKNOWN", "overlapError": true, "scte35WindowEnd": "string", "scte35WindowStart": "string", "sequenceId": "string", "som": "string", "somError": true, "somType": "RELATIVE", "startMode": "FIXED", "startTime": "string", "startTrigger": "string", "state": "UNKNOWN", "tcDuration": "string", "tcErrorDuration": "string", "tcScte35WindowEnd": "string", "tcScte35WindowStart": "string", "tcSom": "string", "tcStartTime": "string", "upid": "string", "upidType": 1, "waitingForPlayEvent": true }, "secondaries": [ { "secondaryData": { "asRunExtraStatus": "string", "asRunStatus": "AIRED_OK", "assetId": "string", "assetStatus": "UNKNOWN", "assetTitle": "string", "audioProfileName": "string", "description": "string", "duration": "string", "endMode": "OFFSETFROMEND", "endOffset": "string", "id": "string", "layer": 1, "origin": "UNKNOWN", "overlapError": true, "startMode": "OFFSETFROMSTART", "startOffset": "string", "startTime": "string", "state": "UNKNOWN", "stopAnimationLeadTime": "string", "tcDuration": "string", "tcEndOffset": "string", "tcStartOffset": "string", "tcStartTime": "string", "tcStopAnimationLeadTime": "string", "templateFields": [ { "boxNumber": 1, "value": "string" } ], "timingError": true } } ] } ] } ``` **SDK Code** ```python import requests url = "https://device.example.com/cluster1/vos-api/playoutcontrol/v1/events/channelId" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://device.example.com/cluster1/vos-api/playoutcontrol/v1/events/channelId'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://device.example.com/cluster1/vos-api/playoutcontrol/v1/events/channelId" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://device.example.com/cluster1/vos-api/playoutcontrol/v1/events/channelId") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://device.example.com/cluster1/vos-api/playoutcontrol/v1/events/channelId") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://device.example.com/cluster1/vos-api/playoutcontrol/v1/events/channelId', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://device.example.com/cluster1/vos-api/playoutcontrol/v1/events/channelId"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://device.example.com/cluster1/vos-api/playoutcontrol/v1/events/channelId")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```