Virtual Assets

A virtual asset represents an individual program or event.

Custom key-value pair metadata can be associated with virtual assets, following the same conventions as custom metadata for regular assets. See Custom Metadata.

Virtual assets in the API have the following structure.
Note: The external_id is an optional field for mapping the ID of virtual assets to external systems.
{
   "name": "Utah Football",
   "external_id": "PAC_CLF00011",
   "id": "999fffdc884841aeb05fc9e5c6fcf958"
}

View All Virtual Assets

[GET]/v2/virtual_assets

View A Single Virtual Asset

[GET]/v2/virtual_asset/virtual_asset_id

View Track segments for a Virtual Asset

[GET]/v2/virtual_assets/virtual_asset_id/track_segment_instances

View Instances of a Virtual Asset

[GET]/v2/virtual_assets/virtual_asset_id/asset_instances

Create a Virtual Asset

[POST]/v2/virtual_assets{
   properties
}

Modify a virtual asset

[PATCH]/v2/virtual_assets/virtual_asset_id{
   "name": "Utah Football 2012"
}

Set/replace virtual asset metadata

[PUT]/v2/virtual_assets/virtual_asset_id/metadata{
   "name1":"value1",
   "name2":"value2",
   "name3":"value3",
   .
   .
   .
   "name100":"value100"
}

Modify custom metadata

[PATCH]/v2/virtual_assets/virtual_asset_id/metadata{
   "name1":"value1",
   "name2":"value2",
   "name3":"value3",
   .
   .
   .
  "name100":"value100"
}

Get virtual asset metadata

[GET]/v2/virtual_assets/virtual_asset_id/metadata

Delete a virtual asset

[DELETE]/v2/virtual_assets/virtual_asset_id

Route Attributes

The following table describes all attributes that can be expressed through the route.

Route Attribute Description
virtual_asset_id

The ID of the virtual asset.

Type: String

Default: None

Example: "999fffdc884841aeb05fc9e5c6fcf958"

Query String Parameters

The following table describes all parameters that can be expressed through the query string.

Parameter Description Required?
include=object To include a virtual asset

Type: CGI-escaped, comma-separated list of values below

Valid Values: virtual_asset|virtual_asset.metadata|virtual_asset.track_segment_instances|virtual_asset.asset_instances

Example: [GET] /v2/virtual_assets?include=virtual_asset.metadata

No

Properties

The following table describes all properties that can be associated with a track.

Property Description Required?
external_id Identifier for use with external systems

Type: String

Example: "PAC_CLF00011"

No
name

Descriptive name for virtual asset

Type: String

Example: "Utah Football"

Yes

Examples

This example creates a virtual asset:

[POST]/v2/virtual_assets{
   "name": "Stanford  at  Cal"
}

Backlot returns a response similar to the following:

{  
   "created_at":"2013-01-28T17:35:53Z",
   "id":"53eed5ed1b734d30b364cf545d2c78c6",
   "external_id":"",
   "updated_at":"2013-01-28T17:35:53Z",
   "name":"Life with the Arts"
}
Note:

Try out the code samples using your account credentials in the Ooyala Scratchpad. For information about using the Scratchpad, see Practice Making Requests with the Scratchpad. To launch the scratchpad, go to Ooyala API Scratchpad.

해당 내용이 도움 되었습니까?