API Reference

Rails

A rail is a set-type.

Users can manipulate and control views and their layout through Skylark, and use scheduling to make changes based on contexts such as time, location, or device.

The rail object can contain brand, season,episode, movies and asset objects as well as any number and combination of slider, rail,collection,dynamic object and people objects.

In the Skylark UI, the contents tab for a rail will allow a user to assign any number and combination of aforementioned objects.

Below is listed every metadata field available for the rail object.

Overview

NameRail
Set type slugrail
UI Nav LocationContent Group

List View

Can have imagesYes
TitleYes
LicensingYes
TranslationsYes

Information

Language Version Metadata:

UI Field NameAPI Field NameData TypeSearchable
Titletitle!Stringtrue
Slugslug!Stringfalse
Sort Titletitle_sortStringfalse
Short Synopsissynopsis_shortStringfalse
Medium Synopsissynopsis_mediumStringfalse
Long Synopsissynopsis_longStringfalse
Short Titletitle_shortStringfalse
Medium Titletitle_mediumStringfalse
Long Titletitle_longStringfalse
TranslationsYes
EditorialYes
TagsYes

Imagery

Image Type:

NameSlug
Mainmain
Headerheader
Footerfooter
Backgroundbackground
Posterposter
Landscapelandscape
Profileprofile
Previewpreview
Featurefeature
Thumbnailthumbnail

Content Type

Content Type
Brands
Season
Episodes
Assets
Movies
Slider
Rails
Collection
Dynamic Object
People

Relationships

Relationships
Genre
Theme