Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • [int] totalItemCount: The total number of Content instances 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: 
    Anchor
    content_object
    content_object
    • [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] fileSize: The file size (in bytes)
    • [string] fileHash: The hash algorithm and the value that results from performing the hash algorithm on the file. 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 associative array that represent represents 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 key/value) or "[sys].[Content]" (a system-defined key/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

...