All regular groups entities are structured as follows:
entity
:
Id
: A unique identifier for the regular group instance. This value is generated by the server when the group is createdint
Name
: The group name. The maximum length of this string is 50 characters.string
: Indicates when the group was created on BSN.cloud. See DateTime for more information about this data type.C
reationDateDateTime
: Indicates when the group was last modified on BSN.cloud. See DateTime for more information about this data type.
astModifiedDateL
DateTime
Autorun
:DeviceAutorunInfo
The current BrightAuthor:connected autorun version assigned to the groupVersion
:string
IsCustom
: Whether the autorun is a standard BrightAuthor:connected file (bool
false
) or a custom-built file (true
)
HDX23Firmware
The minimum version of device firmware required to play presentations on the HD223/HD1023
:string
HDX23FirmwareId
: A unique identifier for the HD223/HD1023 minimum firmware versionint
LSX23Firmware
The minimum version of device firmware required to play presentations on the LS423
:string
LSX23FirmwareId
: A unique identifier for the LS423 minimum firmware versionint
HSX23Firmware
The minimum version of device firmware required to play presentations on the HS123
:string
HSX23FirmwareId
: A unique identifier for the HS123 minimum firmware versionint
HOX23Firmware
The minimum version of device firmware required to play presentations on the HO523
:string
HOX23FirmwareId
A unique identifier for the HO523 minimum firmware version
:int
XDX33Firmware
: The minimum version of device firmware required to play presentations on the XD233/XD1033string
XDX33FirmwareId
: A unique identifier for the XD233/XD1033 minimum firmware versionint
XTX43Firmware
: The minimum version of device firmware required to play presentations on the XT242/XT1042/XT1142string
XTX43FirmwareId
: A unique identifier for the XT242/XT1042/XT1142 minimum firmware versionint
XDX34_XTX44Firmware
: The minimum version of device firmware required to play presentations on the XD234/XD1034string
XDX34_XTX44FirmwareId
: A unique identifier for the XD234/XD1034 minimum firmware versionint
HDX4_HSX4_LSX4Firmware
: The minimum version of device firmware required to play presentations on the HD224/HD1024/LS424 and HSX4string
HDX4_HSX4_LSX4FirmwareId
: A unique identifier for the HD224/HD1024/LS424 and HSX4 minimum firmware versionint
AUX5Firmware
: The minimum version of device firmware required to play presentations on the AU335string
AUX5FirmwareId
: A unique identifier for the AU335 minimum firmware versionint
FKX42Firmware
: The minimum version of device firmware required to play presentations on the 4K242, 4K1042 and 4K1142string
FKX42FirmwareId
: A unique identifier for the 4K242, 4K1042 and 4K1142 minimum firmware versionint
XCX55Firmware string:
The minimum version of device firmware required to play presentations on the XC5XCX55FirmwareId int:
A unique identifier for the XC5 minimum firmware versionXTx45_XDx35_HDx25_LS4x5_HS1x5Firmware string:
The minimum version of device firmware required to play presentations on the XD5XTx45_XDx35_HDx25_LS4x5_HS1x5FirmwareId int:
A unique identifier for the XD5 minimum firmware versionEnableSerialDebugging
: A flag specifying whether serial debugging should be enabled for all players assigned to the Group instancebool
EnableSystemLogDebugging
: A flag specifying whether system log debugging should be enabled for players assigned to the Group instancebool
EnableStorageSpaceLimit
: 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 isbool
true
.StorageSpaceLimitUnits
: A value specifying whether the following "limit" values are measured in percentages (StorageSpaceLimitUnit
"Percentage"
) or megabytes ("Megabyte"
)PublishedDataSizeLimit
: 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.ushort
DynamicDataSizeLimit
: 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.ushort
HtmlDataSizeLimit
: The maximum size of the HTML application cacheushort
HtmlLocalStorageSizeLimit
: The maximum size of all JavaScript variables and dataushort
WebDatabaseSizeLimit
: The maximum amount of storage allocated to the IndexedDB web database applicationushort
DevicesCount
: The number of players assigned to the group instanceushort
DevicesHealthStatus
: Returns "Ok", "Warning", or "Error" depending on the player healthDictionary<DeviceHealthStatus, uint>
Devices
Supported representations include:DeviceInfo[]
:Id
The unique identifier for the device
:int
Serial
: The device serial numberstring
The scheduled presentation entity. See Scheduled Presentation EntitySchedule
:ScheduledPresentation[]
Permissions
A list of the permissions rules assigned to the groupList<Permission>
: