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
] Id[Name
: The group name. The maximum length of this string is 50 characters.string
] Name
: Indicates when the group was created on BSN.cloud. See DateTime for more information about this data type.[DateTime] C
reationDateDateTime
: Indicates when the group was last modified on BSN.cloud. See DateTime for more information about this data type.
astModifiedDate[DateTime] L
DateTime
[Autorun
] Autorun:DeviceAutorunInfo
The current BrightAuthor:connected autorun version assigned to the group[Version
:
] Versionstring
[IsCustom
: Whether the autorun is a standard BrightAuthor:connected file (bool
] IsCustomfalse
) or a custom-built file (true
)
[HDX23Firmware
The minimum version of device firmware required to play presentations on the HD223/HD1023
] HDX23Firmware:string
[HDX23FirmwareId
: A unique identifier for the HD223/HD1023 minimum firmware version
] HDX23FirmwareIdint
[LSX23Firmware
The minimum version of device firmware required to play presentations on the LS423
] LSX23Firmware:string
[LSX23FirmwareId
: A unique identifier for the LS423 minimum firmware version
] LSX23FirmwareIdint
[HSX23Firmware
The minimum version of device firmware required to play presentations on the HS123
] HSX23Firmware:string
[HSX23FirmwareId
: A unique identifier for the HS123 minimum firmware version
] HSX23FirmwareIdint
[HOX23Firmware
The minimum version of device firmware required to play presentations on the HO523
] HOX23Firmware:string
[HOX23FirmwareId
A unique identifier for the HO523 minimum firmware version
] HOX23FirmwareId:int
[XDX33Firmware
: The minimum version of device firmware required to play presentations on the XD233/XD1033
] XDX33Firmwarestring
[XDX33FirmwareId
: A unique identifier for the XD233/XD1033 minimum firmware version
] XDX33FirmwareIdint
[XTX43Firmware
: The minimum version of device firmware required to play presentations on the XT242/XT1042/XT1142
] XTX43Firmwarestring
[XTX43FirmwareId
: A A unique identifier for the XT242/XT1042/XT1142 minimum firmware version
] XTX43FirmwareIdint
[string] XDX34_XTX44FirmwareXTX44Firmware
: A unique identifier for the XD234/XD1034 minimum firmware versionstring
[int] XDX34_XTX44FirmwareId
: AXDX34_XTX44FirmwareId
: A unique identifier for the XD234/XD1034 minimum firmware versionint
[string] HDX4_HSX4_LSX4FirmwareLSX4Firmware
: A unique identifier for the HD224/HD1024/LS424 and HSX4 minimum firmware versionstring
[int] HDX4HDX4_HSX4_LSX4FirmwareIdLSX4FirmwareId
: A 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 AU335
] AUX5Firmwarestring
[AUX5FirmwareId
: A unique identifier for the AU335 minimum firmware version
] AUX5FirmwareIdint
[FKX42Firmware
: The minimum version of device firmware required to play presentations on the 4K242, 4K1042 and 4K1142
] FKX42Firmwarestring
[FKX42FirmwareId
: A A unique identifier for the 4K242, 4K1042 and 4K1142 minimum firmware version
] FKX42FirmwareIdint
[EnableSerialDebugging
: A flag specifying whether serial debugging should be enabled for all players assigned to the Group instance
] EnableSerialDebuggingbool
[EnableSystemLogDebugging
: A A flag specifying whether system log debugging should be enabled for players assigned to the Group instance
] EnableSystemLogDebuggingbool
[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
] EnableStorageSpaceLimittrue
.[StorageSpaceLimitUnits
: A value specifying whether the following "limit" values are measured in percentages (StorageSpaceLimitUnit
] StorageSpaceLimitUnits"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.
] PublishedDataSizeLimitushort
[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.
] DynamicDataSizeLimitushort
[HtmlDataSizeLimit
: The maximum size of the HTML application cache
] HtmlDataSizeLimitushort
[HtmlLocalStorageSizeLimit
: The maximum size of all JavaScript variables and data
] HtmlLocalStorageSizeLimitushort
[WebDatabaseSizeLimit
: The maximum amount of storage allocated to the IndexedDB web database application
] WebDatabaseSizeLimitushort
[DevicesCount
: The number of players assigned to the group instanceushort
] DevicesCount[DevicesHealthStatus
: Returns "Ok", "Warning", or "Error" depending on the player healthDictionary<DeviceHealthStatus, uint>
] DevicesHealthStatus[Devices
Supported representations include:DeviceInfo[]
] Devices:[Id
The unique identifier for the device
] Id:int
[Serial
: The device serial number
] Serialstring
The scheduled presentation entity. See Scheduled Presentation Entity[Schedule
] Schedule:ScheduledPresentation[]
[Permissions
A list of the permissions rules assigned to the groupList<Permission>
] Permissions: