List Assets

Returns a list of Assets available for the Account that is identified by the given security token.

HTTP Parameters:

   
HTTP Method GET
URI /assets
Content-Type application/vnd.nativ.playout.v1+json
Normal Response 200 OK
Mode Synchronous
Authenticated Yes

Request Query Parameters:

Parameter Required Description
callback No Specifies the call back function for JSONP response.
token Yes Shared token used for authentication purposes

Matrix Parameters:

Name Required Type Description
offset No Numeric Offset count indicating the position from which to return results.
limit No Numeric The number of results to return.
title No Alphanumeric Substring matching filter on asset title.
description No Alphanumeric Substring matching filter on asset description.
reference_name No Alphanumeric Case sensitive matching filter on asset reference name.
creation_context No Enum The following options are supported: ingest, proxy, copy, transcode, group, transform , import.
asset_type No Enum The following options are supported: media, image, group.
width No Numeric Single number or closed/open range separated by '-' e.g. '100' or '100-200' or '100-' User for media asset (video stream) or image asset.
height No   Single number or closed/open range separated by '-' e.g. '100' or '100-200' or '100-'
audio_stream_count No Numeric Single number or closed/open range separated by ‘-‘ e.g. '2' or '1-2' or '1-'
video_stream_count No Numeric Single number or closed/open range separated by ‘-‘, e.g. '2' or '1-2' or '1-'
duration_sec No Numeric Single number or closed/open range separated by ‘-‘ e.g. '100' or '30-120' or '30-'
format No Enum Used for media or image asset. The list of possible image and media asset formats is specified on the Supported File Formats page
language No String Case insensitive match, user for media asset (audio or video stream)
video_codec No Enum Match on video codec. The list of possible codecs is specified on the Supported File Formats page.
audio_codec No Enum Match on audio codec. The list of possible codecs is specified on the Supported File Formats page.
frame_rate No Float Single float or integer or closed/open range separated by ‘-‘ e.g. '100' or '1-2' or '1-'.
modified No Date

Filter on last modification date of an asset. Single date or closed/open range of dates separated by ‘-‘.

Supported date formats:

  • dd MMM yyyy hh:mm:ss
  • dd MMM yyyy hh:mm:ss
  • dd MMM yyyy

8 If a range value such as 20 Aug 2013 - 21 Aug 2013 is specified, the response will include assets modified within 20 Aug 2013 00:00:00 to 21 Aug 2013 23:59:59

metadata No Alphanumeric

Free text search on all available metadata fields associated with an asset e.g.

search across all metadata fields: metadata=value

or

search a specific field: metadata=fieldname:value

or

search across specific fields as a union (%20 is a URL encoded space character): metadata=fieldname:value%20||%20fieldname:value

or

search across specific fields as an intersection (%20 is a URL encoded space character): metadata=fieldname:vaue%20&&%20fieldname=value

Response:

      {
    "assets": [
        {
            "referenceName": "FileAsset reference name",
            "transcodes": [
                {
                    "href": "http://testurl.com/playout/api/assets/235"
                },
                {
                    "href": "http://testurl.com/playout/api/assets/236"
                }
            ],
            "proxies": [
                {
                    "href": "http://testurl.com/playout/api/assets/1235"
                },
                {
                    "href": "http://testurl.com/playout/api/assets/1236"
                }
            ],
            "copies": [
                {
                    "href": "http://testurl.com/playout/api/assets/35"
                },
                {
                    "href": "http://testurl.com/playout/api/assets/36"
                }
            ],
            "parent": "http://testurl.com/playout/api/assets/1",
            "id": 2,
            "lastModified": "19 Aug 2013 15:11:03 +0100",
            "description": "FileAsset description",
            "creationContext": "INGEST",
            "assetMetadata": {
                "attachments": [
                    {
                        "size": 101012,
                        "fileName": "FileName - 1",
                        "description": "Description - 1",
                        "modified": "19 Aug 2013 15:11:03 +0100",
                        "url": "http://abc.com/",
                        "mimeType": "MimeType - 1"
                    },
                    {
                        "size": 101012,
                        "fileName": "FileName - 2",
                        "description": "Description - 2",
                        "modified": "19 Aug 2013 15:11:03 +0100",
                        "url": "http://abc.com/",
                        "mimeType": "MimeType - 2"
                    }
                ],
                "assetContext": {
                    "formatContext": {
                        "format": "AVI",
                        "streamCount": 2,
                        "audioStreamCount": 1,
                        "videoStreamCount": 1,
                        "fileSize": 21312,
                        "bitRate": 1313,
                        "duration": 12312312
                    },
                    "videoStreamContexts": [
                        {
                            "pixelAspectRatio": 15.6,
                            "width": 796,
                            "height": 560,
                            "frameRate": 1,
                            "language": "English",
                            "bitRate": 1313,
                            "codec": "AAC"
                        }
                    ],
                    "audioStreamContexts": [
                        {
                            "channels": 1,
                            "sampleRate": 12,
                            "bitsPerSample": 6,
                            "language": "English",
                            "bitRate": 1313,
                            "codec": "AAC"
                        }
                    ]
                },
                "contentMetadata": {
                    "notes": "note value",
                    "boolean": true,
                    "keywords": "no keywords",
                    "new-variable-1": "val -1",
                    "new-variable-3": "true",
                    "single-option": "yes",
                    "colour": "#9A1D1D",
                    "new-variable-2": 12
                },
                "images": [
                    {
                        "description": "Description",
                        "master": false,
                        "title": "Image Title",
                        "href": "http://testurl.com/playout/api/images/10/raw",
                        "width": 200,
                        "height": 100,
                        "mimeType": "image/jpg",
                        "timecode": "00.00.00.00@25"
                    },
                    {
                        "description": "Description",
                        "master": true,
                        "title": "Image Title",
                        "href": "http://testurl.com/playout/api/images/10/raw",
                        "width": 200,
                        "height": 100,
                        "mimeType": "image/jpg",
                        "timecode": "00.00.00.00@25"
                    }
                ]
            },
            "title": "FileAsset title one",
            "href": "http://testurl.com/playout/api/assets/2",
            "assetType": "media",
            "players": [
                {
                    "id": 2,
                    "type": "Type 2",
                    "embedCode": "<iframe>2</iframe>",
                    "href": "http://testurl.com/playout/api/players/2"
                },
                {
                    "id": 1,
                    "type": "Type 1",
                    "embedCode": "<iframe>1</iframe>",
                    "href": "http://testurl.com/playout/api/players/1"
                }
            ],
            "media": "https://www.cdnfoo.com/link/to/asset/on/cdn/name_of_file_on_cdn"
        },
        {
            "referenceName": "FileAsset reference name",
            "transcodes": [
                {
                    "href": "http://testurl.com/playout/api/assets/235"
                },
                {
                    "href": "http://testurl.com/playout/api/assets/236"
                }
            ],
            "proxies": [
                {
                    "href": "http://testurl.com/playout/api/assets/1235"
                },
                {
                    "href": "http://testurl.com/playout/api/assets/1236"
                }
            ],
            "copies": [
                {
                    "href": "http://testurl.com/playout/api/assets/35"
                },
                {
                    "href": "http://testurl.com/playout/api/assets/36"
                }
            ],
            "parent": "http://testurl.com/playout/api/assets/1",
            "id": 3,
            "lastModified": "19 Aug 2013 15:11:03 +0100",
            "description": "FileAsset description",
            "creationContext": "INGEST",
            "assetMetadata": {
                "attachments": [
                    {
                        "size": 101012,
                        "fileName": "FileName - 1",
                        "description": "Description - 1",
                        "modified": "19 Aug 2013 15:11:03 +0100",
                        "url": "http://abc.com/",
                        "mimeType": "MimeType - 1"
                    },
                    {
                        "size": 101012,
                        "fileName": "FileName - 2",
                        "description": "Description - 2",
                        "modified": "19 Aug 2013 15:11:03 +0100",
                        "url": "http://abc.com/",
                        "mimeType": "MimeType - 2"
                    }
                ],
                "assetContext": {
                    "formatContext": {
                        "format": "AVI",
                        "streamCount": 2,
                        "audioStreamCount": 1,
                        "videoStreamCount": 1,
                        "fileSize": 21312,
                        "bitRate": 1313,
                        "duration": 12312312
                    },
                    "videoStreamContexts": [
                        {
                            "pixelAspectRatio": 15.6,
                            "width": 796,
                            "height": 560,
                            "frameRate": 1,
                            "language": "English",
                            "bitRate": 1313,
                            "codec": "AAC"
                        }
                    ],
                    "audioStreamContexts": [
                        {
                            "channels": 1,
                            "sampleRate": 12,
                            "bitsPerSample": 6,
                            "language": "English",
                            "bitRate": 1313,
                            "codec": "AAC"
                        }
                    ]
                },
                "contentMetadata": {
                    "notes": "note value",
                    "boolean": true,
                    "keywords": "no key words",
                    "new-variable-1": "val -1",
                    "new-variable-3": "true",
                    "single-option": "yes",
                    "colour": "#9A1D1D",
                    "new-variable-2": 12
                },
                "images": [
                    {
                        "description": "Description",
                        "master": false,
                        "title": "Image Title",
                        "href": "http://testurl.com/playout/api/images/10/raw",
                        "width": 200,
                        "height": 100,
                        "mimeType": "image/jpg",
                        "timecode": "00.00.00.00@25"
                    },
                    {
                        "description": "Description",
                        "master": true,
                        "title": "Image Title",
                        "href": "http://testurl.com/playout/api/images/10/raw",
                        "width": 200,
                        "height": 100,
                        "mimeType": "image/jpg",
                        "timecode": "00.00.00.00@25"
                    }
                ]
            },
            "title": "FileAsset title one",
            "href": "http://testurl.com/playout/api/assets/3",
            "assetType": "media",
            "players": [
                {
                    "id": 1,
                    "type": "Type 1",
                    "embedCode": "<iframe>1</iframe>",
                    "href": "http://testurl.com/playout/api/players/1"
                },
                {
                    "id": 2,
                    "type": "Type 2",
                    "embedCode": "<iframe>2</iframe>",
                    "href": "http://testurl.com/playout/api/players/2"
                }
            ],
            "media": "https://www.cdnfoo.com/link/to/asset/on/cdn/name_of_file_on_cdn"
        }
    ],
    "limit": 2,
    "totalCount": 2,
    "offset": 0
} 

Was this article helpful?