API Reference

Sets

Skylark uses sets to organise content into ordered groups with scheduled contents. sets are typically used to represent views or pages, visual modules, editorially maintained collections or playlists, navigation menus, or the contents of available plans. sets have a set-type to show their purpose.

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

Skylark 8 Set Types

Skylark 8 supports the following set-types:

Set Types
Homepage
Generic View
Slider
Rail
Collection
Dynamic Object

Sets can group content based on any of the following objects:

Objects
Brands
Seasons
Episodes
Movies
Assets
Person
Dynamic Object
Slider
Rail
Collection

sets can also contain other sets, including ones they are contained in themselves.

Each item scheduled into a set can also be associated with additional metadata that relates to the placement of the item in the set. This metadata is typically used to provide display or appearance options for content. For many of the set elements this data may form the primary content of the element, such as the text of a text block.

The content, positioning, scheduling and additional metadata of objects within a set has a direct correlation on what a user can see on the front end product.

Sets, Assets and Parent URL's

In order for the API to return a parent_url for an asset or episode, that asset or episode MUST belong to a brand or season.

An asset or episode can be present in any number of sets (aka collections, rails, sliders, homepages and generic views), but can only appear in one brand or season.

If an episode appears in two collections for example then Skylark would not be able to return two parent_urls. parent_url is therefore returned as null unless the episode is part of a brand or season.

Sets and Languages

sets support language versions and returning only a subset of fields.