Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: updated format for clarity

All content entities are structured as follows:

entity:

  • [Id int] Id: A unique identifier for the content instance
  • [FileName string] FileName: The name of the content instance. The maximum length of this string is 128 characters.

  • [PhysicalPath string] PhysicalPathThe location of the content instance in the server directory

  • [VirtualPath string] VirtualPathThe location of the content instance in the BSN virtual directory

  • [ThumbPath string] ThumbPathThe 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.

  • [MediaType MediaType] MediaType: The content instance media type. One of "Auxiliary", "Stylesheet", "Font", "Text", "Image", "Video", or "Audio"

  • [FileSize long] FileSize: The content instance file size

  • [FileHash string] FileHashThe content instance 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").

  • [UploadDate DateTime] UploadDateA timestamp indicating when the content instance was uploaded to the network. See DateTime for more information about this data type.

  • [LastModifiedDate DateTime] LastModifiedDateA timestamp indicating when the content metadata was last modified on the network (for example, when permissions are edited or the file is moved from one folder to another). This is reported by the customer's file system. See DateTime for more information about this data type. 

  • [FileLastModifiedDate DateTime] FileLastModifiedDate: A timestamp indicating when the physical content was last modified on the network (for example, if the file was overridden). This is reported by the customer's file system. See DateTime for more information about this data type.

  • [ProbeDatastring] ProbeDataThe audio/video probe data. This value is a blank string for image, text, and unknown file types.

  • [Metadata Dictionary<string, object>] MetadataThe array of key/value pairs that specify the metadata assigned to the content instance.

  • [DynamicPlaylists DynamicPlaylistInfo[]] DynamicPlaylistsAn array of DynamicPlaylist object instances representing dynamic playlists that contain the content instance. Supported representations are:

    • [Id int] Id: A unique identifier for the dynamic playlist instance

    • [Namestring] Name: The dynamic playlist name

  • [LiveMediaFeeds LiveMediaFeedInfo[]] LiveMediaFeedsAn array of LiveMediaFeed object instances representing live media feeds that contain the content instance. Supported representations are:

    • [Id int] Id: A unique identifier for the live media feed instance

    • [Namestring] Name: The live media feed name

  • [TaggedPlaylists TaggedPlaylistInfo[]] TaggedPlaylistsAn array of TaggedPlaylist object instances representing tagged playlists that contain the content instance. Supported representations are:

    • [Id int] Id: A unique identifier for the tagged playlist instance
    • [Namestring] Name: The tagged playlist name
  • [Presentations PresentationInfo[]] PresentationsAn array of Presentation Info entities for each presentation that uses the content instance

  • [Tags Dictionary<string, string>] TagsThe array of key/value pairs that specify the tags to assign to the content file. Each tag must be formatted as follows: "<value_type>::<tag_type>.<tag_key>":"<value>".

  • [Permissions List<Permission>] Permissions: A list of permission object instances representing permissions rules assigned to the content folder