Regular Groups Entity (2022/06)
1 min
all regular groups entities are structured as follows entity id \<font color="#704ae0">int\</font> \<font color="#01a0af">read only\</font> a unique identifier for the regular group instance this value is generated by the server when the group is created name \<font color="#704ae0">string\</font> \<font color="#01a0af">read write\</font> the group name the maximum length of this string is 50 characters creationdate \<font color="#704ae0">datetime\</font> \<font color="#01a0af">read only\</font> indicates when the group was created on bsn cloud see datetime docid\ dx1c8usfkxpwntprb9f t for more information about this data type lastmodifieddate \<font color="#704ae0">datetime\</font> \<font color="#01a0af">read only\</font> indicates when the group was last modified on bsn cloud see datetime docid\ dx1c8usfkxpwntprb9f t for more information about this data type autorun \<font color="#704ae0">deviceautoruninfo\</font> \<font color="#01a0af">read only\</font> version \<font color="#704ae0">string\</font> \<font color="#01a0af">read only\</font> the current brightauthor\ connected autorun version assigned to the group iscustom \<font color="#704ae0">bool\</font> \<font color="#01a0af">read only\</font> whether the autorun is a standard brightauthor\ connected file ( false ) or a custom built file ( true ) hdx23firmware \<font color="#704ae0">string\</font> \<font color="#01a0af">read write\</font> the minimum version of device firmware required to play presentations on the hd223/hd1023 hdx23firmwareid \<font color="#704ae0">int\</font> \<font color="#01a0af">read write\</font> a unique identifier for the hd223/hd1023 minimum firmware version lsx23firmware \<font color="#704ae0">string\</font> \<font color="#01a0af">read write\</font> the minimum version of device firmware required to play presentations on the ls423 lsx23firmwareid \<font color="#704ae0">int\</font> \<font color="#01a0af">read write\</font> a unique identifier for the ls423 minimum firmware version hsx23firmware \<font color="#704ae0">string\</font> \<font color="#01a0af">read write\</font> the minimum version of device firmware required to play presentations on the hs123 hsx23firmwareid \<font color="#704ae0">int\</font> \<font color="#01a0af">read write\</font> a unique identifier for the hs123 minimum firmware version hox23firmware \<font color="#704ae0">string\</font> \<font color="#01a0af">read write\</font> the minimum version of device firmware required to play presentations on the ho523 hox23firmwareid \<font color="#704ae0">int\</font> \<font color="#01a0af">read write\</font> a unique identifier for the ho523 minimum firmware version xdx33firmware \<font color="#704ae0">string\</font> \<font color="#01a0af">read write\</font> the minimum version of device firmware required to play presentations on the xd233/xd1033 xdx33firmwareid \<font color="#704ae0">int\</font> \<font color="#01a0af">read write\</font> a unique identifier for the xd233/xd1033 minimum firmware version xtx43firmware \<font color="#704ae0">string\</font> \<font color="#01a0af">read write\</font> the minimum version of device firmware required to play presentations on the xt242/xt1042/xt1142 xtx43firmwareid \<font color="#704ae0">int\</font> \<font color="#01a0af">read write \</font> a unique identifier for the xt242/xt1042/xt1142 minimum firmware version xdx34 xtx44firmware \<font color="#704ae0">string\</font> \<font color="#01a0af">read write\</font> the minimum version of device firmware required to play presentations on the xd234/xd1034 xdx34 xtx44firmwareid \<font color="#704ae0">int\</font> \<font color="#01a0af">read write\</font> a unique identifier for the xd234/xd1034 minimum firmware version hdx4 hsx4 lsx4firmware \<font color="#704ae0">string\</font> \<font color="#01a0af">read write\</font> the minimum version of device firmware required to play presentations on the hd224/hd1024/ls424 and hsx4 hdx4 hsx4 lsx4firmwareid \<font color="#704ae0">int\</font> \<font color="#01a0af">read write\</font> a unique identifier for the hd224/hd1024/ls424 and hsx4 minimum firmware version aux5firmware \<font color="#704ae0">string\</font> \<font color="#01a0af">read write\</font> the minimum version of device firmware required to play presentations on the au335 aux5firmwareid \<font color="#704ae0">int\</font> \<font color="#01a0af">read write\</font> a unique identifier for the au335 minimum firmware version fkx42firmware \<font color="#704ae0">string\</font> \<font color="#01a0af">read write\</font> the minimum version of device firmware required to play presentations on the 4k242, 4k1042 and 4k1142 fkx42firmwareid \<font color="#704ae0">int\</font> \<font color="#01a0af">read write\</font> a unique identifier for the 4k242, 4k1042 and 4k1142 minimum firmware version xcx55firmware \<font color="#704ae0">string\</font> \<font color="#01a0af">read write\</font> the minimum version of device firmware required to play presentations on the xc5 xcx55firmwareid \<font color="#704ae0">int\</font> \<font color="#01a0af">read write\</font> a unique identifier for the xc5 minimum firmware version xtx45 xdx35 hdx25 ls4x5 hs1x5firmware \<font color="#704ae0">string \</font> \<font color="#01a0af">read write\</font> the minimum version of device firmware required to play presentations on hd5, hs5, ls5, xd5, and xt5 players xtx45 xdx35 hdx25 ls4x5 hs1x5firmwareid \<font color="#704ae0">int\</font> \<font color="#01a0af">read write\</font> a unique identifier for the minimum firmware version of hd5, hs5, ls5, xd5, and xt5 players lguv5nfirmware \<font color="#704ae0">string\</font> \<font color="#01a0af">read write\</font> the minimum version of device firmware required to play presentations on lguv5n players lguv5nfirmwareid \<font color="#704ae0">int\</font> \<font color="#01a0af">read write\</font> a unique identifier for the minimum firmware version of lguv5n players hdx26 xdx36 xs156firmware \<font color="#704ae0">string\</font> \<font color="#01a0af">read write\</font> the minimum version of device firmware required to play presentations on hd6, xd6, xs6 players hdx26 xdx36 xs156firmwareid \<font color="#704ae0">int\</font> \<font color="#01a0af">read write\</font> a unique identifier for the minimum firmware version of hd6, xd6, xs6 players enableserialdebugging \<font color="#704ae0">bool\</font> \<font color="#01a0af">read write\</font> a flag specifying whether serial debugging should be enabled for all players assigned to the group instance enablesystemlogdebugging \<font color="#704ae0">bool\</font> \<font color="#01a0af">read write\</font> a flag specifying whether system log debugging should be enabled for players assigned to the group instance enablestoragespacelimit \<font color="#704ae0">bool\</font> \<font color="#01a0af">read write\</font> 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 \<font color="#704ae0">storagespacelimitunit\</font> \<font color="#01a0af">read write\</font> a value specifying whether the following "limit" values are measured in percentages ( "percentage" ) or megabytes ( "megabyte" ) publisheddatasizelimit \<font color="#704ae0">ushort\</font> \<font color="#01a0af">read write\</font> 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 \<font color="#704ae0">ushort\</font> \<font color="#01a0af">read write\</font> 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 \<font color="#704ae0">ushort\</font> \<font color="#01a0af">read write\</font> the maximum size of the html application cache htmllocalstoragesizelimit \<font color="#704ae0">ushort\</font> \<font color="#01a0af">read write\</font> the maximum size of all javascript variables and data webdatabasesizelimit \<font color="#704ae0">ushort\</font> \<font color="#01a0af">read write\</font> the maximum amount of storage allocated to the indexeddb web database application devicescount \<font color="#704ae0">ushort\</font> \<font color="#01a0af">read only\</font> the number of players assigned to the group instance deviceshealthstatus \<font color="#704ae0">dictionary\<devicehealthstatus, uint\>\</font> \<font color="#01a0af">read only\</font> returns "ok", "warning", or "error" depending on the player health devices \<font color="#704ae0">deviceinfo\[]\</font> \<font color="#01a0af">read only\</font> supported representations include id \<font color="#704ae0">int\</font> \<font color="#01a0af">read only\</font> the unique identifier for the device serial \<font color="#704ae0">string\</font> \<font color="#01a0af">read only\</font> the device serial number schedule \<font color="#704ae0">scheduledpresentation\[]\</font> \<font color="#01a0af">read only\</font> the scheduled presentation entity see scheduled presentation entity docid\ drsrsrfhj2cz61wdol7qm permissions \<font color="#704ae0">permission\[]\</font> \<font color="#01a0af">read write\</font> a list of the permissions rules assigned to the group