Scripted Schedule API

All paths are under /api/scripted/playout/build/{buildId}.

Metadata

Method Path Purpose
GET /context Get current build state (currentTime, startTime, finishTime, isDone)

Content Selection

Method Path Body Purpose
POST /add_all ContentAll Add all content matching a key
POST /add_collection ContentCollection Add items from a manual collection
POST /add_multi_collection ContentMultiCollection Add items from a multi-collection
POST /add_smart_collection ContentSmartCollection Add items from a smart collection
POST /add_search ContentSearch Add items matching a search query
POST /add_show ContentShow Add a specific show by GUIDs
POST /add_marathon ContentMarathon Add a grouped marathon (show/season/artist/album)
POST /add_playlist ContentPlaylist Add an existing playlist
POST /create_playlist ContentCreatePlaylist Create and add a new playlist inline
POST /add_count PlayoutCount Add N items from a content key
POST /add_duration PlayoutDuration Fill a time span from a content key

Timing & Padding

Method Path Body Purpose
POST /pad_to_next PlayoutPadToNext Pad to next X-minute boundary
POST /pad_until PlayoutPadUntil Pad until a time of day
POST /pad_until_exact PlayoutPadUntilExact Pad until an exact datetime
POST /wait_until ControlWaitUntil Insert unscheduled time until a time of day
POST /wait_until_exact ControlWaitUntilExact Insert unscheduled time until an exact datetime

Skipping

Method Path Body Purpose
POST /skip_items ControlSkipItems Skip N items from a content key
POST /skip_to_item ControlSkipToItem Skip to a specific season+episode

EPG Grouping

Method Path Body Purpose
POST /start_epg_group ControlStartEpgGroup Start a new or continue an EPG group
POST /stop_epg_group (none) End the current EPG group

Overlays

Method Path Body Purpose
POST /graphics_on ControlGraphicsOn Turn on graphics elements
POST /graphics_off ControlGraphicsOff Turn off graphics elements
POST /watermark_on ControlWatermarkOn Turn on watermarks
POST /watermark_off ControlWatermarkOff Turn off watermarks
POST /pre_roll_on ControlPreRollOn Turn on pre-roll playlist
POST /pre_roll_off (none) Turn off pre-roll playlist

Preview

Method Path Purpose
GET /peek_next/{content} Peek the next item duration for a content key