Skip to content
Tilecast Docs

getScreenPlaybackPlan

GET
/api/v1/screens/{id}/playback-plan
curl --request GET \
  --url https://example.com/api/v1/screens/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/playback-plan \
  --cookie tilecast_session=<tilecast_session>

Inspect expected presentation selection for one Screen. Requires the read scope and access to the Screen. Omit at to use captured server time. Instants before captured server time use recorded expected playback windows. Historical gaps do not use current configuration. Current and future instants evaluate current configuration in one read-only snapshot. Reported capability and synchronization evidence describes current state, including for future predictions. This endpoint does not prove actual play.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Query Parameters

Section titled “Query Parameters”
at
string format: date-time

One RFC 3339 instant with a time zone. Duplicate, empty, invalid, and unknown query parameters are rejected.

Responses

Section titled “ Responses ”

200

Section titled “200”

Expected selection or explicit historical evidence gap

Media typeapplication/json
object
data
required

Exactly one of current and historical is present. Historical evidence never includes current resource names, capability profiles, or synchronization state.

object
screenId
required
string format: uuid
at
required
string format: date-time
evaluatedAt
required
string format: date-time
basis
required
string
Allowed values: current_configuration recorded_expectation historical_expectation_unavailable
current
object
selected
object
source
required
string
Allowed values: takeover quick_present schedule assignment
contentType
required
string
Allowed values: playlist layout asset
contentId
required
string format: uuid
name

Current selected content name; absent for a missing resource.

string
scheduleName

Current selected schedule name, when a schedule selects the content.

string
selectionId
string format: uuid
revision

Current playlist or published Layout revision; absent for assets, missing resources, and unpublished Layouts.

integer format: int64
reason
required
string
Allowed values: active_takeover active_quick_present assigned_fallback schedule_highest_precedence schedule_disabled schedule_not_active schedule_lower_priority schedule_less_specific schedule_earlier_start schedule_stable_id_tiebreak no_active_takeover no_active_quick_present no_assignment
candidates
required
Array<object>
object
source
required
string
Allowed values: takeover quick_present schedule assignment
id
string format: uuid
status
required
string
Allowed values: selected superseded inactive
reason
required
string
Allowed values: active_takeover active_quick_present assigned_fallback schedule_highest_precedence schedule_disabled schedule_not_active schedule_lower_priority schedule_less_specific schedule_earlier_start schedule_stable_id_tiebreak no_active_takeover no_active_quick_present no_assignment
scheduleReason
string
Allowed values: active_takeover active_quick_present assigned_fallback schedule_highest_precedence schedule_disabled schedule_not_active schedule_lower_priority schedule_less_specific schedule_earlier_start schedule_stable_id_tiebreak no_active_takeover no_active_quick_present no_assignment
name

Current schedule candidate name, when available.

string
schedule

Scheduling authority evidence remains available when a temporary presentation supersedes the schedule.

object
scheduleId
required
string format: uuid
status
required
string
Allowed values: selected superseded inactive
reason
required
string
Allowed values: active_takeover active_quick_present assigned_fallback schedule_highest_precedence schedule_disabled schedule_not_active schedule_lower_priority schedule_less_specific schedule_earlier_start schedule_stable_id_tiebreak no_active_takeover no_active_quick_present no_assignment
priority
required
integer
specificity
required
integer
start
string format: date-time
end
string format: date-time
nextEvaluationAt

Next reevaluation boundary, not a guarantee that selected content changes.

string format: date-time
synchronization
required

Latest reported manifest synchronization; not content readiness or proof of playback.

object
status
required
string
Allowed values: not_reported current preparing out_of_date
manifestVersion
required
integer format: int64
activeManifestVersion
integer format: int64
pendingManifestVersion
integer format: int64
capabilities
required
object
status
required
string
Allowed values: supported blocked unknown not_applicable unavailable
reason
required
string
Allowed values: no_selected_content selected_content_not_found selected_content_not_published presentation_requirements_invalid reported_requirements_supported player_capabilities_not_reported no_widget_presentation_requirements manifest_v13_capabilities_not_reported widget_requirements_unsupported
evidence

Widget presentation requirements and reported support. No Data Source configuration or content payload is returned. Media decoder, network, readiness, and actual rendering behavior are outside this evidence.

object
screenId
required
string format: uuid
status
required
string
Allowed values: supported blocked unknown not_applicable
reason
required
string
Allowed values: reported_requirements_supported player_capabilities_not_reported no_widget_presentation_requirements manifest_v13_capabilities_not_reported widget_requirements_unsupported
reported
required
boolean
schemaVersions
required
Array<integer>
nativeCapabilities
required
object
key
additional properties
integer
webRuntimeVersion
required
integer
requiresManifestV13
required
boolean
widgets
required
Array<object>
object
assetId
required
string format: uuid
name
required
string
status
required
string
Allowed values: supported blocked unknown
reason
required
string
Allowed values: player_capabilities_not_reported component_capabilities_not_reported no_presentation_requirements presentation_requirements_unsupported reported_requirements_supported
selectedRenderer
string
Allowed values: component compatibility
component
object
schemaVersion
required
integer
capabilities
required
object
key
additional properties
integer
supported
required

Null until the Player reports its presentation profile.

boolean | null
compatibility
object
schemaVersion
required
integer
capabilities
required
object
key
additional properties
integer
supported
required

Null until the Player reports its presentation profile.

boolean | null
historical
object
expectation
object
windowId
required
string format: uuid
presentationType
required
string
presentationId
required
string
presentationRevision
required
string
manifestVersion
integer format: int64
scheduleId
string
source
required
string
timezone
required
string
start
required
string format: date-time
end
string format: date-time
supersededAt
string format: date-time
supersededReason
string
contentType
string
contentId
string
Example
{
  "data": {
    "basis": "current_configuration",
    "current": {
      "selected": {
        "source": "takeover",
        "contentType": "playlist",
        "reason": "active_takeover"
      },
      "candidates": [
        {
          "source": "takeover",
          "status": "selected",
          "reason": "active_takeover",
          "scheduleReason": "active_takeover",
          "schedule": {
            "status": "selected",
            "reason": "active_takeover"
          }
        }
      ],
      "synchronization": {
        "status": "not_reported"
      },
      "capabilities": {
        "status": "supported",
        "reason": "no_selected_content",
        "evidence": {
          "status": "supported",
          "reason": "reported_requirements_supported",
          "widgets": [
            {
              "status": "supported",
              "reason": "player_capabilities_not_reported",
              "selectedRenderer": "component"
            }
          ]
        }
      }
    }
  }
}

400

Section titled “400”

Invalid_playback_plan_instant

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

401

Section titled “401”

Management authentication required

403

Section titled “403”

Grant lacks the read scope

404

Section titled “404”

Invalid Screen ID, screen_not_found, or Screen outside account scope

409

Section titled “409”

Playback_expectation_ambiguous; recorded windows overlap

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}