Content Endpoints

/content/

GET

Retrieves a list of content files on the network.

Parameters

• pageIndex: 
• 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 Presentation instances exceeds the pageSize.
• pageSize: The maximum number of Presentation instances that can be contained in the response body
• sort:

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: 
• [string] filterExpression:
• [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:
    • [string] name: 
    • [int] id: 
    • [string] type: 

PATCH

...

Parameters

Request Body

Response Body

DELETE

...

Parameters

Request Body

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