Content Endpoints

/content/

GET

Retrieves a list of content files on the network.

Parameters

• marker: A value specifying which page to retrieve. This value is useful if the isTruncated entry in the response body of the previous GET call indicates that the number of Content instances exceeds the pageSize.
• pageSize: The maximum number of Content instances that can be contained in the response body
• filter:  An expression for filtering search results. The following are accepted expressions:
  • [entry] IS '<value>'
  • [entry] CONTAINS '<value>'
  • [entry] IS IN ('<value_a>','<value_b>', [...])
  • [entry] IS NOT IN ('<value_a>','<value_b>', [...])
  • [entry] BEGINS WITH '<value>'
• sort: An expression for sorting the search results. The sort expression specifies the entry used for sorting and the ascending/descending (ASC/DESC) sorting order (e.g. "[content].[fileName] ASC")

Response Body

• [int] totalItemCount: The total number of content files relevant to the query
• [int] pageSize: The maximum number of Content instances that can be returned in a single response
• [bool] isTruncated: A flag indicating whether the totalItemCount exceeds the pageSize
• [string] nextMarker: A value that can be included with a subsequent GET call to return additional results that have been truncated
• [string] sortExpression: The sort expression specified in the URL
• [string] filterExpression: The filter expression specified in the URL
• [Content[]]items: An array of Content object instances. Each Content instance can have the following entries: 
  • [int] id: A unique identifier for the Content instance. This value is generated by the server when the content file is uploaded.
  • [string] fileName: The name of the content file
  • [string] mediaType: The file type, which can be one of the following:
    • "Video": An MPG, MP4, TS, MOV, VOB, or WMV video file
    • "Image": A JPG, PNG, or BMP image file
    • "Audio": An MP3 or WAV audio file
    • "Text": A TXT file
    • "Other": An unknown file type
  • [string] physicalPath: The location of the file in the server directory
  • [string] virtualPath: The location of the file in the BSN virtual directory
  • [[string] thumbPath: The location of the thumbnail for the video/image file in the server directory. This value is a blank string for audio, text, and unknown file types.
  • [int] size: The file size (in bytes)
  • [string] hash: The hash algorithm and value. The string is formatted as "{algorithm}:{value}" (e.g. "SHA1:6DB465879088280AAC52DC22B07ED0AD493A99D4").
  • [string] uploadDate: A UTC timestamp indicating when the file was uploaded to BSN. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ.
  • [string] fileLastModifiedDate: A UTC timestamp indicating when the file was last modified on BSN. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ.
  • [string] probeData: The audio/video probe data. This value is a blank string for image, text, and unknown file types.
  • [Presentation[]]presentations: An array of Presentation object instances representing presentations that use the content file. Each Presentation instance can have the following values:
    • [int] id: A unique identifier for the Presentation instance

    • [string] name: The presentation name
    • [string] type: The presentation type
  • [DynamicPlaylist[]]dynamicPlaylists: An array of DynamicPlaylist object instances representing Dynamic Playlists that contain the content file. Each DynamicPlaylist instance can have the following values:
    • [int] id: A unique identifier for the DynamicPlaylist instance

    • [string] name: The Dynamic Playlist name
  • [LiveMediaFeed[]]liveMediaFeeds: An array of LiveMediaFeed object instances representing Live Media Feeds that contain the content file. Each LiveMediaFeed instance can have the following values:
    • [int] id: A unique identifier for the LiveMediaFeed instance

    • [string] name: The Live Media Feed name
  • [TaggedPlaylist[]]taggedPlaylists: An array of TaggedPlaylist object instances representing Tagged Playlists that contain the content file. Each TaggedPlaylist instance can have the following values:
    • [int] id: A unique identifier for the TaggedPlaylist instance

    • [string] name: The TaggedPlaylist name
  • [Tag{}] tags: An array of key/value pairs that represent tags assigned to the content file. Each Tag is formatted as follows: "<value_type>::<tag_type>.<tag_key>":"<value>".
    • value_type: "string" or "number"
    • tag_type: "[Content]" (a user-defined value) or "[sys].[Content]" (a system-defined value)
    • tag_key: The tag key
    • value: The tag value
  • [Permission[]]permissions: An array of Permission object instances representing permissions rules assigned to the content file

PATCH

Edits a content file on the network.

Parameters

filter:  An expression for filtering search results. The following are accepted expressions:

• [entry] IS '<value>'
• [entry] CONTAINS '<value>'
• [entry] IS IN ('<value_a>','<value_b>', [...])
• [entry] IS NOT IN ('<value_a>','<value_b>', [...])
• [entry] BEGINS WITH '<value>'

Request Body

Response Body

DELETE

Deletes the content file(s) that meet the specified filter criteria. If any matching content file is currently being used by a presentation, Dynamic Playlist, Live Media Feed, or Tagged Playlist, the entire DELETE operation will fail.

Parameters

Request Body

The server returns code 200 upon success. Upon failure, it returns code 400 with an error message.

Response Body

/content/{content_id}/

GET

...

Parameters

Request Body

Response Body

PUT

...

Parameters

Request Body

Response Body

PATCH

...

Parameters

Request Body

Response Body

DELETE

...

Parameters

Request Body

Response Body