Contents

Returns all video content for the authenticating user.

Request

HTTP Request

GET http://api2.onescreen.net/v2/contents.json

Parameters

Parameter Name Value Description
Required parameters
token string A unique identifier associated to an Adaptive Media account user accessing the Adaptive Media API.
Optional parameters
query string Specify a query string for full text search in all video content.
state string Specifies the state of the query. Valid values include:
  • ready
    • Include all ready results in the response.
  • pending
    • Include all pending results in the response.
  • failure
    • Include all failure results in the response.
labels string Specifies the content labels associated to the query.
sort_by string Sort the query. Valid Values include:
  • desc
    • Sort in descending order
  • asc
    • Sort in ascending order
order_by string Order the query. Valid values include:
  • id
  • name
  • short_description
  • long_description (not recommended)
  • position
  • created_at
  • modified_at
  • released_at
  • expires_at
  • last_published_date
limit integer Limits the number of results to be returned per page, up to a maximum of 100. Defaults to 50.
offset integer Used for pagination and indicates which page to return in conjunction with limit.

Examples

Example HTTP Request

Response

Returns a specified video content indicated by the id for the authenticating user.

Request

HTTP Request

GET http://api2.onescreen.net/v2/contents/{id}.json

Parameters

Parameter Name Value Description
Required parameters
token string A unique identifier associated to an Adaptive Media account user accessing the Adaptive Media API.
id string The numerical ID of the desired status.

Examples

Example HTTP Request

Response

Returns all shared content for the authenticating user.

Request

HTTP Request

GET http://api2.onescreen.net/v2/contents/shared.json

Parameters

Parameter Name Value Description
Required parameters
token string A unique identifier associated to an Adaptive Media account user accessing the Adaptive Media API.
Optional parameters
query string Specify a query string for full text search in all shared video content.
account_ids string Specifies the shared account of the query. Only the shared content related to the user token will be shown.
sort_by string Sort the query. Valid Values include:
  • desc
    • Sort in descending order.
  • asc
    • Sort in ascending order.
order_by string Order the query. Valid values include:
  • id
  • name
  • short_description
  • long_description (not recommended)
  • position
  • created_at
  • modified_at
  • released_at
  • expires_at
  • last_published_date
limit integer Limits the number of results to be returned per page, up to a maximum of 100. Defaults to 50.
offset integer Used for pagination and indicates which page to return in conjunction with limit.

Examples

Example HTTP Response

Response

Add specified labels to the specified video content.

Request

HTTP Request

PUT http://api2.onescreen.net/v2/contents/add_labels.json

Parameters

Parameter Name Value Description
Required parameters
token string A unique identifier associated to an Adaptive Media account user accessing the Adaptive Media API. The token must have write access.

Request Body

Property Name Requirement Description
content_ids Required An array of IDs for the video content to attach the labels to.
labels Required An array of labels that will be added to specified video content.

Examples

Example HTTP Request

Sample Request Body

Remove specified labels to the specified video content.

Request

HTTP Request

PUT http://api2.onescreen.net/v2/contents/remove_labels.json

Parameters

Parameter Name Value Description
Required parameters
token string A unique identifier associated to an Adaptive Media account user accessing the Adaptive Media API. The token must have write access.

Request Body

Property Name Requirement Description
content_ids Required An array of IDs for the video content to remove labels for.
labels Required An array of labels that will be removed from specified video content.

Examples

Example HTTP Request

Sample Request Body

Playlists

Return all playlists for the authenticating user.

Request

HTTP Request

GET http://api2.onescreen.net/v2/playlists.json

Parameters

Parameter Name Value Description
Required parameters
token string A unique identifier associated to an Adaptive Media account user accessing the Adaptive Media API.
Optional parameters
query string Specify a query string for full text search in all playlists.
labels string Specifies the labels associated to the query.
playlist_types string Specifies the playlist type of the query. Valid values include:
  • simple
    • Include only simple playlists results in the response.
  • smart
    • Include only ready playlists results in the response.
  • synced
    • Include only synced playlists results in the response.
sort_by string Sort the query. Valid Values include:
  • desc
    • Sort in descending order.
  • asc
    • Sort in ascending order.
order_by string Order the query. Valid values include:
  • id
  • name
  • short_description
  • long_description (not recommended)
  • created_at
  • modified_at
  • last_published_date
  • expires_at
  • released_at
limit integer Limits the number of results to be returned per page, up to a maximum of 100. Defaults to 50.
offset integer Used for pagination and indicates which page to return in conjunction with limit.
include_identifiers boolean Defaulted to false. If true, identifiers of all playlists will be returned.

Examples

Example HTTP Request

Response

Returns a specified playlist indicated by the id for the authenticating user.

Request

HTTP Request

GET http://api2.onescreen.net/v2/playlists/{id}.json

Parameters

Parameter Name Value Description
Required parameters
token string A unique identifier associated to an Adaptive Media account user accessing the Adaptive Media API.
id string The numerical ID of the desired status.
Optional parameters
include_videos boolean Defaulted to false. If true, video metadata and default thumbnail uri of videos in the playlist will be returned.
include_thumbnails boolean Defaulted to false. If true, all thumbnail urls for each video in the playlist will be returned.
include_labels boolean Defaulted to false. If true, playlist labels will be returned.
include_identifiers boolean Defaulted to false. If true, playlist identifiers will be returned.
include_smartness boolean Defaulted to false. If true, the smart playlist's filters will be returned.

Examples

Example HTTP Request

Request

Makes a playlist for the authenticating user.

Request

HTTP Request

POST http://api2.onescreen.net/v2/playlists.json

Parameters

Parameter Name Value Description
Required parameters
token string A unique identifier associated to an Adaptive Media account user accessing the Adaptive Media API.

Request Body

Property Name Requirement Description
All Playlist properties
name Required The name of the playlist.
playlist_types Required The type of playlist. Choices included:
  • simple
  • smart
  • sync
short_description Optional The short description associated to the playlist.
long_description Optional The long description associated to the playlist.
tags Optional The keywords associated to the playlist.
Simple Playlist properties
video_ids Optional Video content and shared video content by the token user added into the playlist.
Sync Playlist properties
source_playlist_id Required Playlist ID provided by another Adaptive Media account.

Examples

Example HTTP Request

Sample Request Body

Simple Playlist
Smart Playlist
Synced Playlist
Edits a specified playlist indicated by the id for the authenticating user.

Request

HTTP Request

PUT http://api2.onescreen.net/v2/playlists/{id}.json

Parameters

Parameter Name Value Description
Required parameters
token string A unique identifier associated to an Adaptive Media account user accessing the Adaptive Media API. The token must have write access.
id string The numerical ID of the desired status.

Request Body

Property Name Requirement Description
All Playlist properties
name Required The name of the playlist.
short_description Optional The short description associated to the playlist.
long_description Optional The long description associated to the playlist.
tags Optional The keywords associated to the playlist.
Simple Playlist properties
video_ids Optional Video content and shared video content by the token user added into the playlist.
Smart Playlist properties
labels Optional Content labels filter.
keywords Optional Search terms filter.
tags Optional Content Tags filter.
max_items Optional Max items filter.
orderby Optional Sort by filter. Valid values include:
  • account_id
  • name
  • id
sort_direction Optional Direction filter. Valid values include:
  • asc
  • desc
max_duration Optional Maximum duration filter.
min_duration Optional Minimum duration filter.

Examples

Example HTTP Request

Sample Request Body

Simple Playlist
Smart Playlist
Add specified label(s) to the specified playlist(s) for the authenticating user.

Request

HTTP Request

PUT http://api2.onescreen.net/v2/playlists/add_labels.json

Parameters

Parameter Name Value Description
Required parameters
token string A unique identifier associated to an Adaptive Media account user accessing the Adaptive Media API. The token must have write access.

Request Body

Property Name Requirement Description
playlist_ids Required An array of IDs for the playlist to attach the labels to.
labels Required An array of labels that will be added to the specified playlists.

Examples

Example HTTP Request

Sample Request Body

Remove specified label(s) from the specified playlist(s) for the authenticating user.

Request

HTTP Request

PUT http://api2.onescreen.net/v2/playlists/remove_labels.json

Parameters

Parameter Name Value Description
Required parameters
token string A unique identifier associated to an Adaptive Media account user accessing the Adaptive Media API. The token must have write access.

Request Body

Property Name Requirement Description
playlist_ids Required An array of IDs for the playlist to remove labels for.
labels Required An array of labels that will be removed from the specified playlists.

Examples

Example HTTP Request

Sample Request Body

Deletes a specified playlist indicated by the id for the authenticating user.

Request

HTTP Request

DELETE http://api2.onescreen.net/v2/playlists/{id}.json

Parameters

Parameter Name Value Description
Required parameters
token string A unique identifier associated to an Adaptive Media account user accessing the Adaptive Media API. The token must have write access.
id string The numerical ID of the desired status.

Examples

Example HTTP Request

Widgets

Returns all widgets (applications) for the authenticating user.

Request

HTTP Request

GET http://api2.onescreen.net/v2/widgets.json

Parameters

Parameter Name Value Description
Required parameters
token string A unique identifier associated to an Adaptive Media account user accessing the Adaptive Media API.
Optional parameters
query string Specify a query string for full text search in all widgets.
widget_types string Specifies the widget_types of the query. Valid values include:
  • player
    • Include all player results in the response.
  • playlist_player
    • Include all playlist_player results in the response.
limit integer Limits the number of results to be returned per page, up to a maximum of 100. Defaults to 50.
offset integer Used for pagination and indicates which page to return in conjunction with limit.

Examples

Example HTTP Request

Response

Return the specified widget (application) indicated by the id for the authenticating user.

Request

HTTP Request

GET http://api2.onescreen.net/v2/widgets/{id}.json

Parameters

Parameter Name Value Description
Required parameters
token string A unique identifier associated to an Adaptive Media account user accessing the Adaptive Media API.
id string The numerical ID of the desired status.

Examples

Example HTTP Request

Response