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.
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
}
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 |
ID of an ad set. For details, see Ad Sets. Type: String Default: None Example: /assets/IzNnllMjphu2XF3_UgPROoCi9B2BwtSg/ad_set/PROoCi9B2BwPROoCi9B2Bw123 |
| asset_id |
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 referred to in the Backlot UI (which represents a piece of content). For details, see Managing Assets. Type: String Default: None Example: /assets/IzNnllMjphu2XF3_UgPROoCi9B2BwtSg |
| channel_id (deprecated) |
ID or embed code of a channel. For details, see Channels (Deprecated). Type: String Default: None Example: /assets/IzNnllMjphu2XF3_UgPROoCi9B2BwtSg |
| channel_set_id (deprecated) |
ID of a channel set. For details, see Channels (Deprecated). Type: String Default: None Example: /assets/IzNnllMjphu2XF3_UgPROoCi9B2BwtSg |
| drm_type |
For Digital Rights Management (DRM), the type of DRM system. For details, see Digital Rights Management. 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 UI, the embed_code is sometimes referred to as the asset_id or the content ID. 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 | External ID of a video within a channel, if applicable. For details, see Using External Identifiers. Type: String Default: None Example: /assets/IzNnllMjphu2XF3_UgPROoCi9B2BwtSg Note: Do not add a video with a null external_id, that is, an
external_id with no value ("") or a value of
"null". Such null external IDs cannot be searched for later.
|
| label_id |
ID of a label. For details, see Channels (Deprecated). Type: String Default: None Example: /assets/IzNnllMjphu2XF3_UgPROoCi9B2BwtSg/labels/QtsjklrewsddROoCi9B2B45drs |
| player_id |
ID of a player. For details, see Managing Players in Backlot. Type: String Default: None Example: /players/b4f1a93b779145b4a9c8ef15f8502345 |
| publishing_rule_id |
ID of a publishing rule. For details, see Publishing Rules. Type: String Default: None Example: /assets/IzNnllMjphu2XF3_UgPROoCi9B2BwtSg/publishing_rule/QtsjklrewsddROoCi9B2B45drs |