Profile: list

Profile Schema

A list is a document that contains other assets for sequential display. This profile requires the container profile, and a list of assets will be contained in the layout defined in the container profile.

Structure

The list profile specifies the following attributes:

Name	Type	Required?	Explanation
title	string	No	A human-readable title for this gallery to be displayed.
caption	string	No	Introduction text for the gallery.
displaySize	string	No	the relative size to display the video on a webpage

Example list document

{
    "id": "12345",
    "title": "What a great list",
    "caption": "Enjoy the best list of things",
    "profiles": [
        {
            "href": "/v1/profiles/list",
            "rels": ["type"]
        },
        {
            "href": "/v1/profiles/container"
        },
        {
            "href": "/v1/profiles/document"
        }
    ],
    "layout": [
        {
            "href": "#/assets/5678"
        },
        {
            "href": "#/assets/abcd"
        }
    ]
}