MetadataBasicList()

List BasicAssets in the Coordinator.

The number of BasicAssets returned per page can be controlled using the FilterOffset and FilterCount query parameters. The maximum FilterCount value is 1000.

Filtering BasicAssets by a datetime is also useful for cache refreshing purposes. You can filter LogicalAssetList() with the OnOrAfter query parameter using a ISO 8601 formatted datetime without timezone information (e.g. yyyy-mm-ddThh:mm:ss).

API URL:

[BaseURL]/Asset/Metadata/Basic/List

Request Method:

GET

Request Parameters:

FilterOffset is the offset position for pagination (default value is 0)
FilterCount is the maximum number of BasicAssets to return in the response list (default value is 1000)
OnOrAfter is the filter for BasicAssets created or modified on or after as specified ISO datetime

Request Format

Optional information:

FilterOffset

Any integer greater than 0. This parameter is used to exclude BasicAssets from the response list which have been returned in a previous request.
FilterCount

Any integer greater than 1. This parameter is used to specify the maximum number of BasicAssets to include in the response list.
OnOrAfter

Any ISO datetime string in the form yyyy-mm-ddThh:mm:ss

Response Format

XML type:

dece:BasicAssetList
- dece:BasicAssetReference

Status Code:

HTTP 200

Errors

OnOrAfterDateFormatIsInvalid
- The filter OnOrAfter is not valid
- HTTP 400

Example

List BasicAssets

The following example retrieves a paginated list of BasicAssetReferences

Sample Request:

GET [BaseURL]/Asset/Metadata/Basic/List HTTP/1.1
Host: api.uvvu.com

Sample Response:

HTTP/1.1 200
Date: [Date]
Content-type: application/xml; charset=UTF-8
X-transaction-info: [TransactionInfo]

<?xml version="1.0" encoding="UTF-8"?>
<BasicAssetList xmlns="http://www.decellc.org/schema/2015/03/coordinator" xmlns:ns2="http://www.movielabs.com/schema/md/v2.3/md" FilterCount="1000" FilterOffset="0" FilterMoreAvailable="true">
  <BasicAssetReference ContentID="urn:dece:cid:org:customer-zero:123456789" CurrentStatus="urn:dece:type:status:active" CreatedDate="2017-05-21T19:24:38.351Z" UpdatedDate="2017-05-22T19:24:38.351Z">
  </BasicAssetReference>
  ...
</BasicAssetList>