> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://mediakind.ferndocs.com/harmonic/api/vos/playout-backend/create-new-sequence/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://mediakind.ferndocs.com/_mcp/server. # Create a new sequence POST https://device.example.com:443/cluster1/vos-api/playoutcontrol/v1/events/{channelId}/sequence Content-Type: application/json Reference: https://mediakind.ferndocs.com/harmonic/api/vos/playout-backend/create-new-sequence ## 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 ### Body (application/json) This endpoint expects a com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.CreateSequenceProperties. - `enabled` (boolean, optional) — True if the sequence is enabled. A sequence enabled means that it can be inserted in the playlist manually or by a trigger - `id` (string, optional) — Id of the sequence - `name` (string, optional) — Name of the sequence - `playAsDefault` (boolean, optional) — True if this is the default sequence for the channel. The default sequence will be inserted automatically to fill a playlist gap or to replace missing material or invalid live source - `primaries` (list of com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.InsertSequencePrimaryElement, optional) — List of sequence primary events - `startTrigger` (string, optional) — Name of the trigger that can be used to insert the sequence into the playlist - `stopTrigger` (string, optional) — Name of the trigger that can be used to stop a sequence ## Response ### 200 OK ### 201 Sequence created ## Errors ### 400 Bad Request Error Invalid request - `any` ### 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.sequence.InsertSequencePrimaryElement - `primaryData` (com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.InsertSequencePrimaryProperties, optional) - `secondaries` (list of com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.InsertSequenceSecondaryElement, optional) ### com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.InsertSequencePrimaryProperties - `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 - `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) - `eventType` (enum, optional) — Event type, File (including recorded file) or Live - Allowed values: `FILE`, `LIVE`, `COMMENT` - `materialType` (string, optional) — Material type of the asset. Special values Program, Avail, and Commercial are used for SCTE-35 generation - `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 - `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` - `startTrigger` (string, optional) — Start trigger name - `tcDuration` (string, optional) — Equivalent to duration, but in timecode format (hh:mm:ss[:;]ff) - `tcSom` (string, optional) — Equivalent to som, but in timecode format (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 ### com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.InsertSequenceSecondaryElement - `secondaryData` (com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.InsertSecondaryProperties, optional) ### com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.InsertSecondaryProperties - `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 - `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 - `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 - `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 - `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) - `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 ### 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 ### Example 1 **Request** ```json {} ``` **Response** ```json {} ``` **SDK Code** ```python import requests url = "https://device.example.com/cluster1/vos-api/playoutcontrol/v1/events/channelId/sequence" payload = {} headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://device.example.com/cluster1/vos-api/playoutcontrol/v1/events/channelId/sequence'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{}' }; 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" "strings" "net/http" "io" ) func main() { url := "https://device.example.com/cluster1/vos-api/playoutcontrol/v1/events/channelId/sequence" payload := strings.NewReader("{}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") 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/sequence") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://device.example.com/cluster1/vos-api/playoutcontrol/v1/events/channelId/sequence") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('POST', 'https://device.example.com/cluster1/vos-api/playoutcontrol/v1/events/channelId/sequence', [ 'body' => '{}', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://device.example.com/cluster1/vos-api/playoutcontrol/v1/events/channelId/sequence"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://device.example.com/cluster1/vos-api/playoutcontrol/v1/events/channelId/sequence")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data 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() ``` ### Example 2 **Request** ```json {} ``` **Response** ```json {} ``` **SDK Code** ```python import requests url = "https://device.example.com/cluster1/vos-api/playoutcontrol/v1/events/channelId/sequence" payload = {} headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://device.example.com/cluster1/vos-api/playoutcontrol/v1/events/channelId/sequence'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{}' }; 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" "strings" "net/http" "io" ) func main() { url := "https://device.example.com/cluster1/vos-api/playoutcontrol/v1/events/channelId/sequence" payload := strings.NewReader("{}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") 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/sequence") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://device.example.com/cluster1/vos-api/playoutcontrol/v1/events/channelId/sequence") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('POST', 'https://device.example.com/cluster1/vos-api/playoutcontrol/v1/events/channelId/sequence', [ 'body' => '{}', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://device.example.com/cluster1/vos-api/playoutcontrol/v1/events/channelId/sequence"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://device.example.com/cluster1/vos-api/playoutcontrol/v1/events/channelId/sequence")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data 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() ```