rDWS Other Endpoints

base url for these endpoints https //ws bsn cloud/rest/v1/ delete /storage/{\ device name}/ reformats the specified storage device you must disable the autorun before reformatting the sd card on your device to disable the autorun, use the put /v1/control/reboot with body parameter { “autorun” ”disable” }, as described in rdws control endpoints docid\ djbuqhnmn5eoacqtmrm78 this can also be done in the local dws diagnostics tab segment device name string string the specified storage device (see rostorageinfo docid\ bczooenmoifnrbeny6zki for a list of available devices) request body fs string string the global functions docid\ nsjxffr7olfgdwgjfebme to use when reformatting a storage device the default value of fs is "exfat" request example delete /rest/v1/storage/sd/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json content type application/json content length 49 this is the example request body { "data" { "fs" "exfat" } } response example { "data" { "result" { "success" true, "output" "format completeted successfully ", "error" "" } }, "route" "/v1/storage/sd", "method" "delete" } get /re provision/ calling this endpoint will re provision the player (in other words, the b deploy/provisioning setup currently associated with the player will be downloaded, and the device will go through setup again) the brightauthor\ connected ui feature that uses this functionality is diagnostic web server (dws) docid\ qxt4yhey7iej m9dh73wm the re provision process involves the following steps if the “networking” section of the player’s registry contains the access and refresh tokens, it is assumed that the player was previously set up for bsn cloud so brightsign keeps some setup related keys in the networking section (see "setup related keys", below) and deletes the rest of the registry entries if the networking section does not include access and refresh tokens, it will empty the whole networking section, format the sd card, and reboot to try to provision the player brightsign also sets the “devicesetupcomplete“ parameter in the “autorun” section to null, so that the player can set up again this key is set to 1 only if the player was previously set up through the on device setup option the code removes all files from the default storage device (this is almost always the sd card) you do not need to format the storage separately the player reboots, fetches the setup package from b deploy, and re provisions itself setup related keys \ inp (inherit network properties) \ networkjson (network settings in json format setup version v3) \ modem json (default settings for modem configuration in json format) \ wifi (use wireless) \ ss (wifi ssid) \ pp (wifi passphrase) the first network interface, either ethernet or wifi \ dhcp (use dhcp) \ sip (static ip address) \ sm (subnet mask) \ gw (gateway) \ dns1 (first dns) \ dns2 (second dns) \ dns3 (third dns) the second network interface, either ethernet or wifi \ dhcp2 \ sip2 \ sm2 \ gw2 \ dns12 \ dns22 \ dns32 \ ncp (wired connection priority) \ ncp2 (wireless connection priority) \ up (use proxy) \ ps (proxy server url) \ bph (proxy bypass list) \ ts (time servers list) rate limits for the first network interface, ethernet or wifi \ rlmid (rate limit mode during initial downloads) \ rlrid (rate limit value during initial downloads) \ rlmow (rate limit mode outside download window) \ rlrow (rate limit value outside download window) \ rlmiw (rate limit mode inside download window) \ rlriw (rate limit value inside download window) rate limits for the second network interface, ethernet or wifi \ rlmid2 \ rlrid2 \ rlmow2 \ rlrow2 \ rlmiw2 \ rlriw2 enabled flag values for the ethernet interface \ cwr (content transfers enabled) \ twr (text feed transfers enabled) \ mwr (media feed transfers enabled) \ hwr (health transfers enabled) \ lwr (log upload transfers enabled) enabled flag values for the wifi interface \ cwf \ twf \ mwf \ hwf \ lwf if vlanids = 25 \ usedhcp vlan 25 \ staticipaddress vlan 25 \ subnetmask vlan 25 \ gateway vlan 25 \ dns1 vlan 25 \ dns2 vlan 25 \ dns3 vlan 25 request example get /rest/v1/re provision/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json response body success bool bool true means that the operation succeeded and the player will reboot false means that the operation failed response example { "route" "/v1/re provision", "method" "get", "data" { "result" { "success" true } } } post /snapshot/ takes a screenshot of the current screen contents and saves it to storage see remote dws apis docid\ kku9e7f7chc5lwofxs9e0 for the query string parameters request example post /rest/v1/snapshot/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} response body remotesnapshotthumbnail string string a snapshot image thumbnail in base64 format filename string string the name and path of the snapshot image file call get /file/{\ path } to retrieve the full resolution image timestamp string string the date and time the snapshot was taken the date/time is formatted as " yyyy mm dd hh\ mm\ ss \<timezone>" response example { "route" "/v1/snapshot", "method" "post", "data" { "result" { "remotesnapshotthumbnail" "data\ image/jpeg;base64,/9j/4aaqskzjrgabaqaaaqabaad/4qderxhpzgaasukqaagaaaabagmhbaabaaaaggaaaaaaaaakaa8bagalaaaataaaababagahaaaawaaaadebagaiaaaaraaaadibagauaaaamaaaadsbaganaaaayaaaacqicaabaaaagi8aaacqbwaeaaaamdixmaggawabaaaaaqaaaakgbaabaaaagacaaaogbaabaaaaoaqaaaaaaaaymdi0ojayoja3idexojm2ojmwahy5ljauotcaqnjpz2h0u2lnbgaaweqxmdm1aabnneuzm0qwmdy4mjqaap/baiqaaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqeb/8aaeqgauab4aweraairaqmraf/eaaiaaaefaqebaqebaaaaaaaaaaabagmebqyhcakkcxaaagedawieawufbaqaaaf9aqidaaqrbrihmuege1fhbyjxfdkbkaeii0kxwrvs0fakm2jyggkkfhcygroljicokso0nty3odk6q0rfrkdisuptvfvwv1hzwmnkzwznaglqc3r1dnd4exqdhiwgh4ijipktljwwl5izmqkjpkwmp6ipqrkztlw2t7i5usldxmxgx8jjytlt1nxw19jz2uhi4+tl5ufo6erx8vp09fb3+pn6aqadaqebaqebaqebaaaaaaaaaqidbaugbwgjcgsraaibagqeawqhbqqeaaecdwabagmrbauhmqysqvehyxetijkbcbrckagxwqkjm1lwfwjy0qowjdthjfexgbkajicokso1njc4otpdrevgr0hjslnuvvzxwflay2rlzmdoawpzdhv2d3h5eokdhiwgh4ijipktljwwl5izmqkjpkwmp6ipqrkztlw2t7i5usldxmxgx8jjytlt1nxw19jz2ulj5oxm5+jp6vlz9px29/j5+v/aaawdaqaceqmrad8a/e+v9wd+4aoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakap8a/9k=", "filename" "/sd/remote snapshots/img 2024 02 07 11 36 30 jpg", "timestamp" "2024 02 07 11 36 33 pst", "devicename" "xd5 re433d006644", "width" 1920, "height" 1080 } } } put /custom/ sends custom data to the player the player in turn sends the data as a message (in json string format) on udp port 5000, which can then be captured by the autorun brs or a javascript application on the player request body command string string the custom data to send returnimmediately bool bool a flag specifying whether the server should respond to the put request immediately ( true ) or wait on a response to the udp message from the brightscript/javascript application ( false ) request example put /rest/v1/custom/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json content type application/json content length 89 this is the example request body { "data" { "command" "next", "returnimmediately" true } } response body if the returnimmediately property is true , the server will return a success or error message if the property is false , the server will wait for a response from udp port 5000 on the player and send it as the response to the put request response example { "data" { "result" { "success" true } }, "route" "/v1/custom", "method" "put" } get /download firmware/ instructs the player to download and apply a firmware update query string parameter url string string the public url for downloading the firmware update file request example get /rest/v1/download firmware/?url=https //bsncloud s3 amazonaws com/public/cobra 9 0 110 update bsfw\&destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json response body success bool bool a flag indicating whether the download was successful reboot bool bool a flag indicating whether the player will reboot when applying a firmware update response example { "route" "/v1/download firmware", "method" "get", "data" { "result" { "success" true, "reboot" true } } }