Cloud APIs
...
Data Types (2022/06)
Custom Data Types (2022/06)
Regular Groups Entity (2022/06)
1min
all regular groups entities are structured as follows entity id int int read only read only a unique identifier for the regular group instance this value is generated by the server when the group is created name string string read write read write the group name the maximum length of this string is 50 characters creationdate datetime datetime read only read only indicates when the group was created on bsn cloud see custom data types (2022/06) docid\ dx1c8usfkxpwntprb9f t for more information about this data type lastmodifieddate datetime datetime read only read only indicates when the group was last modified on bsn cloud see custom data types (2022/06) docid\ dx1c8usfkxpwntprb9f t for more information about this data type autorun deviceautoruninfo deviceautoruninfo read only read only version string string read only read only the current brightauthor\ connected autorun version assigned to the group iscustom bool bool read only read only whether the autorun is a standard brightauthor\ connected file ( false ) or a custom built file ( true ) hdx23firmware string string read write read write the minimum version of device firmware required to play presentations on the hd223/hd1023 hdx23firmwareid int int read write read write a unique identifier for the hd223/hd1023 minimum firmware version lsx23firmware string string read write read write the minimum version of device firmware required to play presentations on the ls423 lsx23firmwareid int int read write read write a unique identifier for the ls423 minimum firmware version hsx23firmware string string read write read write the minimum version of device firmware required to play presentations on the hs123 hsx23firmwareid int int read write read write a unique identifier for the hs123 minimum firmware version hox23firmware string string read write read write the minimum version of device firmware required to play presentations on the ho523 hox23firmwareid int int read write read write a unique identifier for the ho523 minimum firmware version xdx33firmware string string read write read write the minimum version of device firmware required to play presentations on the xd233/xd1033 xdx33firmwareid int int read write read write a unique identifier for the xd233/xd1033 minimum firmware version xtx43firmware string string read write read write the minimum version of device firmware required to play presentations on the xt242/xt1042/xt1142 xtx43firmwareid int int read write read write a unique identifier for the xt242/xt1042/xt1142 minimum firmware version xdx34 xtx44firmware string string read write read write the minimum version of device firmware required to play presentations on the xd234/xd1034 xdx34 xtx44firmwareid int int read write read write a unique identifier for the xd234/xd1034 minimum firmware version hdx4 hsx4 lsx4firmware string string read write read write the minimum version of device firmware required to play presentations on the hd224/hd1024/ls424 and hsx4 hdx4 hsx4 lsx4firmwareid int int read write read write a unique identifier for the hd224/hd1024/ls424 and hsx4 minimum firmware version aux5firmware string string read write read write the minimum version of device firmware required to play presentations on the au335 aux5firmwareid int int read write read write a unique identifier for the au335 minimum firmware version fkx42firmware string string read write read write the minimum version of device firmware required to play presentations on the 4k242, 4k1042 and 4k1142 fkx42firmwareid int int read write read write a unique identifier for the 4k242, 4k1042 and 4k1142 minimum firmware version xcx55firmware string string read write read write the minimum version of device firmware required to play presentations on the xc5 xcx55firmwareid int int read write read write a unique identifier for the xc5 minimum firmware version xtx45 xdx35 hdx25 ls4x5 hs1x5firmware string string read write read write the minimum version of device firmware required to play presentations on these players xtx45 xdx35 hdx25 ls4x5 hs1x5firmwareid int int read write read write a unique identifier for the minimum firmware version of these players lg4x5firmware string string read write read write the minimum version of device firmware required to play presentations on lg445 players lg4x5firmwareid int int read write read write a unique identifier for the minimum firmware version of lg445 players enableserialdebugging bool bool read write read write a flag specifying whether serial debugging should be enabled for all players assigned to the group instance enablesystemlogdebugging bool bool read write read write a flag specifying whether system log debugging should be enabled for players assigned to the group instance enablestoragespacelimit bool bool read write read write a flag specifying whether player storage devices will be divided into different segments this allows the user to allot maximum sizes to different segments to ensure that a certain type of data does not take up too much space on the storage device the "limit" values below will only apply to the player storage if this value is true storagespacelimitunits storagespacelimitunit storagespacelimitunit read write read write a value specifying whether the following "limit" values are measured in percentages ( "percentage" ) or megabytes ( "megabyte" ) publisheddatasizelimit ushort ushort read write read write the maximum size allotted to all presentation and content files that are written to the storage device during the publish process this includes audio, video, images, text, and html content files dynamicdatasizelimit ushort ushort read write read write the maximum size of all dynamic content, including dynamic playlists and mrss feeds when this segment runs out of space, dynamic content files will be deleted to create space, starting with the oldest files first htmldatasizelimit ushort ushort read write read write the maximum size of the html application cache htmllocalstoragesizelimit ushort ushort read write read write the maximum size of all javascript variables and data webdatabasesizelimit ushort ushort read write read write the maximum amount of storage allocated to the indexeddb web database application devicescount ushort ushort read only read only the number of players assigned to the group instance deviceshealthstatus dictionary\<devicehealthstatus, uint> dictionary\<devicehealthstatus, uint> read only read only returns "ok", "warning", or "error" depending on the player health devices deviceinfo\[] deviceinfo\[] read only read only supported representations include id int int read only read only the unique identifier for the device serial string string read only read only the device serial number schedule scheduledpresentation\[] scheduledpresentation\[] read only read only the scheduled presentation entity see scheduled presentation entity (2022/06) docid\ drsrsrfhj2cz61wdol7qm permissions permission\[] permission\[] read write read write a list of the permissions rules assigned to the group