Get Asset(s) by Search Phrase

Searches for your assets or assets shared with you.

Request

Request syntax:

GET /api2/asset/list

Request properties:

Pass the following parameters through the msg parameter:

Property	Type	Description
ignore_shared_libraries	Boolean	Set to true to exclude content from shared libraries. Excluding shared libraries improves performance.
limit	Integer	Defines the maximum number of assets that may be included in the response. Specify a value from 1 to 100. Default value: 100
order	String	Sort your search results using the following syntax: order=Attribute 1[Attribute 2,Attribute n] Key information: * Sort by any of the following attributes: created	desc	duration	external_id	id	lastmod	source	state Use - to perform a reverse sort (descending / reverse alphabetical order). Sort priority is determined by the order in which multiple attributes are listed. Examples: Sort search results from shortest to longest duration: order=duration Sort search results from longest to shortest duration and then sort assets with the same duration by name in alphabetical order: order=-duration,desc
query	String	Search for assets whose name, asset ID, or external ID contains at least one of the specified keyword(s). Use search operators to define the scope of your search and special characters to fine-tune your search results.
search Deprecated	String	This deprecated property will undergo end-of-life on 3/31/2023. Use the query property instead. Perform a substring search for assets by name, asset ID, or external ID. This value should be URL-encoded.
skip	Integer	Defines the number of search results that will be skipped. Use the skip and limit parameters to generate paginated search results.

Response

Response body parameters are described below.

Response Parameter	Type	Description
assets	List	Contains a list of your assets. Returns the same response as /asset/get.
shared_assets	List	Contains a list of assets shared with your account. Returns the same response as /asset/get.

Sample Request/Response

The following sample request retrieves the three newest assets whose name, asset ID, and/or external ID contain abc. The Call() function, which is imported from uplynk_api2_auth module, prepares the message body and digital signature.

from uplynk_api2_auth import Call

print(Call('/api2/asset/list', search='abc', order='-created', limit=3))

{
     "assets": [
          {
               "created": 1315943723095,
               "job_type": "vod",
               "id": "635100d66a38436abcee5e9b0f4e04cd",
               "desc": "test.mov",
               ...
          },
          {
               "created": 1300723042924,
               "id": "cf938111bbdf4138a8cbe5ec6d800d83",
               "desc": "abc 1234 test",
               ...
          },
          {
               "created": 1296079971683,
               "id": "2a68df86e65f4e02acfd2d3e14c0edef",
               "desc": "another ABCDEFG test",
               ...
          }
     ],
     "error": 0
}