Routes and Attributes Common to All Asset Types

The basic routes common to all assets have the same syntax, regardless of their type, in the Backlot REST API.

Note: For more information about Backlot REST API commands, see the Backlot API Reference.

The common routes for all assets are the create, read, update, and delete (CRUD) operations. Except for creation and updating, which requires certain properties or workflow depending on the asset type, most of these common routes require only the identifier of the asset (asset_id).

Create Asset

[POST]/v2/assets{
   properties
}
Certain asset types have considerable variation in how they are created:

List All Assets

[GET]/v2/assets

List Specific Asset

[GET]/v2/assets/asset_id

Modify Asset

[PATCH]/v2/assets/asset_id

Replace Asset

[POST]/v2/assets/asset_id/replacement

Delete Asset

[DELETE]/v2/assets/asset_id

Route Attributes

The following table describes the attributes common to all variations of the /v2/assets routes.

Route Attribute Description
ad_set_id

The ID of an ad set.

Type: String

Default: None

Example: /assets/IzNnllMjphu2XF3_UgPROoCi9B2BwtSg/ad_set/PROoCi9B2BwPROoCi9B2Bw123

asset_id

The ID of the asset. This value is referred to by different names depending on where you look for it. In the Backlot API, asset_id is the identifier for a specific asset. asset_id has the same value as the content ID found in the Backlot UI that represents a piece of content. In the Backlot API, asset_id is also equivalent to embed_code.

Type: String

Default: None

Example: /assets/IzNnllMjphu2XF3_UgPROoCi9B2BwtSg

channel_id

The content ID or embed code of a channel.

Type: String

Default: None

Example: /assets/IzNnllMjphu2XF3_UgPROoCi9B2BwtSg

channel_set_id

The ID of a channel set.

Type: String

Default: None

Example: /assets/IzNnllMjphu2XF3_UgPROoCi9B2BwtSg

drm_type

For Digital Rights Management (DRM), the type of DRM system.

Type: String

Default: None

Valid Values: widevine | playready

Example: /assets/IzNnllMjphu2XF3_UgPROoCi9B2BwtSg/drm_attributes/widevine

embed_code

The content ID from Backlot or embed code of a video within a channel. In the Backlot API, embed_code is equivalent to asset_id and the content ID from the Backlot UI. Please note that in the Backlot UI, the field for embed code refers to the embed snippet that you embed on a web page.

Type: String

Default: None

Example: /assets/IzNnllMjphu2XF3_UgPROoCi9B2BwtSg

external_id

The external ID of a video within a channel, if applicable.

Type: String

Default: None

Example: /assets/IzNnllMjphu2XF3_UgPROoCi9B2BwtSg

label_id

The ID of a label.

Type: String

Default: None

Example: /assets/IzNnllMjphu2XF3_UgPROoCi9B2BwtSg/labels/QtsjklrewsddROoCi9B2B45drs

player_id

The ID of a player.

Type: String

Default: None

Example: /players/b4f1a93b779145b4a9c8ef15f8502345

publishing_rule_id

The ID of a publishing rule.

Type: String

Default: None

Example: /assets/IzNnllMjphu2XF3_UgPROoCi9B2BwtSg/publishing_rule/QtsjklrewsddROoCi9B2B45drs

Was this article helpful?