get_live_schedule

Read back the live schedule attached to an event (inputs, slate, archive folder, outputs, status).

Read back the live schedule attached to an event. The live schedule is a separate object
linked to the event by contentId (GET /admin/liveSchedule/content/{eventId}) - it is not
carried in the event's get_content properties or the search identifiers bag, so this is the
only way to verify an add_live_schedule_to_event write actually landed.

Safety class: A · API type: admin · Min version: -

📘

Confinement

Read-only; safe anywhere. The schedule is account-global (no folder anchor), like its event.

Signatures

def get_live_schedule(sdk, event_id):
    """Return the live schedule dict for event_id, or None if none is attached."""
    return sdk.get_live_schedule(event_id)

export async function getLiveSchedule(sdk, eventId) {
    return await sdk.getLiveSchedule(eventId);
}

Parameters

Returns

dict | None - live schedule object: contentId, slateVideo, prerollVideo, postrollVideo, isSecureOutput, archiveFolderAsset, primaryLiveInput, externalOutputProfiles, status; ref fields are {id, description}. None/empty when no schedule is attached.

Errors

• 401 unauthenticated
• 404 event or schedule not found -> returns None
• InvalidAPITypeException if session is not admin

Notes

Real-world usage

• Maps to GET /admin/liveSchedule/content/{eventId}. Pass the event contentId, not a
  schedule id.
• Use it to verify write 3 of an event import: add_live_schedule_to_event returns None
  on success and on failure, so re-read here and diff the landed refs
  (slateVideo, primaryLiveInput, archiveFolderAsset, externalOutputProfiles) by id
  against what you resolved on the target.
• Reference fields come back as {id, description}; an empty/missing schedule reads as None.

Requires an admin session (raises InvalidAPITypeException otherwise).

Real-world usage

• Maps to GET /admin/liveSchedule/content/{eventId}. Pass the event contentId, not a
  schedule id.
• Use it to verify write 3 of an event import: addLiveScheduleToEvent returns null
  on success and on failure, so re-read here and diff the landed refs
  (slateVideo, primaryLiveInput, archiveFolderAsset, externalOutputProfiles) by id
  against what you resolved on the target.
• Reference fields come back as {id, description}; an empty/missing schedule reads as null.

Requires an admin session (raises InvalidAPITypeException otherwise).

See also: Python ↔ JS naming map · Return shapes.