Content Entity (2022/06)

Owned by BrightSign TechDocs
Last updated: Sept 29, 2023
2 min read

All content entities are structured as follows:

entity:

  • Id int read-only: A unique identifier for the content instance

  • FileName string read-only: The name of the content instance. The maximum length of this string is 128 characters.

  • PhysicalPath string read-only: The location of the content instance in the server directory

  • VirtualPath string read-write: The location of the content instance in the BSN virtual directory

  • ThumbPath string read-only: 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.

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

  • FileSize long read-only: The content instance file size

  • FileHash string read-only: The 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 read-only: A timestamp indicating when the content instance was uploaded to the network. See DateTime for more information about this data type.

  • LastModifiedDate DateTime read-only: A 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 read-only: 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.

  • ProbeData string read-only: The audio/video probe data. This value is a blank string for image, text, and unknown file types.

  • Metadata Dictionary<string, object> read-only: The array of key/value pairs that specify the metadata assigned to the content instance.

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

    • Id int read-only: A unique identifier for the dynamic playlist instance

    • Name string read-only: The dynamic playlist name

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

    • Id int read-only: A unique identifier for the live media feed instance

    • Name string read-only: The live media feed name

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

    • Id int read-only: A unique identifier for the tagged playlist instance

    • Name string read-only: The tagged playlist name

  • Presentations PresentationInfo[] read-only: An array of Presentation Info entities for each presentation that uses the content instance

  • Tags Dictionary<string, string> read-write: The 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 Permission[] read-write: A list of permission object instances representing permissions rules assigned to the content folder