Setup Package Entity (v3)

id string string read only read only a unique identifier of a given setup package version semver semver read only read only a semantic version which defines the format of this setup package entity, "3 0 0" by default bdeploy ownershipinfo ownershipinfo read only read only an docid\ t4fie7rscbtpg11t1 gkf which defines the creator of this setup package firmwareupdatesbyfamily firmwareupdatecollection firmwareupdatecollection read write read write a docid\ kkehbr5fgurgs9ters1wv which defines the bos version of each player family firmwareupdatetype string string read write read write one of "standard", "different", "newer", "save" enumeration values which determine the kind of target bos version setuptype string string read write read write either "standalone", "bsn", "lfn", "sfn", or "partnerapplication" bsndeviceregistrationtokenentity token string string read only read only the token granted for authentication purposes scope string string read only read only the scope granted by the token for example, a successful user authentication response will contain both "full" and "self" values validfrom datetime datetime read only read only the token will be valid from this date and time see docid\ dx1c8usfkxpwntprb9f t for more information about this data type validto datetime datetime read only read only the date and time that the token expires see docid\ dx1c8usfkxpwntprb9f t for more information about this data type 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 remotedwsenabled bool bool read write read write a flag which defines wherever the remote diagnostic web server should be enabled dwsenabled bool bool read write read write a flag which defines wherever the local diagnostic web server should be enabled dwspassword string string read write read write the password associated with the local diagnostic web server dwspasswordprevioussavedtimestamp long long read write read write a unix timestamp which defines when the local dws password was last saved lwsenabled bool bool read write read write a flag which defines wherever the local web server should be enabled lwsconfig string string read write read write a local web server operation mode which can be either "content" for lfn setup type and "status" for the other setup types the difference is if the lws server should be used for content publish lwsusername string string read write read write the local web server username (for example, "admin") lwspassword string string read write read write the local web server password lwsenableupdatenotifications bool bool read write read write whether or not enable update notifications is enabled bsncloudenabled bool bool read write read write a flag that indicates whether a player should connect and register in bsn cloud devicename string string read write read write the player name the maximum length of this string is 128 characters devicedescription string string read write read write a customer defined description of the player the description does not need to be unique within the scope of the account unitnamingmethod string string read write read write the player naming method appendnameandserial indicates that clients should append the player serial number to the player name unitnameonly indicates that nothing should be appended to the player name timezone string string read write read write the time zone a player should operate in, which is one of the values in docid\ hwr0zojgtzxxnuhdlhlf9 bsngroupname string string read write read write the name of the group instance to which the player is assigned timebetweennetconnects ushort ushort read write read write an interval in seconds of player settings and schedule synchronization with a bsn or sfn server timebetweenheartbeats ushort ushort read write read write an interval in seconds of player heartbeat reporting to a bsn or sfn server sfnwebfolderurl url url read write read write the base url of the target sfn folder which contains sync spec and related media content sfnusername string string read write read write the username the player should provide to authenticate on an sfn server using the basic authentication method sfnpassword string string read write read write the password the player should provide to authenticate on an sfn server using the basic authentication method sfnenablebasicauthentication bool bool read write read write a flag which defines whether basic authentication is required by the sfn server playbackloggingenabled bool bool read write read write a flag which defines whether or not playback logging is enabled on the associated player eventloggingenabled bool bool read write read write a flag which defines whether or not event logging is enabled on the associated player diagnosticloggingenabled bool bool read write read write a flag which defines w hether or not diagnostic logging is enabled on the associated player stateloggingenabled bool bool read write read write a flag which defines w hether or not state logging is enabled on the associated player variableloggingenabled bool bool read write read write a flag which defines w hether or not variable logging is enabled on the associated player uploadlogfilesatboot bool bool read write read write a flag which defines w hether autorun logs will be uploaded when the player boots uploadlogfilesatspecifictime bool bool read write read write a flag which defines whether autorun logs should be uploaded at a specific time of the day uploadlogfilestime int int read write read write the time in minutes when the player should upload autorun logs to the server if the uploadlogfilesatspecifictime flag is set loghandlerurl url url read write read write the optional address of a custom endpoint which handles the uploaded autorun logs enableremotesnapshot bool bool read write read write a flag which defines whether a player should capture and upload screenshots to the server remotesnapshotinterval int int read write read write the number of minutes to wait between capturing each snapshot remotesnapshotmaximages int int read write read write the maximum number of snapshot images to keep in the player storage possible values are 1 to 100 remotesnapshotjpegqualitylevel int int read write read write the jpeg quality level for the snapshot images, on a scale from 1 to 100 remotesnapshotscreenorientation string string read write read write the image orientation, which is one of "landscape", "portraitbottomright", or "portraitbottomleft" remotesnapshothandlerurl url url read write read write the optional address of a custom endpoint which handles the uploaded snapshot images idlescreencolor object object optional optional an object with rgba properties the default color is black r byte byte read write read write the value of the red color channel in byte code g byte byte read write read write the value of the green color channel in byte code b byte byte read write read write the value of the blue color channel in byte code a byte byte read write read write the value of the alpha channel in byte code networkdiagnosticsenabled bool bool read write read write a flag which defines whether a player should perform network diagnostics during setup and display the results on the screen testethernetenabled bool bool read write read write a flag which defines whether a player should perform ethernet connection diagnostics during setup and display the results on the screen testwirelessenabled bool bool read write read write a flag which defines whether a player should perform wi fi connection during setup and display the results on the screen testinternetenabled bool bool read write read write a flag which defines whether a player should check whether the bsn server is accessible during setup and display the results on the screen usecustomsplashscreen bool bool read write read write a flag which defines whether a player should display a custom splash screen during setup brightwallname string string read write read write the optional name of the brightwall instance to which the player should be assigned brightwallscreennumber string string read write read write the optional number of the brightwall screen to which the player should be assigned contentdownloadsrestricted bool bool read write read write a flag which defines whether a player should download media content only within the specified time window contentdownloadrangestart int int read write read write a time of the day in minutes when the player may start the media content download contentdownloadrangeend int int read write read write a time of the day in minutes when the player should stop the media content download heartbeatsrestricted bool bool read write read write a flag which defines whether a player should report heartbeats to the bsn com server heartbeatsrangestart int int read write read write a time of the day in minutes when the player may start the heartbeat reporting period heartbeatsrangeend int int read write read write a time of the day in minutes when the player should finish the heartbeat reporting period usbupdatepassword string string optional optional the password for the usb update feature inheritnetworkproperties bool bool read write read write a flag which defines whether a player should keep the existing network settings during registration internalcaartifacts internalcaartifacts\[] internalcaartifacts\[] optional optional a list of certificate objects each object has a name and an asset (the certificate file object) this can be an empty object