version 8.3.8

Back | 

WsAssetAssociations

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_associations/api/{app_token}/mode/json/apiv/5/?assetId={asset_id}&start={start}&end={end}&assocType={assocType},{assocType}

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
apiv integer The api version; only version 5 supported.
assetId integer the assetid of a given asset
assocType string filter out associations by type. Can send in multiple values comma-seperated. Possible values: program, lpo, simulated, cloned, file, link, caption, project
start int Will return a subset of available associations. Used primarily for pagination. Default is set to 0
end int Will return a subset of available associations. Used primarily for pagination. Default is set to start+20 Zero-based inclusive index: E.G. start/0/end/4 will return five programs from the beginning.

Request Headers

Name

Possible Responses

  • 205 Asset Found
  • 102 Invaild app token
  • 303 Invalid Asset ID
  • 659 Invalid Client
  • 10 Invalid Parameters!

Example Response

{
  "response": {
    "success": {
      "code": 205,
      "message": "Asset Found",
      "details": ""
    },
    "WsAssetAssociationsResponse": {
      "associatedPrograms": [
        {
          "uuid": "v9vun6xj",
          "program_title": "wqdqwd-1",
          "project_title": "RSS Test2",
          "id": 1234
        },
        {
          "uuid": "xf420i3s",
          "program_title": "wqdqwd-1",
          "project_title": "Non AS Player",
          "id": 3432
        }
      ],
      "linearPlayoutAssocations": [
        {
          "channel": "EzFlix",
          "last_updated": "2014-07-24 14:49:09"
        }
      ],
      "simulatedLiveAssocations": [
        {
          "event_uuid": "c21f6a37",
          "title": "EzTestSmilLive"
        }
      ],
      "clonedAssets": [
        {
          "id": "1036257",
          "title": "wqdqwd-1-1"
        }
      ],
      "associatedFiles": [
        {
          "id": "1028504",
          "title": "TestFile",
          "url": "http:\/\/vidego-http.multicastmedia.com\/mm\/files\/73\/V_3GP001-1028504.3gp?cid=73&aid=1028504&afid=1418492"
        },
        {
          "id": "1036256",
          "title": "NetMetrics",
          "url": "http:\/\/dev02-ovp.piksel.tech\/media\/73\/files\/N\/e\/t\/NetMetrics-1036256.pdf?c=2014-07-23+16%3A45%3A38"
        }
      ],
      "associatedLinks": [
        {
          "title": "TestUrl",
          "url": "https:\/\/eztest.piksel.tech",
          "id": 2343
        }
      ]
    }
  }
}