Version 7.9.2

Back | 

WsAsset

Returns asset/list of assets for a given param information, urls, thumbnail,reference file,associated files,captions,assocaited links and metadata.

URL Format

/ws/ws_asset/api/{app_token}/u/{user_token}/mode/json/apiv/5?a={assetid}&r={referenceId}&date_start={date_start}&date_end={date_end}&start={start}&end={end}&title={title}&assetfiles={true/false}&include_shared={true/false}&sortby={sortby}&sortdir={sortdir}&assetType={assetType}&isPublished={true/false}&folder={folderid}&tags={tags}&metadata={metadata}&metavalue={metadata value}

Parameters

Name Req Type Description
app_token string The api token for the given account. You can find the api token when navigating through account->api accounts
user_token string The user token for the given client. Is mandatory when the user can only view his own assets
apiv integer The api version; only version 5 supported.
a string the assetid of a given asset. All the other params are ignored if the assetid is set.
r string referenceId of a given asset. All the other params are ignored if the referenceId is set.
date_start string start date filter for getting asset list for a given account .Date must be in t/z format. Example 2013-05-07T06:17:55.827Z. All dates must be in UTC
date_end string end date filter for getting asset list for a given account. Date must be in t/z format. Example 2013-05-07T06:17:55.827Z. All dates must be in UTC
date_add string date added filter for getting asset list for a given account. Date must be in t/z format. Example 2013-05-07T06:17:55.827Z. All dates must be in UTC
date_add_comp string Comparator for date_add. Possible values {>=,<=,==,>,<}. values must be url encoded. default is set to >=
datemod_start string last modification start interval filter for getting asset list for a given account. Date must be in t/z format. Example 2013-05-07T06:17:55.827Z. All dates must be in UTC
datemod_end string last modification end interval filter for getting asset list for a given account. Date must be in t/z format. Example 2013-05-07T06:17:55.827Z. All dates must be in UTC
assetfiles string/boolean value true/false. Flag to include assetfiles details in the response.
include_shared string/boolean value true/false. Flag to include shared assets for a given account
include_clonedfrom string/boolean value true/false. Flag to include cloned form other asset (null or assetid)
title string filter the response based on asset title. use '%' to do partial matches for asset title. Example "%asset title%"
sortby string The column to sort by. Can be {title, date_start, date_end,datemod,dateadd,filesize}
sortdir string The sort direction. Can be {asc, desc}
start int Will return a subset of available assets. Used primarily for pagination. Default is set to 0
end integer Will return a subset of available assets. Used primarily for pagination. Default is set to start+20 Zero-based inclusive index: E.G. &start=0&send=4 will return five programs from the beginning.
date_start_comp string Comparator for date_start. Possible values {>=,<=,==,>,<}. values must be url encoded. default is set to >=
date_end_comp string Comparator for date_end. Possible values {>=,<=,==,>,<}. values must be url encoded. default is set to <=
assetType string filter for getting asset types. Possible values {audio,video,image,binary,presentation,all}
isPublished string/boolean filter for getting assets based on whether they are published or not. Possible value {true/false}
folder int filter for folder id for a given account
recycled boolean Only include recycled content in the response. Note: this flag will disable the include shared flag. Possible value (true/false);
tags string Filter for tags of an asset.Needs to be url encoded. Example %myvideo% after urlencoded becomes %25myvideo%25
metadata string Filter for metadata field. Needs to be url encoded. Example %myvideo% after urlencoded becomes %25myvideo%25
metavalue string Filter for metadata value. Needs to be url encoded. Example %myvideo% after urlencoded becomes %25myvideo%25

Possible Responses

  • 205 Asset Found
  • 304 Assets Found
  • 303 Invalid Asset ID
  • 1036 Invalid reference Id
  • 659 Invalid Client
  • 1038 Invalid date_start
  • 1039 Invalid date_end
  • 205 invalid asset type
  • 1051 Invalid Boolean Params
  • 1041 Invalid sort params
  • 912 Invalid sort direction params
  • 913 Invalid limit params

Example Response

{
  "response": {
    "WsAssetResponse": {
      "asset": [
        {
          "assetid": 1028558,
          "title": "Demo7thNov_regtest-1",
          "dateadd": "2012-11-07T15:59:23Z",
          "datemod": "2013-11-25T19:33:11Z",
          "defaultThumb": "3553944",
          "description": "hot political news today",
          "tags": "dineesh",
          "isActive": 1,
          "isHidden": 0,
          "posterThumb": "3553944",
          "geoFilterId": 0,
          "uuid": "ik8nd9n4",
          "clientuuid": "jhdsbhbdjhvbsdbvjhbsdv",
          "isPublished": 1,
          "date_start": "2013-11-25T19:32:00Z",
          "date_end": "2025-11-25T19:32:00Z",
          "youtubePublishable": 0,
          "ipadM3u8Url": "{ovp base url}ws\/get_m3u8\/v1\/iPad\/1028558.m3u8",
          "iphoneM3u8Url": "{ovp base url}ws\/get_m3u8\/v1\/iPhone\/1028558.m3u8",
          "m3u8AndroidURL": "http:\/\/hd23245-i.akamaihd-staging.net\/i\/mm\/flvmedia\/,73\/g\/1\/c\/g1c7xlr8_n605jl03_h264_1328K.mp4,73\/g\/1\/c\/g1c7xlr8_boa7zk3a_h264_828K.mp4,73\/g\/1\/c\/g1c7xlr8_s77n85xw_h264_464K.mp4,.csmil\/master.m3u8?cid=73&aid=1028558",
          "rtmpSmil": "{ovp base url}ws\/get_smilv2\/od\/rtmp\/1028558.smil",
          "httpSmil": "{ovp base url}ws\/get_smilv2\/od\/http\/1028558.smil",
          "hdSmil": "{ovp base url}ws\/get_smilv2\/od\/hd\/1028558.smil",
          "captions": [
            
          ],
          "asset_type": "video",
          "thumbnailUrl": "{ovp base url}\/thumbs\/aid\/w\/h\/t1385407991\/1028558.jpg",
          "thumbRel": "\/thumbs\/aid\/w\/h\/t1385407991\/1028558.jpg",
          "assetType": "video",
          "duration": 102,
          "metadatas": {
            "Custom Meta": {
              "0": "",
              "value": null,
              "type": "text"
            },
            "custom meta test": {
              "0": "",
              "value": null,
              "type": "text"
            },
            "custom multiselect": {
              "0": "",
              "value": null,
              "type": "multiselect"
            },
            "Dropdown select": {
              "0": "",
              "value": null,
              "type": "select"
            },
            "Checkbox Test": {
              "0": "",
              "value": null,
              "type": "boolean"
            },
            "Test PR": {
              "0": "",
              "value": null,
              "type": "datetime"
            },
            "Test Datetime": {
              "0": "",
              "value": null,
              "type": "datetime"
            },
            "Another Chkbox": {
              "0": "",
              "value": null,
              "type": "boolean"
            },
            "Multitest ": {
              "0": "",
              "value": null,
              "type": "multiselect"
            }
          }
        }
      ],
      "currentCount": 1,
      "totalCount": "454"
    }
  }
}