Cloud APIs
...
BSN.Cloud Main APIs
Main API version 2022/06

Devices Endpoints (2022/06)

139min
this endpoint allows for management and monitoring of devices on the network base url for these endpoints https //api bsn cloud/2022/06/rest/devices get / retrieves a list of devices on the network required scope token bsn api main devices retrieve query string parameters filter string string optional optional an filtering and sorting expressions in the main api docid 3l0afyd3xooe ytvfk2vs for filtering search results the default value is null sort string string optional optional an expression for sorting the search results the sort expression specifies the entry used for sorting and the ascending/descending (asc/desc) sorting order (e g " \[device] \[serial] asc ") marker string string optional optional a value specifying which page to retrieve this value is useful if the istruncated entry in the response body of the previous get call indicates that the number of device instances exceeds the pagesize this parameter is only required if you need more elements in the paged list than the pagesize (100) pagesize int int optional optional the maximum number of device instances that can be contained in the response body this defaults to the maximum allowed page size (100) request example the example request parameters and headers are set as follows marker value is set to the \[pagedlist] \[nextmarker] property value from the previous bsn cloud api response pagesize is set to 1 filter is set to \[model] is 'hd1024' sort is set to \[lastmodifieddate] asc get /2022/06/rest/devices/?marker=mj0kwmtu2\&pagesize=1\&filter=%5bmodel%5d%20is%20%27hd1024%27\&sort=%5blastmodifieddate%5d%20asc http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response body 200 200 returns a paged list entity (2022/06) docid\ pwwr0ln3 binngl mr3st of player entity (2022/06) docid 9pqprrjavwfzbka1gybea instances on a network this will return not more than 100 entities along with the information necessary to return any other remaining pages example { "items" \[ { "id" 12345, "serial" "46c89c101829", "model" "hd1024", "family" "pagani", "registrationdate" "2020 07 09t19 15 22 773z", "lastmodifieddate" "2021 05 04t18 04 17 97z", "settings" { "name" "hdplayer", "description" "primary display", "concatnameandserial" false, "setuptype" "bsn", "lastmodifieddate" "2022 01 05t18 12 22 643z", "group" { "id" 123, "name" "testgroup", "link" null }, "brightwall" null, "timezone" "pst", "screen" { "idlecolor" "ff702896", "splashurl" null }, "synchronization" { "status" { "period" "00 05 00" }, "settings" { "period" "00 00 00" }, "schedule" { "period" "06 00 00" }, "content" { "start" null, "end" null } }, "network" { "hostname" "brightsign 46c89c101829", "proxyserver" null, "proxybypass" \[], "timeservers" \[ "http //time brightsignnetwork com/" ], "interfaces" \[ { "name" "eth0", "type" "ethernet", "enabled" true, "proto" "static", "ip" \[ "192 168 0 2/24", "ef88 7 2fab 7657/64" ], "gateway" "192 168 0 1", "dns" \[ "192 168 0 125", "74 38 99 135" ], "ratelimitduringinitialdownloads" null, "ratelimitinsidecontentdownloadwindow" null, "ratelimitoutsidecontentdownloadwindow" null, "contentdownloadenabled" true, "textfeedsdownloadenabled" true, "mediafeedsdownloadenabled" true, "healthreportingenabled" true, "logsuploadenabled" true }, { "name" "eth0 25", "type" "virtual", "enabled" false, "parent" "eth0", "vlanid" 25, "proto" "dhcpv4", "ip" null, "gateway" null, "dns" null, "ratelimitduringinitialdownloads" null, "ratelimitinsidecontentdownloadwindow" null, "ratelimitoutsidecontentdownloadwindow" null, "contentdownloadenabled" false, "textfeedsdownloadenabled" false, "mediafeedsdownloadenabled" false, "healthreportingenabled" true, "logsuploadenabled" true }, { "name" "wlan0", "type" "wifi", "enabled" true, "ssid" "hall devices", "security" { "authentication" { "mode" "shared", "passphrase" "a8200e996438de85103486a44ca96a999b0a6d" }, "encryption" { "mode" "tkip" } }, "proto" "ndp, dhcpv6", "ip" null, "gateway" null, "dns" null, "ratelimitduringinitialdownloads" 10240000, "ratelimitinsidecontentdownloadwindow" 10240000, "ratelimitoutsidecontentdownloadwindow" 256000, "contentdownloadenabled" true, "textfeedsdownloadenabled" true, "mediafeedsdownloadenabled" false, "healthreportingenabled" true, "logsuploadenabled" false }, { "name" "ppp0", "type" "cellular", "enabled" true, "modems" \[ { "model" "brightsign ik41", "usbdeviceids" \[ "1bbb 00b6" ] } ], "sims" \[ { "mcc" "901", "mnc" "28", "connection" { "type" "default" } }, { "mcc" "204", "mnc" "04", "connection" { "type" "default" } } ], "ratelimitduringinitialdownloads" null, "ratelimitinsidecontentdownloadwindow" null, "ratelimitoutsidecontentdownloadwindow" null, "contentdownloadenabled" true, "textfeedsdownloadenabled" true, "mediafeedsdownloadenabled" true, "healthreportingenabled" true, "logsuploadenabled" true }, { "name" "usb0", "type" "ethernet", "enabled" true, "proto" "static", "ip" \[ "132 80 245 191/24" ], "gateway" null, "dns" \[ "132 80 245 142" ], "ratelimitduringinitialdownloads" null, "ratelimitinsidecontentdownloadwindow" null, "ratelimitoutsidecontentdownloadwindow" null, "contentdownloadenabled" false, "textfeedsdownloadenabled" false, "mediafeedsdownloadenabled" false, "healthreportingenabled" false, "logsuploadenabled" false }, { "name" "eth0 110", "type" "virtual", "enabled" true, "parent" "eth0", "vlanid" 110, "proto" "static", "ip" \[ "16 194 230 251/28" ], "gateway" "16 194 230 241", "dns" \[ "192 168 0 125", "74 38 99 135" ], "ratelimitduringinitialdownloads" null, "ratelimitinsidecontentdownloadwindow" null, "ratelimitoutsidecontentdownloadwindow" null, "contentdownloadenabled" true, "textfeedsdownloadenabled" true, "mediafeedsdownloadenabled" true, "healthreportingenabled" true, "logsuploadenabled" true } ] }, "beacons" \[], "location" { "placeid" null, "gpslatitude" 37 4152, "gpslongitude" 122 1224, "country" "us", "countrylongname" "united states", "adminarealevel1" "ca", "adminarealevel1longname" "california", "adminarealevel2" "santa clara county", "adminarealevel2longname" "santa clara county", "locality" "palo alto", "localitylongname" "palo alto", "path" "/us/ca/santa clara county/palo alto/", "pathlongname" "/united states/california/santa clara county/palo alto/" }, "screenshots" null, "logging" { "enablediagnosticlog" false, "enableeventlog" false, "enableplaybacklog" false, "enablestatelog" false, "enablevariablelog" false, "uploadatboot" false, "uploadtime" null }, "lws" { "username" "", "password" "", "enableupdatenotifications" true }, "ldws" { "password" "rlsjz35sm9b1lb0npvfw4kpyegscblmf3nfg6wtoastxioc+ir5ngrhja77zawtgpiczpdddnwmlqsb4qlqe6nefx6q/927sco6llvttrbvch+rlgzlj2sxyqah6tux66jrfuvcxyhzl0iunkr/r4e1hdtqpxh3yxipj5obotlaw8ow6dznixdgmuvhgmwaw9/tgksuytlwb1skqgzqordymmg+a71ymgv6nckbun3p0djqsmrvxlfe9+awq73lsxqkf5q52fjuhgsksycttnojvy/n9hwcreyxopkf7vseifkoeg/qofbvgzzkooqatyd82ibkboqu9wllbgx+qaattqhr1srzoys2pdmblddlhnge4bhidxmophm69bsmiakucuqgjvgi8srl/9kuxlxuayeq6vyzunhdx7k3nyqbhgjcxvbsure5wis/vq97zi4wt0npf55fmoaqlza1jcsk/85w8s4hfpcyldnqqmi8jxqvnz5apc7nksg6nsibghh4h1cpa7dg6d6mzjbldvkhutni3bj991cp45riaglmwipbc9ekwodrsdpymk2cdn/jeygmfiudjjw4cvgi4s6z3oyqddiev+plztgd69naau4omcohcr1stjdsvorq++tf+r0/ikc5wdhaubszxvlsdckja7gv7v4koazc0cmta=" } }, "status" { "group" { "id" 123, "name" "testgroup", "link" null }, "brightwall" null, "presentation" { "id" 12345, "name" "test2", "type" "presentation", "link" null }, "timezone" "pst", "synchronization" { "settings" { "enabled" false }, "schedule" { "enabled" false }, "content" { "enabled" false } }, "script" { "type" "autorun", "version" "10 0 100", "plugins" null }, "firmware" { "version" "8 5 35" }, "storage" \[ { "interface" "sd1", "system" "exfat", "access" "read, write", "stats" { "sizetotal" 31905546240, "sizefree" 31898959872, "blocksize" 32768 } } ], "network" { "externalip" "98 134 53 219", "interfaces" \[ { "name" "eth0", "type" "ethernet", "proto" "static", "mac" "d0 6a 85\ da\ fe 71", "ip" \[ "192 168 0 1/24", "ef88 7 2fab 7657/64", "fe80 c60c 27bf 74e0 2e0f/128" ], "gateway" "192 168 0 1", "metric" 100 }, { "name" "eth0 25", "type" "virtual", "proto" "dhcpv4", "mac" "d0 6a 85\ da\ fe 71", "ip" \[ "176 216 148 166/16", "fe80 1623 693 8588 65bb/128" ], "gateway" "176 216 0 1", "metric" 2 }, { "name" "wlan0", "type" "wifi", "proto" "ndp, dhcpv6", "mac" "33 5b\ fe 4a\ e1\ bb", "ip" \[ "10 10 0 2/16" ], "gateway" "10 10 0 1", "metric" 110 }, { "name" "ppp0", "type" "cellular", "proto" "static", "mac" "fe 98 1a\ aa\ b4 72", "ip" \[ "192 168 255 255/31" ], "gateway" "192 168 255 254", "metric" 120, "modem" { "imei" "35778404001349", "manufacturer" "vodafone", "model" "ik41us usbc4g v2 na", "revision" "ik41 00 02 00 09" }, "sims" \[ { "status" "ok", "iccid" "8910412345678907", "connection" { "network" "vodafone libertel", "signal" 53 } } ] }, { "name" "usb0", "type" "ethernet", "proto" "static", "mac" "5a 64\ a1 72\ ee 12", "ip" \[ "132 80 245 191/24" ], "gateway" null, "metric" null }, { "name" "eth0 110", "type" "virtual", "proto" "static", "mac" "d0 6a 85\ da\ fe 71", "ip" \[ "16 194 230 251/28", "fe80 8c6f 34a9\ c88 31d5/128" ], "gateway" "16 194 230 241", "metric" 3 } ] }, "uptime" "08 20 46", "currentsettingstimestamp" "2021 05 04t10 45 06z", "currentscheduletimestamp" "2021 05 04t10 45 06z", "health" "error", "lastmodifieddate" "2022 02 15t23 53 50 16z" }, "subscription" { "id" 123456, "device" { "id" 12345, "serial" "46c89c101829" }, "type" "commercial", "activityperiod" "365 00 00 00", "status" "active", "creationdate" "2020 08 17t20 49 49 09z", "lastmodifieddate" "2020 08 17t20 49 49 09z", "activationdate" "2020 08 17t20 49 49 09z", "suspensiondate" null, "expirationdate" null }, "taggedgroups" \[], "tags" { "string \[content] \<anon>" "image", "number \[content] \<billingrate>" "30" }, "permissions" \[] } ], "totalitemcount" 3, "matchingitemcount" 2, "pagesize" 1, "nextmarker" "ldm3mja2", "prevmarker" "ldm32b56", "istruncated" false, "sortexpression" "\[lastmodifieddate] asc", "filterexpression" "\[model] is 'hd1024'" } failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error delete / removes devices, specified by a filter, from a network this allows multiple devices to be deleted at once required scope token bsn api main devices delete query string parameter filter string string required required an filtering and sorting expressions in the main api docid 3l0afyd3xooe ytvfk2vs for filtering search results request example the example request parameters and headers are set as follows filter is set to \[model] is 'hd1024' delete /2022/06/rest/devices/?filter=%5bmodel%5d%20is%20%27hd1024%27 http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response body 200 200 returns the number of affected devices as an integer value failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance to the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /regions/{ locationpath}/ returns a region which contains all the players located in the specified path required scope token bsn api main devices retrieve segment locationpath string string the parts of the returned player location path (country, province, city, etc ) that are common to all players query string parameter filter string string optional optional an filtering and sorting expressions in the main api docid 3l0afyd3xooe ytvfk2vs for filtering search results request example the example request parameters and headers are set as follows filter is set to \[model] is 'hd1024' locationpath is set to /us/ get /2022/06/rest/devices/regions/us/?filter=%5bmodel%5d%20is%20%27hd1024%27 http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response body 200 200 returns the players region entity (2022/06) docid\ a9mjhdau9wtp79ngksoh2 example \[ { "country" "us", "countrylongname" "united states", "adminarealevel1" "mo", "adminarealevel1longname" "missouri", "adminarealevel2" "callaway county", "adminarealevel2longname" "callaway county", "locality" "fulton", "localitylongname" "fulton", "mingpslatitude" 38 8513, "maxgpslatitude" 38 8513, "mingpslongitude" 91 9604, "maxgpslongitude" 91 9604, "devicescount" 1, "deviceshealthstatus" \[ "normal" ], "locationpath" "/us/mo/callaway county/fulton/" } ] failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /count/ retrieves the number of devices on the network matching the specified filter criteria if no filter is included, this call returns the total number of devices on the network required scope token bsn api main devices retrieve query string parameter filter string string optional optional an filtering and sorting expressions in the main api docid 3l0afyd3xooe ytvfk2vs for filtering search results request example the example request parameters and headers are set as follows filter is set to \[model] is 'hd1024' get /2022/06/rest/devices/count/?filter=%5bmodel%5d%20is%20%27hd1024%27 http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response 200 200 the device count is returned as an integer value failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{id\ int}/ return the information for a specified device required scope token bsn api main devices retrieve segment id int int a unique identifier for the device request example the example request parameters and headers are set as follows id is set to 12345 the optional if modified since header value equals the last modified header value retrieved from the previous get /id or get /serial response get /2022/06/rest/devices/12345/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} if modified since wed, 13 mar 2024 15 51 01 gmt accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response with body 200 200 returns the player entity (2022/06) docid 9pqprrjavwfzbka1gybea example { "id" 12345, "serial" "46c89c101839", "model" "hd1024", "family" "pagani", "registrationdate" "2020 07 09t19 15 22 773z", "lastmodifieddate" "2024 03 13t16 29 11 983z", "settings" { "name" "hdplayer", "description" "primary display", "concatnameandserial" false, "setuptype" "bsn", "lastmodifieddate" "2022 01 05t18 12 22 643z", "group" { "id" 123, "name" "testgroup", "link" null }, "brightwall" null, "timezone" "pst", "screen" { "idlecolor" "ff702896", "splashurl" null }, "synchronization" { "status" { "period" "00 05 00" }, "settings" { "period" "00 00 00" }, "schedule" { "period" "06 00 00" }, "content" { "start" null, "end" null } }, "network" { "hostname" "brightsign 46c89c101829", "proxyserver" null, "proxybypass" \[], "timeservers" \[ "http //time brightsignnetwork com/" ], "interfaces" \[ { "name" "eth0", "type" "ethernet", "enabled" true, "proto" "static", "ip" \[ "192 168 0 2/24", "ef88 7 2fab 7657/64" ], "gateway" "192 168 0 1", "dns" \[ "192 168 0 125", "74 38 99 135" ], "ratelimitduringinitialdownloads" null, "ratelimitinsidecontentdownloadwindow" null, "ratelimitoutsidecontentdownloadwindow" null, "contentdownloadenabled" true, "textfeedsdownloadenabled" true, "mediafeedsdownloadenabled" true, "healthreportingenabled" true, "logsuploadenabled" true }, { "name" "eth0 25", "type" "virtual", "enabled" false, "parent" "eth0", "vlanid" 25, "proto" "dhcpv4", "ip" null, "gateway" null, "dns" null, "ratelimitduringinitialdownloads" null, "ratelimitinsidecontentdownloadwindow" null, "ratelimitoutsidecontentdownloadwindow" null, "contentdownloadenabled" false, "textfeedsdownloadenabled" false, "mediafeedsdownloadenabled" false, "healthreportingenabled" true, "logsuploadenabled" true }, { "name" "wlan0", "type" "wifi", "enabled" true, "ssid" "hall devices", "security" { "authentication" { "mode" "shared", "passphrase" "a8201e996438de85103486a44ca96a999b0a6d" }, "encryption" { "mode" "tkip" } }, "proto" "ndp, dhcpv6", "ip" null, "gateway" null, "dns" null, "ratelimitduringinitialdownloads" 10240000, "ratelimitinsidecontentdownloadwindow" 10240000, "ratelimitoutsidecontentdownloadwindow" 256000, "contentdownloadenabled" true, "textfeedsdownloadenabled" true, "mediafeedsdownloadenabled" false, "healthreportingenabled" true, "logsuploadenabled" false }, { "name" "ppp0", "type" "cellular", "enabled" true, "modems" \[ { "model" "brightsign ik41", "usbdeviceids" \[ "1bbb 00b6" ] } ], "sims" \[ { "mcc" "901", "mnc" "28", "connection" { "type" "default" } }, { "mcc" "204", "mnc" "04", "connection" { "type" "default" } } ], "ratelimitduringinitialdownloads" null, "ratelimitinsidecontentdownloadwindow" null, "ratelimitoutsidecontentdownloadwindow" null, "contentdownloadenabled" true, "textfeedsdownloadenabled" true, "mediafeedsdownloadenabled" true, "healthreportingenabled" true, "logsuploadenabled" true }, { "name" "usb0", "type" "ethernet", "enabled" true, "proto" "static", "ip" \[ "132 80 245 191/24" ], "gateway" null, "dns" \[ "132 80 245 142" ], "ratelimitduringinitialdownloads" null, "ratelimitinsidecontentdownloadwindow" null, "ratelimitoutsidecontentdownloadwindow" null, "contentdownloadenabled" false, "textfeedsdownloadenabled" false, "mediafeedsdownloadenabled" false, "healthreportingenabled" false, "logsuploadenabled" false }, { "name" "eth0 110", "type" "virtual", "enabled" true, "parent" "eth0", "vlanid" 110, "proto" "static", "ip" \[ "16 194 230 251/28" ], "gateway" "16 194 230 241", "dns" \[ "192 168 0 125", "74 38 99 135" ], "ratelimitduringinitialdownloads" null, "ratelimitinsidecontentdownloadwindow" null, "ratelimitoutsidecontentdownloadwindow" null, "contentdownloadenabled" true, "textfeedsdownloadenabled" true, "mediafeedsdownloadenabled" true, "healthreportingenabled" true, "logsuploadenabled" true } ] }, "beacons" \[], "location" { "placeid" null, "gpslatitude" 37 4152, "gpslongitude" 122 1224, "country" "us", "countrylongname" "united states", "adminarealevel1" "ca", "adminarealevel1longname" "california", "adminarealevel2" "santa clara county", "adminarealevel2longname" "santa clara county", "locality" "palo alto", "localitylongname" "palo alto", "path" "/us/ca/santa clara county/palo alto/", "pathlongname" "/united states/california/santa clara county/palo alto/" }, "screenshots" { "interval" "00 15 00", "countlimit" 5, "quality" 50, "orientation" "landscape" }, "logging" { "enablediagnosticlog" false, "enableeventlog" false, "enableplaybacklog" false, "enablestatelog" false, "enablevariablelog" false, "uploadatboot" false, "uploadtime" null }, "lws" { "username" "", "password" "", "enableupdatenotifications" true }, "ldws" { "password" "rlsjz35sm9b1lb0npvfw4kpyegscblmf3nfg6wtoastxioc+ir5ngrhja77zawtgpiczpdddnwmlqsb4qlqe6nefx6q/927sco6llvttrbvch+rlgzlj2sxyqah6tux66jrfuvcxyhzl0iunkr/r4e1hdtqpxh3yxipj5obotlaw8ow6dznixdgmuvhgmwaw9/tgksuytlwb1skqgzqordymmg+a71ymgv6nckbun3p0djqsmrvxlfe9+awq73lsxqkf5q52fjuhgsksycttnojvy/n9hwcreyxopkf7vseifkoeg/qofbvgzzkooqatyd82ibkboqu9wllbgx+qaattqhr1srzoys2pdmblddlhnge4bhidxmophm69bsmiakucuqgjvgi8srl/9kuxlxuayeq6vyzunhdx7k3nyqbhgjcxvbsure5wis/vq97zi4wt0npf55fmoaqlza1jcsk/85w8s4hfpcyldnqqmi8jxqvnz5apc7nksg6nsibghh4h1cpa7dg6d6mzjbldvkhutni3bj991cp45riaglmwipbc9ekwodrsdpymk2cdn/jeygmfiudjjw4cvgi4s6z3oyqddiev+plztgd69naau4omcohcr1stjdsvorq++tf+r0/ikc5wdhaubszxvlsdckja7gv7v4koazc0cmta=" } }, "status" { "group" { "id" 123, "name" "testgroup", "link" null }, "brightwall" null, "presentation" { "id" 12345, "name" "test2", "type" "presentation", "link" null }, "timezone" "pst", "synchronization" { "settings" { "enabled" false }, "schedule" { "enabled" false }, "content" { "enabled" false } }, "script" { "type" "autorun", "version" "10 0 100", "plugins" null }, "firmware" { "version" "8 5 35" }, "storage" \[ { "interface" "sd1", "system" "exfat", "access" "read, write", "stats" { "sizetotal" 31905546240, "sizefree" 31898959872, "blocksize" 32768 } } ], "network" { "externalip" "98 134 53 219", "interfaces" \[ { "name" "eth0", "type" "ethernet", "proto" "static", "mac" "d0 6a 85\ da\ fe 71", "ip" \[ "192 168 0 1/24", "ef88 7 2fab 7657/64", "fe80 c60c 27bf 74e0 2e0f/128" ], "gateway" "192 168 0 1", "metric" 100 }, { "name" "eth0 25", "type" "virtual", "proto" "dhcpv4", "mac" "d0 6a 85\ da\ fe 71", "ip" \[ "176 216 148 166/16", "fe80 1623 693 8588 65bb/128" ], "gateway" "176 216 0 1", "metric" 2 }, { "name" "wlan0", "type" "wifi", "proto" "ndp, dhcpv6", "mac" "33 5b\ fe 4a\ e1\ bb", "ip" \[ "10 10 0 2/16" ], "gateway" "10 10 0 1", "metric" 110 }, { "name" "ppp0", "type" "cellular", "proto" "static", "mac" "fe 98 1a\ aa\ b4 72", "ip" \[ "192 168 255 255/31" ], "gateway" "192 168 255 254", "metric" 120, "modem" { "imei" "35778404001349", "manufacturer" "vodafone", "model" "ik41us usbc4g v2 na", "revision" "ik41 00 02 00 09" }, "sims" \[ { "status" "ok", "iccid" "8910412345678907", "connection" { "network" "vodafone libertel", "signal" 53 } } ] }, { "name" "usb0", "type" "ethernet", "proto" "static", "mac" "5a 64\ a1 72\ ee 12", "ip" \[ "132 80 245 191/24" ], "gateway" null, "metric" null }, { "name" "eth0 110", "type" "virtual", "proto" "static", "mac" "d0 6a 85\ da\ fe 71", "ip" \[ "16 194 230 251/28", "fe80 8c6f 34a9\ c88 31d5/128" ], "gateway" "16 194 230 241", "metric" 3 } ] }, "uptime" "08 20 46", "currentsettingstimestamp" "2021 05 04t10 45 06z", "currentscheduletimestamp" "2021 05 04t10 45 06z", "health" "error", "lastmodifieddate" "2022 02 15t23 53 50 16z" }, "subscription" { "id" 123456, "device" { "id" 12345, "serial" "46c89c101839" }, "type" "commercial", "activityperiod" "365 00 00 00", "status" "active", "creationdate" "2020 08 17t20 49 49 09z", "lastmodifieddate" "2020 08 17t20 49 49 09z", "activationdate" "2020 08 17t20 49 49 09z", "suspensiondate" null, "expirationdate" null }, "taggedgroups" \[], "tags" { "string \[content] \<anon>" "image", "number \[content] \<billingrate>" "30" }, "permissions" \[] } success response 304 304 the resource was not modified since the time specified in the “if modified since” header failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error put /{id\ int}/ update the specified device applies only to the player settings required scope token bsn api main devices update segment id int int a unique identifier for the device request body the player entity (2022/06) docid 9pqprrjavwfzbka1gybea request example the example request parameters and headers are set as follows id is set to 12345 the optional if unmodified since header value equals the last modified header value retrieved from the get /id or get /serial response put /2022/06/rest/devices/12345/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate if unmodified since wed, 13 mar 2024 15 51 01 gmt content type application/json content length 5947 example { "id" 0, "serial" "46d89c107131", "model" "hd1024", "family" "pagani", "registrationdate" "0001 01 01t00 00 00", "lastmodifieddate" "0001 01 01t00 00 00", "settings" { "name" "outsideplayer", "description" "outside of building a", "concatnameandserial" false, "setuptype" "bsn", "lastmodifieddate" "2022 01 05t18 12 22 643z", "group" { "id" 123, "name" "testgroup", "link" null }, "brightwall" null, "timezone" "pst", "screen" { "idlecolor" "ff702896", "splashurl" null }, "synchronization" { "status" {"period" "00 05 00"}, "settings" {"period" "00 00 00"}, "schedule" {"period" "06 00 00"}, "content" { "start" null, "end" null } }, "network" { "hostname" "brightsign 46d89c107131", "proxyserver" null, "proxybypass" \[], "timeservers" \["http //time brightsignnetwork com/"], "interfaces" \[ { "enabled" true, "proto" "dhcp", "ip" null, "gateway" null, "dns" null, "ratelimitduringinitialdownloads" 0, "ratelimitinsidecontentdownloadwindow" 0, "ratelimitoutsidecontentdownloadwindow" null, "contentdownloadenabled" true, "textfeedsdownloadenabled" true, "mediafeedsdownloadenabled" true, "healthreportingenabled" true, "logsuploadenabled" true, "name" "eth0", "type" "ethernet" }, { "enabled" false, "ssid" "", "security" { "authentication" { "mode" "shared", "passphrase" "" }, "encryption" {"mode" "tkip, ccmp"} }, "proto" "dhcp", "ip" null, "gateway" null, "dns" null, "ratelimitduringinitialdownloads" 0, "ratelimitinsidecontentdownloadwindow" 0, "ratelimitoutsidecontentdownloadwindow" 0, "contentdownloadenabled" false, "textfeedsdownloadenabled" false, "mediafeedsdownloadenabled" false, "healthreportingenabled" false, "logsuploadenabled" false, "name" "wlan0", "type" "wifi" } ] }, "beacons" \[], "location" null, "screenshots" null, "logging" { "enablediagnosticlog" false, "enableeventlog" false, "enableplaybacklog" false, "enablestatelog" false, "enablevariablelog" false, "uploadatboot" false, "uploadtime" null }, "lws" { "username" "", "password" "", "enableupdatenotifications" true }, "ldws" {"password" "rlsjpqsm9z15lb8nwvfwjkpyegscblmf3nfg6wt3astxioc+ir5ngrhja77zawtgpiczpdddnwmlqsb4qlqe6nefx6q/927sco6llvttrbvch+rlgzlj2sxyqah6tux66jrfuvcxyhzl0iunkr/r4e1hdtqpxh3yxipj5obotlaw8ow6dznixdgmuvhgmwaw9/tgksuytlwb1skqgzqordymmg+a71ymgv6nckbun3p0djqsmrvxlfe9+awq73lsxqkf5q52fjuhgsksycttnojvy/n9hwcreyxopkf7vseifkoeg/qofbvgzzkooqatyd82ibkboqu9wllbgx+qaattqhr1srzoys2pdmblddlhnge4bhidxmophm69bsmiakucuqgjvgi8srl/9kuxlxuayeq6vyzunhdx7k3nyqbhgjcxvbsure5wis/vq97zi4wt0npf55fmoaqlza1jcsk/85w8s4hfpcyldnqqmi8jxqvnz5apc7nksg6nsibghh4h1cpa7dg6d6mzjbldvkhutni3bj991cp45riaglmwipbc9ekwodrsdpymk2cdn/jeygmfiudjjw4cvgi4s6z3oyqddiev+plztgd69naau4omcohcr1stjdsvorq++tf+r0/ikc5wdhaubszxvlsdckja7gv7v4koazc0cmta="} }, "status" null, "subscription" null, "taggedgroups" \[], "tags" {}, "permissions" \[] } success response 204 204 the specified device was successfully updated failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance to the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error patch /{id\ int}/ replaces certain parameters on the specified device applies only to the player settings see rfc6902 https //datatracker ietf org/doc/html/rfc6902 required scope token bsn api main devices update segment id int int a unique identifier for the device request body these properties are entries in an array every entry must have all three of these properties op string string the type of operation in this case it is always "replace" path string string a uri path that references the location within the target document where the update will be performed value object object the replacement value(s) for the parameters that must be updated request example the example request parameters and headers are set as follows id is 12345 the optional if unmodified since header value equals the last modified header value retrieved from the get /id or get /serial response patch /2022/06/rest/devices/12345/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate if unmodified since wed, 13 mar 2024 15 51 01 gmt content type application/json patch+json content length 94 this is the example request body \[ { "op" "replace", "path" "/settings/description/", "value" "main screen player" } ] success response 204 204 the parameters have been successfully replaced failure response 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance to the business rules 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error delete /{id\ int}/ delete the specified device required scope token bsn api main devices delete segment id int int a unique identifier for the device to delete request example the example request parameters and headers are set as follows id is set to 12345 the optional if unmodified since header value equals the last modified header value retrieved from the get /id or get /serial response delete /2022/06/rest/devices/12345/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}}} if unmodified since wed, 13 mar 2024 15 51 01 gmt accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response 204 204 the device was successfully deleted failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance to the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 5xx 5xx any 500 code is an internal server error get /{serial}/ return the specified device information required scope bsn api main devices retrieve segment serial string string the device serial number request example the example request parameters and headers are set as follows serial is set to 46d89c101139 the optional if modified since header value equals the last modified header value retrieved from the previous get /id or get /serial response get /2022/06/rest/devices/46d89c101139/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} if modified since wed, 13 mar 2024 15 51 01 gmt accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response with body 200 200 returns the player entity (2022/06) docid 9pqprrjavwfzbka1gybea example { "id" 12345, "serial" "46d89c101139", "model" "hd1024", "family" "pagani", "registrationdate" "2020 07 09t19 15 22 773z", "lastmodifieddate" "2024 03 13t16 29 11 983z", "settings" { "name" "hdplayer", "description" "primary display", "concatnameandserial" false, "setuptype" "bsn", "lastmodifieddate" "2022 01 05t18 12 22 643z", "group" { "id" 123, "name" "testgroup", "link" null }, "brightwall" null, "timezone" "pst", "screen" { "idlecolor" "ff702896", "splashurl" null }, "synchronization" { "status" { "period" "00 05 00" }, "settings" { "period" "00 00 00" }, "schedule" { "period" "06 00 00" }, "content" { "start" null, "end" null } }, "network" { "hostname" "brightsign 46d89c101139", "proxyserver" null, "proxybypass" \[], "timeservers" \[ "http //time brightsignnetwork com/" ], "interfaces" \[ { "name" "eth0", "type" "ethernet", "enabled" true, "proto" "static", "ip" \[ "192 168 0 2/24", "ef88 7 2fab 7657/64" ], "gateway" "192 168 0 1", "dns" \[ "192 168 0 125", "74 38 99 135" ], "ratelimitduringinitialdownloads" null, "ratelimitinsidecontentdownloadwindow" null, "ratelimitoutsidecontentdownloadwindow" null, "contentdownloadenabled" true, "textfeedsdownloadenabled" true, "mediafeedsdownloadenabled" true, "healthreportingenabled" true, "logsuploadenabled" true }, { "name" "eth0 25", "type" "virtual", "enabled" false, "parent" "eth0", "vlanid" 25, "proto" "dhcpv4", "ip" null, "gateway" null, "dns" null, "ratelimitduringinitialdownloads" null, "ratelimitinsidecontentdownloadwindow" null, "ratelimitoutsidecontentdownloadwindow" null, "contentdownloadenabled" false, "textfeedsdownloadenabled" false, "mediafeedsdownloadenabled" false, "healthreportingenabled" true, "logsuploadenabled" true }, { "name" "wlan0", "type" "wifi", "enabled" true, "ssid" "hall devices", "security" { "authentication" { "mode" "shared", "passphrase" "a8201e996438de85103486a44ca96a999b0a6d" }, "encryption" { "mode" "tkip" } }, "proto" "ndp, dhcpv6", "ip" null, "gateway" null, "dns" null, "ratelimitduringinitialdownloads" 10240000, "ratelimitinsidecontentdownloadwindow" 10240000, "ratelimitoutsidecontentdownloadwindow" 256000, "contentdownloadenabled" true, "textfeedsdownloadenabled" true, "mediafeedsdownloadenabled" false, "healthreportingenabled" true, "logsuploadenabled" false }, { "name" "ppp0", "type" "cellular", "enabled" true, "modems" \[ { "model" "brightsign ik41", "usbdeviceids" \[ "1bbb 00b6" ] } ], "sims" \[ { "mcc" "901", "mnc" "28", "connection" { "type" "default" } }, { "mcc" "204", "mnc" "04", "connection" { "type" "default" } } ], "ratelimitduringinitialdownloads" null, "ratelimitinsidecontentdownloadwindow" null, "ratelimitoutsidecontentdownloadwindow" null, "contentdownloadenabled" true, "textfeedsdownloadenabled" true, "mediafeedsdownloadenabled" true, "healthreportingenabled" true, "logsuploadenabled" true }, { "name" "usb0", "type" "ethernet", "enabled" true, "proto" "static", "ip" \[ "132 80 245 191/24" ], "gateway" null, "dns" \[ "132 80 245 142" ], "ratelimitduringinitialdownloads" null, "ratelimitinsidecontentdownloadwindow" null, "ratelimitoutsidecontentdownloadwindow" null, "contentdownloadenabled" false, "textfeedsdownloadenabled" false, "mediafeedsdownloadenabled" false, "healthreportingenabled" false, "logsuploadenabled" false }, { "name" "eth0 110", "type" "virtual", "enabled" true, "parent" "eth0", "vlanid" 110, "proto" "static", "ip" \[ "16 194 230 251/28" ], "gateway" "16 194 230 241", "dns" \[ "192 168 0 125", "74 38 99 135" ], "ratelimitduringinitialdownloads" null, "ratelimitinsidecontentdownloadwindow" null, "ratelimitoutsidecontentdownloadwindow" null, "contentdownloadenabled" true, "textfeedsdownloadenabled" true, "mediafeedsdownloadenabled" true, "healthreportingenabled" true, "logsuploadenabled" true } ] }, "beacons" \[], "location" { "placeid" null, "gpslatitude" 37 4152, "gpslongitude" 122 1224, "country" "us", "countrylongname" "united states", "adminarealevel1" "ca", "adminarealevel1longname" "california", "adminarealevel2" "santa clara county", "adminarealevel2longname" "santa clara county", "locality" "palo alto", "localitylongname" "palo alto", "path" "/us/ca/santa clara county/palo alto/", "pathlongname" "/united states/california/santa clara county/palo alto/" }, "screenshots" { "interval" "00 15 00", "countlimit" 5, "quality" 50, "orientation" "landscape" }, "logging" { "enablediagnosticlog" false, "enableeventlog" false, "enableplaybacklog" false, "enablestatelog" false, "enablevariablelog" false, "uploadatboot" false, "uploadtime" null }, "lws" { "username" "", "password" "", "enableupdatenotifications" true }, "ldws" { "password" "rlsjz35sm9b1lb0npvfw4kpyegscblmf3nfg6wtoastxioc+ir5ngrhja77zawtgpiczpdddnwmlqsb4qlqe6nefx6q/927sco6llvttrbvch+rlgzlj2sxyqah6tux66jrfuvcxyhzl0iunkr/r4e1hdtqpxh3yxipj5obotlaw8ow6dznixdgmuvhgmwaw9/tgksuytlwb1skqgzqordymmg+a71ymgv6nckbun3p0djqsmrvxlfe9+awq73lsxqkf5q52fjuhgsksycttnojvy/n9hwcreyxopkf7vseifkoeg/qofbvgzzkooqatyd82ibkboqu9wllbgx+qaattqhr1srzoys2pdmblddlhnge4bhidxmophm69bsmiakucuqgjvgi8srl/9kuxlxuayeq6vyzunhdx7k3nyqbhgjcxvbsure5wis/vq97zi4wt0npf55fmoaqlza1jcsk/85w8s4hfpcyldnqqmi8jxqvnz5apc7nksg6nsibghh4h1cpa7dg6d6mzjbldvkhutni3bj991cp45riaglmwipbc9ekwodrsdpymk2cdn/jeygmfiudjjw4cvgi4s6z3oyqddiev+plztgd69naau4omcohcr1stjdsvorq++tf+r0/ikc5wdhaubszxvlsdckja7gv7v4koazc0cmta=" } }, "status" { "group" { "id" 123, "name" "testgroup", "link" null }, "brightwall" null, "presentation" { "id" 12345, "name" "test2", "type" "presentation", "link" null }, "timezone" "pst", "synchronization" { "settings" { "enabled" false }, "schedule" { "enabled" false }, "content" { "enabled" false } }, "script" { "type" "autorun", "version" "10 0 100", "plugins" null }, "firmware" { "version" "8 5 35" }, "storage" \[ { "interface" "sd1", "system" "exfat", "access" "read, write", "stats" { "sizetotal" 31905546240, "sizefree" 31898959872, "blocksize" 32768 } } ], "network" { "externalip" "98 134 53 219", "interfaces" \[ { "name" "eth0", "type" "ethernet", "proto" "static", "mac" "d0 6a 85\ da\ fe 71", "ip" \[ "192 168 0 1/24", "ef88 7 2fab 7657/64", "fe80 c60c 27bf 74e0 2e0f/128" ], "gateway" "192 168 0 1", "metric" 100 }, { "name" "eth0 25", "type" "virtual", "proto" "dhcpv4", "mac" "d0 6a 85\ da\ fe 71", "ip" \[ "176 216 148 166/16", "fe80 1623 693 8588 65bb/128" ], "gateway" "176 216 0 1", "metric" 2 }, { "name" "wlan0", "type" "wifi", "proto" "ndp, dhcpv6", "mac" "33 5b\ fe 4a\ e1\ bb", "ip" \[ "10 10 0 2/16" ], "gateway" "10 10 0 1", "metric" 110 }, { "name" "ppp0", "type" "cellular", "proto" "static", "mac" "fe 98 1a\ aa\ b4 72", "ip" \[ "192 168 255 255/31" ], "gateway" "192 168 255 254", "metric" 120, "modem" { "imei" "35778404001349", "manufacturer" "vodafone", "model" "ik41us usbc4g v2 na", "revision" "ik41 00 02 00 09" }, "sims" \[ { "status" "ok", "iccid" "8910412345678907", "connection" { "network" "vodafone libertel", "signal" 53 } } ] }, { "name" "usb0", "type" "ethernet", "proto" "static", "mac" "5a 64\ a1 72\ ee 12", "ip" \[ "132 80 245 191/24" ], "gateway" null, "metric" null }, { "name" "eth0 110", "type" "virtual", "proto" "static", "mac" "d0 6a 85\ da\ fe 71", "ip" \[ "16 194 230 251/28", "fe80 8c6f 34a9\ c88 31d5/128" ], "gateway" "16 194 230 241", "metric" 3 } ] }, "uptime" "08 20 46", "currentsettingstimestamp" "2021 05 04t10 45 06z", "currentscheduletimestamp" "2021 05 04t10 45 06z", "health" "error", "lastmodifieddate" "2022 02 15t23 53 50 16z" }, "subscription" { "id" 123456, "device" { "id" 12345, "serial" "46d89c101139" }, "type" "commercial", "activityperiod" "365 00 00 00", "status" "active", "creationdate" "2020 08 17t20 49 49 09z", "lastmodifieddate" "2020 08 17t20 49 49 09z", "activationdate" "2020 08 17t20 49 49 09z", "suspensiondate" null, "expirationdate" null }, "taggedgroups" \[], "tags" { "string \[content] \<anon>" "image", "number \[content] \<billingrate>" "30" }, "permissions" \[] } success response 304 304 the resource was not modified since the time specified in the “if modified since” header failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error put /{serial}/ update a specified device applies only to the player settings required scope token bsn api main devices update segment serial string string the device serial number request body the player entity (2022/06) docid 9pqprrjavwfzbka1gybea request example the example request parameters and headers are set as follows serial is set to 46d89c107131 the optional if unmodified since header value equals the last modified header value retrieved from the get /id or get /serial response put /2022/06/rest/devices/46d89c107131/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate if unmodified since wed, 13 mar 2024 15 51 01 gmt content type application/json content length 5947 this is the example request body { "id" 0, "serial" "46d89c107131", "model" "hd1024", "family" "pagani", "registrationdate" "0001 01 01t00 00 00", "lastmodifieddate" "0001 01 01t00 00 00", "settings" { "name" "outsideplayer", "description" "outside of building a", "concatnameandserial" false, "setuptype" "bsn", "lastmodifieddate" "2022 01 05t18 12 22 643z", "group" { "id" 123, "name" "testgroup", "link" null }, "brightwall" null, "timezone" "pst", "screen" { "idlecolor" "ff702896", "splashurl" null }, "synchronization" { "status" {"period" "00 05 00"}, "settings" {"period" "00 00 00"}, "schedule" {"period" "06 00 00"}, "content" { "start" null, "end" null } }, "network" { "hostname" "brightsign 46d89c107131", "proxyserver" null, "proxybypass" \[], "timeservers" \["http //time brightsignnetwork com/"], "interfaces" \[ { "enabled" true, "proto" "dhcp", "ip" null, "gateway" null, "dns" null, "ratelimitduringinitialdownloads" 0, "ratelimitinsidecontentdownloadwindow" 0, "ratelimitoutsidecontentdownloadwindow" null, "contentdownloadenabled" true, "textfeedsdownloadenabled" true, "mediafeedsdownloadenabled" true, "healthreportingenabled" true, "logsuploadenabled" true, "name" "eth0", "type" "ethernet" }, { "enabled" false, "ssid" "", "security" { "authentication" { "mode" "shared", "passphrase" "" }, "encryption" {"mode" "tkip, ccmp"} }, "proto" "dhcp", "ip" null, "gateway" null, "dns" null, "ratelimitduringinitialdownloads" 0, "ratelimitinsidecontentdownloadwindow" 0, "ratelimitoutsidecontentdownloadwindow" 0, "contentdownloadenabled" false, "textfeedsdownloadenabled" false, "mediafeedsdownloadenabled" false, "healthreportingenabled" false, "logsuploadenabled" false, "name" "wlan0", "type" "wifi" } ] }, "beacons" \[], "location" null, "screenshots" null, "logging" { "enablediagnosticlog" false, "enableeventlog" false, "enableplaybacklog" false, "enablestatelog" false, "enablevariablelog" false, "uploadatboot" false, "uploadtime" null }, "lws" { "username" "", "password" "", "enableupdatenotifications" true }, "ldws" {"password" "rlsjpqsm9z15lb8nwvfwjkpyegscblmf3nfg6wt3astxioc+ir5ngrhja77zawtgpiczpdddnwmlqsb4qlqe6nefx6q/927sco6llvttrbvch+rlgzlj2sxyqah6tux66jrfuvcxyhzl0iunkr/r4e1hdtqpxh3yxipj5obotlaw8ow6dznixdgmuvhgmwaw9/tgksuytlwb1skqgzqordymmg+a71ymgv6nckbun3p0djqsmrvxlfe9+awq73lsxqkf5q52fjuhgsksycttnojvy/n9hwcreyxopkf7vseifkoeg/qofbvgzzkooqatyd82ibkboqu9wllbgx+qaattqhr1srzoys2pdmblddlhnge4bhidxmophm69bsmiakucuqgjvgi8srl/9kuxlxuayeq6vyzunhdx7k3nyqbhgjcxvbsure5wis/vq97zi4wt0npf55fmoaqlza1jcsk/85w8s4hfpcyldnqqmi8jxqvnz5apc7nksg6nsibghh4h1cpa7dg6d6mzjbldvkhutni3bj991cp45riaglmwipbc9ekwodrsdpymk2cdn/jeygmfiudjjw4cvgi4s6z3oyqddiev+plztgd69naau4omcohcr1stjdsvorq++tf+r0/ikc5wdhaubszxvlsdckja7gv7v4koazc0cmta="} }, "status" null, "subscription" null, "taggedgroups" \[], "tags" {}, "permissions" \[] } success response 204 204 the specified device was successfully updated failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance to the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error patch /{serial}/ replaces certain parameters on the specified device applies only to player settings see rfc6902 https //datatracker ietf org/doc/html/rfc6902 required scope token bsn api main devices update segment serial string string the serial number of the device to delete request body these properties are entries in an array every entry must have all three of these properties op string string the type of operation in this case it is always "replace" path string string a uri path that references the location within the target document where the update will be performed value object object the replacement value(s) for the parameters that must be updated request example the example request parameters and headers are set as follows serial is 46d89c101139 the optional if unmodified since header value equals the last modified header value retrieved from the get /id or get /serial response patch /2022/06/rest/devices/46d89c101139/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate if unmodified since wed, 13 mar 2024 15 51 01 gmt content type application/json patch+json content length 94 this is the example request body \[ { "op" "replace", "path" "/settings/description/", "value" "main screen player" } ] success response 204 204 the parameters have been successfully replaced failure response 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance to the business rules 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error delete /{serial}/ delete the specified device required scope token bsn api main devices delete segment serial string string the device serial number request example the example request parameters and headers are set as follows serial is set to 46d89c101139 the optional if unmodified since header value equals the last modified header value retrieved from the get /id or get /serial response delete /2022/06/rest/devices/46d89c101139/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}}} if unmodified since wed, 13 mar 2024 15 51 01 gmt accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response 204 204 the device was successfully deleted failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance to the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 5xx 5xx any 500 code is an internal server error get /{deviceid\ int}/beacons/ return the array of all beacons defined for the player that is specified required scope token bsn api main devices retrieve segment deviceid int int a unique identifier for the device instance success response body 200 200 the collection of player beacon entity (2022/06) docid\ bsghv6pw46ze0xu2t2i8i failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{serial}/beacons/ return the array of all beacons defined for the player that is specified required scope token bsn api main devices retrieve segment serial string string the serial number of the device instance success response body 200 200 the collection of player beacon entity (2022/06) docid\ bsghv6pw46ze0xu2t2i8i failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{deviceid\ int}/beacons/{name}/ returns a device beacon of a certain type associated with a specified device and the specified name required scope token bsn api main devices retrieve segment deviceid int int a unique identifier for the device instance name string string the name of the device beacon success response body 200 200 returns the player beacon entity (2022/06) docid\ bsghv6pw46ze0xu2t2i8i failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error delete /{deviceid\ int}/beacons/{name}/ delete a specified device beacon from a specified device required scope token bsn api main devices update segment deviceid int int a unique identifier for the device instance name string string the name of the device beacon success response 204 204 the specified device beacon was successfully deleted from the device failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance to the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{serial}/beacons/{name}/ returns a device beacon of a certain type associated with a specified device and the specified name required scope token bsn api main devices retrieve segment serial string string the serial number of the device name string string the name of the beacon success response body 200 200 returns the player beacon entity (2022/06) docid\ bsghv6pw46ze0xu2t2i8i failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error delete /{serial}/beacons/{name}/ delete a specified device beacon on a specified device required scope token bsn api main devices update segment serial string string the serial number of the device name string string the name of the beacon to delete success response 204 204 the specified device beacon was successfully deleted from the device failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance to the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error post /{id\ int}/beacons/ create a device beacon required scope token bsn api main devices update segment id int int a unique identifier for the device instance on which you want to create the beacon request body the player beacon entity (2022/06) docid\ bsghv6pw46ze0xu2t2i8i success response body 201 201 returns the new resource created and referenced by the uri (given by the location header field) in the response the response includes the player beacon entity (2022/06) docid\ bsghv6pw46ze0xu2t2i8i failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance to the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error post /{serial}/beacons/ create a device beacon on a specified device required scope token bsn api main devices update segment serial string string the serial number of the device on which you want to create the beacon request body the player beacon entity (2022/06) docid\ bsghv6pw46ze0xu2t2i8i success response body 201 201 returns the new resource created and referenced by the uri (given by the location header field) in the response the response includes the player beacon entity (2022/06) docid\ bsghv6pw46ze0xu2t2i8i failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance to the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error get /{id\ int}/errors/ returns a list of errors associated with a specified device required scope token bsn api main devices retrieve segment id int int a unique identifier for the device that is reporting the errors query string parameters marker string string optional optional a value specifying which page to retrieve this value is useful if the istruncated entry in the response body of the previous get call indicates that the number of error instances exceeds the pagesize this parameter is only required if you need more elements in the paged list than the pagesize (100) pagesize int int optional optional the maximum number of error instances that can be contained in the response body request example the example request parameters and headers are set as follows id is set to 12345 marker value is set to the \[pagedlist] \[nextmarker] property value from the previous bsn cloud api response pagesize is set to 1 get /2022/06/rest/devices/12345/errors/?pagesize=1\&marker=a9dh34d23bh0 http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response body 200 200 returns the player error entity (2022/06) docid 4vwry6lz2jtfpac07jfiq example { "items" \[ { "timestamp" "2023 03 21t20 36 21 887z", "errorname" "failed to download sync list", "errorevent" "deviceerror", "reason" "connection timed out after 30000 milliseconds", "responsecode" 28 } ], "totalitemcount" 9, "matchingitemcount" 9, "pagesize" 1, "nextmarker" "9dh34d23bc1fjkdsa", "prevmarker" "9dh34d23bc1fj786t", "istruncated" false, "sortexpression" "\[deviceerror] \[timestamp] desc", "filterexpression" null } failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{serial}/errors/ returns a list of errors associated with a specified device required scope token bsn api main devices retrieve segment serial string string the serial number of the device that is reporting the errors query string parameters marker string string optional optional a value specifying which page to retrieve this value is useful if the istruncated entry in the response body of the previous get call indicates that the number of error instances exceeds the pagesize this parameter is only required if you need more elements in the paged list than the pagesize (100) pagesize int int optional optional the maximum number of error instances that can be contained in the response body request example the example request parameters and headers are set as follows serial is set to 46d89c101139 marker value is set to the \[pagedlist] \[nextmarker] property value from the previous bsn cloud api response pagesize is set to 1 get /2022/06/rest/devices/46d89c101139/errors/?pagesize=1\&marker=vsh54uh9mn0s http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response body 200 200 returns the player error entity (2022/06) docid 4vwry6lz2jtfpac07jfiq example { "items" \[ { "timestamp" "2023 03 21t20 36 21 887z", "errorname" "failed to download sync list", "errorevent" "deviceerror", "reason" "connection timed out after 30000 milliseconds", "responsecode" 28 } ], "totalitemcount" 9, "matchingitemcount" 9, "pagesize" 1, "nextmarker" "34dh04d23c00jk", "prevmarker" "34dh04d23cfhg9", "istruncated" false, "sortexpression" "\[deviceerror] \[timestamp] desc", "filterexpression" null } failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{id\ int}/downloads/ returns the downloads associated with a specified device required scope token bsn api main devices retrieve segment id int int the unique identifier for the device that has the download instances query string parameters marker string string optional optional a value specifying which page to retrieve this value is useful if the istruncated entry in the response body of the previous get call indicates that the number of download instances exceeds the pagesize this parameter is only required if you need more elements in the paged list than the pagesize (100) pagesize int int optional optional the maximum number of download instances that can be contained in the response body request example the example request parameters and headers are set as follows id is set to 12345 marker value is set to the \[pagedlist] \[nextmarker] property value from the previous bsn cloud api response pagesize is set to 3 get /2022/06/rest/devices/12345/downloads/?pagesize=3\&marker=bn548plv2hzw4tww http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json, application/ accept encoding gzip,deflate success response body 200 200 returns the player download entity (2022/06) docid 40qxugrq94l5ras hcmdv example { "items" \[ { "timestamp" "2021 05 04t17 44 06 533z", "filename" "zoombg jpeg", "filehash" "sha1 311822ed6a306cb3f2775cb3d9ff1a8c96680e92", "progress" 42, "status" "downloading" }, { "timestamp" "2021 05 04t17 44 06 533z", "filename" "featureminrevs json", "filehash" "sha1 98e4c18e11c4d41d5742756213c103b671b985e9", "progress" 100, "status" "ok" }, { "timestamp" "2021 05 04t17 44 06 533z", "filename" "autoplugins brs", "filehash" "sha1\ a0acb3e76c85e48d326e802428b23f1325667410", "progress" 100, "status" "ok" } ], "totalitemcount" 7, "matchingitemcount" 7, "pagesize" 3, "nextmarker" "hffakds789nm06", "prevmarker" "hffakds789/0nm", "istruncated" true, "sortexpression" "\[devicedownload] \[timestamp] desc", "filterexpression" null } failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{serial}/downloads/ returns a list of downloads carried out by a device (specified by serial number) required scope token bsn api main devices retrieve segment serial string string the serial number of the device that has the download instances query string parameters marker string string optional optional a value specifying which page to retrieve this value is useful if the istruncated entry in the response body of the previous get call indicates that the number of download instances exceeds the pagesize this parameter is only required if you need more elements in the paged list than the pagesize (100) pagesize int int optional optional the maximum number of download instances that can be contained in the response body request example the example request parameters and headers are set as follows serial is set to 46d89c101139 marker value is set to the \[pagedlist] \[nextmarker] property value from the previous bsn cloud api response pagesize is set to 3 get /2022/06/rest/devices/46d89c101139/downloads/?pagesize=3\&marker=w4tww3hcnmsmtcymu478ngh http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json, application/ accept encoding gzip,deflate success response body 200 200 returns the player download entity (2022/06) docid 40qxugrq94l5ras hcmdv example { "items" \[ { "timestamp" "2021 05 04t17 44 06 533z", "filename" "zoombg jpeg", "filehash" "sha1 311822ed6a306cb3f2775cb3d9ff1a8c96680e92", "progress" 42, "status" "downloading" }, { "timestamp" "2021 05 04t17 44 06 533z", "filename" "featureminrevs json", "filehash" "sha1 98e4c18e11c4d41d5742756213c103b671b985e9", "progress" 100, "status" "ok" }, { "timestamp" "2021 05 04t17 44 06 533z", "filename" "autoplugins brs", "filehash" "sha1\ a0acb3e76c85e48d326e802428b23f1325667410", "progress" 100, "status" "ok" } ], "totalitemcount" 7, "matchingitemcount" 7, "pagesize" 3, "nextmarker" "fjdkah890vdjk", "prevmarker" "fjdkah890546k", "istruncated" true, "sortexpression" "\[devicedownload] \[timestamp] desc", "filterexpression" null } failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{deviceid\ int}/screenshots/ returns a list of screenshots uploaded by a specified device required scope token bsn api main devices retrieve segment id int int the unique identifier for the device query string parameters marker string string optional optional a value specifying which page to retrieve this value is useful if the istruncated entry in the response body of the previous get call indicates that the number of screenshot instances exceeds the pagesize this parameter is only required if you need more elements in the paged list than the pagesize (100) pagesize int int optional optional the maximum number of screenshot instances that can be contained in the response body request example the example request parameters and headers are set as follows id is set to 1234567 marker value is set to the \[pagedlist] \[nextmarker] property value from the previous bsn cloud api response pagesize is set to 1 get /2022/06/rest/devices/1234567/screenshots/?marker=se4odyznf230otv\&pagesize=1 http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response body 200 200 returns the screenshot entity (2022/06) docid 0vlmdzog7wbnyvhxzebe example { "items" \[ { "id" 12345, "device" { "id" 1234567, "serial" "cfd02w901738" }, "groupname" "default", "presentationname" "videos and images", "utctimestamp" "2023 10 19t15 07 57z", "localtimestamp" "2023 10 19t10 07 57", "width" 1920, "height" 1080, "filepath" "https //bsncloud dssp s3 amazonaws com/devicescreenshots/public/cfd02w901738/2023 10 19t15 07 57 7710000z jpg", "filesize" 802681, "thumbpath" "https //bsncloud dssp s3 amazonaws com/devicescreenshots/public/cfd02w901738/2023 10 19t15 07 57 7710000z thumb 150x150 jpg" } ], "totalitemcount" 4, "matchingitemcount" 4, "pagesize" 1, "nextmarker" "lde4odyznti0otu=", "prevmarker" "lde4odyznti0h893", "istruncated" true, "sortexpression" "\[devicescreenshot] \[utctimestamp] desc", "filterexpression" null } failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{serial}/screenshots/ returns a list of screenshots uploaded by a specified device required scope token bsn api main devices retrieve segment serial string string the device serial number query string parameters marker string string optional optional a value specifying which page to retrieve this value is useful if the istruncated entry in the response body of the previous get call indicates that the number of screenshot instances exceeds the pagesize this parameter is only required if you need more elements in the paged list than the pagesize (100) pagesize int int optional optional the maximum number of screenshot instances that can be contained in the response body request example the example request parameters and headers are set as follows serial is set to cfd02w901738 marker value is set to the \[pagedlist] \[nextmarker] property value from the previous bsn cloud api response pagesize is set to 1 get /2022/06/rest/devices/cfd02w901738/screenshots/?marker=g140faj35k8as\&pagesize=1 http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response body 200 200 returns the screenshot entity (2022/06) docid 0vlmdzog7wbnyvhxzebe example { "items" \[ { "id" 12345, "device" { "id" 1234567, "serial" "cfd02w901738" }, "groupname" "default", "presentationname" "videos and images", "utctimestamp" "2023 10 19t15 07 57z", "localtimestamp" "2023 10 19t10 07 57", "width" 1920, "height" 1080, "filepath" "https //bsncloud dssp s3 amazonaws com/devicescreenshots/public/cfd02w901738/2023 10 19t15 07 57 7710000z jpg", "filesize" 802681, "thumbpath" "https //bsncloud dssp s3 amazonaws com/devicescreenshots/public/cfd02w901738/2023 10 19t15 07 57 7710000z thumb 150x150 jpg" } ], "totalitemcount" 4, "matchingitemcount" 4, "pagesize" 1, "nextmarker" "gh0dkf78aok34", "prevmarker" "gh0dkf78a5783", "istruncated" true, "sortexpression" "\[devicescreenshot] \[utctimestamp] desc", "filterexpression" null } failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /screenshots/ returns a list of screenshots uploaded by a device required scope token bsn api main devices retrieve query string parameters projection string string optional optional this parameter currently supports only one placeholder ( top({int},\[nodes])] ) which limits the number of entities in a group the possible value for {int} is any number from 1 to 100 filter string string optional optional an filtering and sorting expressions in the main api docid 3l0afyd3xooe ytvfk2vs for filtering search results grouping string string optional optional a grouping expression for the filtered entities this parameter can be used with the projection parameter to retrieve a certain number of screenshots for a large number of devices in one request (for example, 100 screenshots from 100 players) sort string string optional optional an expression for sorting the search results the sort expression specifies the entry used for sorting and the ascending/descending (asc/desc) sorting order (e g "\[device] \[serial] asc") marker string string optional optional a value specifying which page to retrieve this value is useful if the istruncated entry in the response body of the previous get call indicates that the number of screenshot instances exceeds the pagesize this parameter is only required if you need more elements in the paged list than the pagesize (100) pagesize int int optional optional the maximum number of screenshot instances that can be contained in the response body request example the example request parameters and headers are set as follows projection is set to top(3,\[nodes]) filter is set to \[groupname] is 'default' grouping is set to \[serial] sort is set to \[id] asc marker value is set to the \[pagedlist] \[nextmarker] property value from the previous bsn cloud api response pagesize is set to 1 get /2022/06/rest/devices/screenshots/?marker=mtgzmda1mtq5miwxodmwmduxndky\&projection=top%283%2c%5bnodes%5d%29\&pagesize=1\&filter=%5bgroupname%5d%20is%20%27default%27\&grouping=%5bserial%5d\&sort=%5bid%5d%20asc http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json, application/ accept encoding gzip,deflate success response body 200 200 returns the screenshot entity (2022/06) docid 0vlmdzog7wbnyvhxzebe example { "items" \[ { "id" 1829566038, "device" { "id" 0123456, "serial" "e9e8j5401510" }, "groupname" "default", "presentationname" "videos and images", "utctimestamp" "2023 09 22t06 05 43z", "localtimestamp" "2023 09 22t01 05 43", "width" 1920, "height" 1080, "filepath" "https //bsncloud dssp s3 amazonaws com/devicescreenshots/public/d9e8d5001519/2023 09 22t06 05 43 2670000z jpg", "filesize" 1169176, "thumbpath" "https //bsncloud dssp s3 amazonaws com/devicescreenshots/public/d9e8d5001519/2023 09 22t06 05 43 2670000z thumb 150x150 jpg" } ], "totalitemcount" 1256, "matchingitemcount" 19, "pagesize" 1, "nextmarker" "mtgyotywodm2ncwxodi5nja4mzy0", "prevmarker" "mtgyotywodm2ncwxodi5nja478gh", "istruncated" true, "sortexpression" "\[id] asc", "filterexpression" "\[groupname] is 'default'" } failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{id\ int}/tags/ returns an object whose property names match tag keys and whose property values match tag values on a device required scope token bsn api main devices retrieve segment id int int the unique identifier for the device request example the example request parameters and headers are set as follows id is set to 12345 get /2022/06/rest/devices/12345/tags/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response body 200 200 a collection of key value pairs where the key is tag name, and the value is tag value see the tags entry in player entity (2022/06) docid 9pqprrjavwfzbka1gybea for more information example {"string \[device] \<testing2>" "playallday"} failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error post /{id\ int}/tags/ adds tags to a specified device required scope token bsn api main devices update segment id int int the unique identifier for the device request body tags dynamicobject dynamicobject a collection of key value pairs where the key is tag name, and the value is tag value see the tags entry in player entity (2022/06) docid 9pqprrjavwfzbka1gybea for more information request example the example request parameters and headers are set as follows id is set to 12345 post /2022/06/rest/devices/12345/tags/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate content type application/json content length 73 this is the example request body { &#x9;"number \[device] \<number>" "1", &#x9;"boolean \[device] \<boolean>"\ true } success response 204 204 the tags were added to the specified device failure response 400 400 either a tag with the specified key was already defined, the request is malformed and therefore invalid, or there is a conflict 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error delete /{id\ int}/tags/ remove tags from a specified device required scope token bsn api main devices update segment id int int the unique identifier for the device request body list string\[] string\[] an array of tag keys to delete request example the example request parameters and headers are set as follows id is set to 12345 delete /2022/06/rest/devices/12345/tags/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate content type application/json content length 64 this is the example request body \[ &#x9;"number \[device] \<number>", &#x9;"boolean \[device] \<boolean>" ] success response 204 204 the specified tag was successfully deleted from the device failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance to the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{serial}/tags/ returns an object whose property names match tag keys and whose property values match tag values on a device required scope token bsn api main devices retrieve segment serial string string the device serial number request example the example request parameters and headers are set as follows serial is set to 35f89c022150 get /2022/06/rest/devices/35f89c022150/tags/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response body 200 200 a collection of key value pairs where the key is tag name, and the value is tag value see the tags entry in the player entity (2022/06) docid 9pqprrjavwfzbka1gybea for more information example {"string \[device] \<testing2>" "playallday"} failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error post /{serial}/tags/ adds one or more tags to a specified device required scope token bsn api main devices update segment serial string string the device serial number request body tags dynamicobject dynamicobject a collection of key value pairs where the key is tag name, and the value is tag value see the tags entry in the player entity (2022/06) docid 9pqprrjavwfzbka1gybea for more information request example the example request parameters and headers are set as follows serial is set to 35f89c022150 post /2022/06/rest/devices/35f89c022150/tags/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate content type application/json content length 73 this is the example request body { &#x9;"number \[device] \<number>" "1", &#x9;"boolean \[device] \<boolean>"\ true } success response 204 204 the tags were added to the specified device failure response 400 400 either a tag with the specified key was already defined, the request is malformed and therefore invalid, or there is a conflict 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error delete /{serial}/tags/ removes one or more tags from a specified device required scope token bsn api main devices update segment serial string string the device serial number request body list string\[] string\[] an array of tag keys to delete request example the example request parameters and headers are set as follows serial is set to 35f89c022150 delete /2022/06/rest/devices/35f89c022150/tags/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate content type application/json content length 64 this is the example request body \[ &#x9;"number \[device] \<number>", &#x9;"boolean \[device] \<boolean>" ] success response 204 204 the specified tag was successfully deleted from the device failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance to the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /models/ returns the list of player models supported by the current main api version required scope token bsn api main devices retrieve request example the example request parameters and headers are set as follows get /2022/06/rest/devices/models/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response body 200 200 returns the complete list of player models that are supported on this main api version example \[ "hd223", "hd1023", "hd1423", "ls423", "xd233", "xd1033", "xd1133", "xt243", "xt1043", "xt1143", "4k242", "4k1042", "4k1142", "hs123", "ho523", "xd234", "xd1034", "xt244", "xt1144", "hs124", "hs144", "ls424", "hd224", "hd1024", "au325", "au335", "xc2055", "xc4055", "ls425", "ls445", "hs125", "hs145", "hd225", "hd1025", "xd235", "xd1035", "xt245", "xt1145", "xt2145" ] failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /models/{model}/ returns the list of player models supported by the current main api version required scope token bsn api main devices retrieve segment model string string the player model request example the example request parameters and headers are set as follows model is xd1034 get /2022/06/rest/devices/models/xd1034/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response body 200 200 returns the complete list of player models that are supported on this main api version example "xd1034" failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the provided player model does not exist (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /models/{model}/connectors/ returns the list of connectors available on a given device model required scope token bsn api main devices retrieve segment model string string the player model request example the example request parameters and headers are set as follows model is set to xd1034 get /2022/06/rest/devices/models/xd1034/connectors/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response body 200 200 returns the list of connectors available on a given device model example \["hdmi"] failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the provided player model does not exist or is incorrect 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /models/{model}/connectors/{connector}/ returns the list of connectors available on a given device model required scope token bsn api main devices retrieve segment model string string the player model connector string string the video connector (for example, "hdmi" or "displayport") request example the example request parameters and headers are set as follows model is set to xd1034 connector is set to hdmi get /2022/06/rest/devices/models/xd1034/connectors/hdmi/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response body 200 200 returns the list of connectors available on a given device model example "hdmi" failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the provided player model or connector does not exist or is incorrect 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /models/{model}/connectors/{connector}/videomodes/ returns the video modes docid\ qpml112mbhek7lbdguxnv supported by the specified connector on the specified device model required scope token bsn api main devices retrieve segment model string string the player model connector string string the video connector (for example, "hdmi" or "displayport") request example the example request parameters and headers are set as follows model is set to xd1034 connector is set to hdmi get /2022/06/rest/devices/models/xd1034/connectors/hdmi/videomodes/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response body 200 200 the response body is an array of strings listing video modes docid\ qpml112mbhek7lbdguxnv supported by the specified connector on the specified device model example \[ "4096x2160x23 976p", "4096x2160x24p", "4096x2160x25p", "4096x2160x29 97p", "4096x2160x30p", "4096x2160x50p", "4096x2160x59 94p", "4096x2160x60p", "3840x2160x60p", "3840x2160x59 94p", "3840x2160x50p", "3840x2160x30p", "3840x2160x29 97p", "3840x2160x25p", "3840x2160x24p", "3840x2160x23 976p", "3840x1080x60p", "3840x1080x50p", "3840x1080x30p", "3840x1080x25p", "3840x600x60p", "3440x1440x60p", "3440x1440x50p", "3440x1440x30p", "2560x1600x60p", "2560x1440x60p", "2560x1440x30p", "2560x1080x60p", "2560x960x60p", "2048x1152x60p", "1920x1920x60p", "1920x1200x60p", "1920x1200x50p", "1920x1080x60p", "1920x1080x59 94p", "1920x1080x50p", "1920x1080x30p", "1920x1080x29 97p", "1920x1080x25p", "1920x1080x24p", "1920x1080x23 976p", "1920x1080x60i", "1920x1080x59 94i", "1920x1080x50i", "1920x540x60p", "1680x1050x60p", "1600x1200x60p", "1600x900x60p", "1440x1080x60p", "1440x900x75p", "1440x900x60p", "1400x1050x75p", "1400x1050x60p", "1366x768x60p", "1360x768x60p", "1280x1024x75p", "1280x1024x60p", "1280x960x60p", "1280x800x75p", "1280x800x60p", "1280x768x60p", "1280x720x60p", "1280x720x59 94p", "1280x720x50p", "1280x720x25p", "1280x720x24p", "1280x720x23 976p", "1200x1920x60p", "1024x768x75p", "1024x768x60p", "960x960x60p", "800x1280x60p", "800x600x75p", "800x600x60p", "720x576x50p", "720x576x50i", "720x480x60p", "720x480x60i", "720x480x59 94p", "640x480x60p" ] failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the provided player model or connector does not exist or is incorrect 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /operations/ returns operational permissions granted to roles for specific business operations required scope token bsn api main operations retrieve request example the example request parameters and headers are set as follows get /2022/06/rest/devices/operations/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response body 200 200 returns the business operations entity (2022/06) docid\ ei98k7oul6z5i 5b d6js example { "uid" "9bf0a633 52a5 6b94 2d45 16c4c1c8c025", "singularname" "full control", "pluralname" "device (full control)", "fullname" "device (full control)", "targetentity" "device", "appliance" "instance, collection", "parent" null, "descendants" \[ { "uid" "7d71c53e ae40 59c4 f972 28e8b4dfabcf", "singularname" "view device", "pluralname" "view devices", "fullname" "device (full control) view devices", "targetentity" "device", "appliance" "instance, collection", "parent" { "uid" "9bf0a633 52a5 6b94 2d45 16c4c1c8c025", "singularname" "full control", "pluralname" "device (full control)", "fullname" "device (full control)", "targetentity" "device", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "7d71c53e ae40 59c4 f972 28e8b4dfabcf", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 03 05t16 59 07 35z" }, { "entityid" null, "operationuid" "7d71c53e ae40 59c4 f972 28e8b4dfabcf", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 153z" }, { "entityid" null, "operationuid" "7d71c53e ae40 59c4 f972 28e8b4dfabcf", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 41z" }, { "entityid" null, "operationuid" "7d71c53e ae40 59c4 f972 28e8b4dfabcf", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 05 72z" }, { "entityid" null, "operationuid" "7d71c53e ae40 59c4 f972 28e8b4dfabcf", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 06 163z" }, { "entityid" null, "operationuid" "7d71c53e ae40 59c4 f972 28e8b4dfabcf", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 06 73z" } ] }, { "uid" "0595648a ab46 6bf4 417e 429d90821b49", "singularname" "export device", "pluralname" "export devices list", "fullname" "device (full control) export devices list", "targetentity" "device", "appliance" "instance, collection", "parent" { "uid" "9bf0a633 52a5 6b94 2d45 16c4c1c8c025", "singularname" "full control", "pluralname" "device (full control)", "fullname" "device (full control)", "targetentity" "device", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "0595648a ab46 6bf4 417e 429d90821b49", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 03 05t16 59 07 363z" }, { "entityid" null, "operationuid" "0595648a ab46 6bf4 417e 429d90821b49", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 153z" }, { "entityid" null, "operationuid" "0595648a ab46 6bf4 417e 429d90821b49", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 41z" }, { "entityid" null, "operationuid" "0595648a ab46 6bf4 417e 429d90821b49", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 05 72z" }, { "entityid" null, "operationuid" "0595648a ab46 6bf4 417e 429d90821b49", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 06 163z" }, { "entityid" null, "operationuid" "0595648a ab46 6bf4 417e 429d90821b49", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 06 73z" } ] }, { "uid" "3c97788f e17a 42d4 b15d 65e53fb84ddc", "singularname" "view device downloads", "pluralname" "view device downloads", "fullname" "device (full control) view device downloads", "targetentity" "device", "appliance" "instance, collection", "parent" { "uid" "9bf0a633 52a5 6b94 2d45 16c4c1c8c025", "singularname" "full control", "pluralname" "device (full control)", "fullname" "device (full control)", "targetentity" "device", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "3c97788f e17a 42d4 b15d 65e53fb84ddc", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 03 05t16 59 07 4z" }, { "entityid" null, "operationuid" "3c97788f e17a 42d4 b15d 65e53fb84ddc", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 153z" }, { "entityid" null, "operationuid" "3c97788f e17a 42d4 b15d 65e53fb84ddc", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 41z" }, { "entityid" null, "operationuid" "3c97788f e17a 42d4 b15d 65e53fb84ddc", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 05 72z" }, { "entityid" null, "operationuid" "3c97788f e17a 42d4 b15d 65e53fb84ddc", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 06 163z" }, { "entityid" null, "operationuid" "3c97788f e17a 42d4 b15d 65e53fb84ddc", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 06 73z" } ] }, { "uid" "45b82bbe 34eb 4eab 8439 370d46cc5528", "singularname" "view device battery status", "pluralname" "view device battery status", "fullname" "device (full control) view device battery status", "targetentity" "device", "appliance" "instance, collection", "parent" { "uid" "9bf0a633 52a5 6b94 2d45 16c4c1c8c025", "singularname" "full control", "pluralname" "device (full control)", "fullname" "device (full control)", "targetentity" "device", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "45b82bbe 34eb 4eab 8439 370d46cc5528", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 03 05t16 59 07 413z" }, { "entityid" null, "operationuid" "45b82bbe 34eb 4eab 8439 370d46cc5528", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 153z" }, { "entityid" null, "operationuid" "45b82bbe 34eb 4eab 8439 370d46cc5528", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 41z" }, { "entityid" null, "operationuid" "45b82bbe 34eb 4eab 8439 370d46cc5528", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 05 72z" }, { "entityid" null, "operationuid" "45b82bbe 34eb 4eab 8439 370d46cc5528", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 06 163z" }, { "entityid" null, "operationuid" "45b82bbe 34eb 4eab 8439 370d46cc5528", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 06 73z" } ] }, { "uid" "0cf93b59 dbd4 4ad1 89b4 4024c08d8ddc", "singularname" "view remote snapshots", "pluralname" "view remote snapshots", "fullname" "device (full control) view remote snapshots", "targetentity" "device", "appliance" "instance, collection", "parent" { "uid" "9bf0a633 52a5 6b94 2d45 16c4c1c8c025", "singularname" "full control", "pluralname" "device (full control)", "fullname" "device (full control)", "targetentity" "device", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "0cf93b59 dbd4 4ad1 89b4 4024c08d8ddc", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 03 05t16 59 07 44z" }, { "entityid" null, "operationuid" "0cf93b59 dbd4 4ad1 89b4 4024c08d8ddc", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 153z" }, { "entityid" null, "operationuid" "0cf93b59 dbd4 4ad1 89b4 4024c08d8ddc", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 41z" }, { "entityid" null, "operationuid" "0cf93b59 dbd4 4ad1 89b4 4024c08d8ddc", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 05 72z" }, { "entityid" null, "operationuid" "0cf93b59 dbd4 4ad1 89b4 4024c08d8ddc", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 06 163z" }, { "entityid" null, "operationuid" "0cf93b59 dbd4 4ad1 89b4 4024c08d8ddc", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 06 73z" } ] }, { "uid" "f396dc0f f3b6 4d1b acd4 4063b47e3025", "singularname" "view device log reports", "pluralname" "view device log reports", "fullname" "device (full control) view device log reports", "targetentity" "device", "appliance" "instance, collection", "parent" { "uid" "9bf0a633 52a5 6b94 2d45 16c4c1c8c025", "singularname" "full control", "pluralname" "device (full control)", "fullname" "device (full control)", "targetentity" "device", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "f396dc0f f3b6 4d1b acd4 4063b47e3025", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 03 05t16 59 07 427z" }, { "entityid" null, "operationuid" "f396dc0f f3b6 4d1b acd4 4063b47e3025", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 153z" }, { "entityid" null, "operationuid" "f396dc0f f3b6 4d1b acd4 4063b47e3025", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 41z" }, { "entityid" null, "operationuid" "f396dc0f f3b6 4d1b acd4 4063b47e3025", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 05 72z" }, { "entityid" null, "operationuid" "f396dc0f f3b6 4d1b acd4 4063b47e3025", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 06 163z" }, { "entityid" null, "operationuid" "f396dc0f f3b6 4d1b acd4 4063b47e3025", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 06 73z" } ] }, { "uid" "9e4cc8d8 45fe 4fb4 01fc 170bf90449b2", "singularname" "get device log reports", "pluralname" "get device log reports", "fullname" "device (full control) get device log reports", "targetentity" "device", "appliance" "instance, collection", "parent" { "uid" "9bf0a633 52a5 6b94 2d45 16c4c1c8c025", "singularname" "full control", "pluralname" "device (full control)", "fullname" "device (full control)", "targetentity" "device", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "9e4cc8d8 45fe 4fb4 01fc 170bf90449b2", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 03 05t16 59 07 453z" }, { "entityid" null, "operationuid" "9e4cc8d8 45fe 4fb4 01fc 170bf90449b2", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 153z" }, { "entityid" null, "operationuid" "9e4cc8d8 45fe 4fb4 01fc 170bf90449b2", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 41z" }, { "entityid" null, "operationuid" "9e4cc8d8 45fe 4fb4 01fc 170bf90449b2", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 05 72z" }, { "entityid" null, "operationuid" "9e4cc8d8 45fe 4fb4 01fc 170bf90449b2", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 06 163z" }, { "entityid" null, "operationuid" "9e4cc8d8 45fe 4fb4 01fc 170bf90449b2", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 06 73z" } ] }, { "uid" "6e006934 6070 4a3a bb7e 5527ef5a5034", "singularname" "setup device", "pluralname" "setup devices", "fullname" "device (full control) setup devices", "targetentity" "device", "appliance" "instance, collection", "parent" { "uid" "9bf0a633 52a5 6b94 2d45 16c4c1c8c025", "singularname" "full control", "pluralname" "device (full control)", "fullname" "device (full control)", "targetentity" "device", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "6e006934 6070 4a3a bb7e 5527ef5a5034", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 153z" }, { "entityid" null, "operationuid" "6e006934 6070 4a3a bb7e 5527ef5a5034", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 41z" }, { "entityid" null, "operationuid" "6e006934 6070 4a3a bb7e 5527ef5a5034", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 05 72z" }, { "entityid" null, "operationuid" "6e006934 6070 4a3a bb7e 5527ef5a5034", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 06 163z" }, { "entityid" null, "operationuid" "6e006934 6070 4a3a bb7e 5527ef5a5034", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 06 73z" }, { "entityid" null, "operationuid" "6e006934 6070 4a3a bb7e 5527ef5a5034", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 07 337z" } ] }, { "uid" "d89437e0 21fa 74b4 c1fe b66c6270b176", "singularname" "update device", "pluralname" "update device", "fullname" "device (full control) update device", "targetentity" "device", "appliance" "instance, collection", "parent" { "uid" "9bf0a633 52a5 6b94 2d45 16c4c1c8c025", "singularname" "full control", "pluralname" "device (full control)", "fullname" "device (full control)", "targetentity" "device", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "d89437e0 21fa 74b4 c1fe b66c6270b176", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 153z" }, { "entityid" null, "operationuid" "d89437e0 21fa 74b4 c1fe b66c6270b176", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 41z" }, { "entityid" null, "operationuid" "d89437e0 21fa 74b4 c1fe b66c6270b176", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 05 72z" }, { "entityid" null, "operationuid" "d89437e0 21fa 74b4 c1fe b66c6270b176", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 06 163z" }, { "entityid" null, "operationuid" "d89437e0 21fa 74b4 c1fe b66c6270b176", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 06 73z" }, { "entityid" null, "operationuid" "d89437e0 21fa 74b4 c1fe b66c6270b176", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 07 337z" } ] }, { "uid" "c889ca96 5a6e a904 318b 978d8f4282f6", "singularname" "change target group", "pluralname" "change target group", "fullname" "device (full control) change target group", "targetentity" "device", "appliance" "instance, collection", "parent" { "uid" "9bf0a633 52a5 6b94 2d45 16c4c1c8c025", "singularname" "full control", "pluralname" "device (full control)", "fullname" "device (full control)", "targetentity" "device", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "c889ca96 5a6e a904 318b 978d8f4282f6", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 153z" }, { "entityid" null, "operationuid" "c889ca96 5a6e a904 318b 978d8f4282f6", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 41z" }, { "entityid" null, "operationuid" "c889ca96 5a6e a904 318b 978d8f4282f6", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 05 72z" }, { "entityid" null, "operationuid" "c889ca96 5a6e a904 318b 978d8f4282f6", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 06 163z" }, { "entityid" null, "operationuid" "c889ca96 5a6e a904 318b 978d8f4282f6", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 06 73z" }, { "entityid" null, "operationuid" "c889ca96 5a6e a904 318b 978d8f4282f6", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 07 337z" } ] }, { "uid" "1b213d9c 1fbe 44ed 86ab f67179f12640", "singularname" "manage tags", "pluralname" "manage tags", "fullname" "device (full control) manage tags", "targetentity" "device", "appliance" "instance, collection", "parent" { "uid" "9bf0a633 52a5 6b94 2d45 16c4c1c8c025", "singularname" "full control", "pluralname" "device (full control)", "fullname" "device (full control)", "targetentity" "device", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "1b213d9c 1fbe 44ed 86ab f67179f12640", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 153z" }, { "entityid" null, "operationuid" "1b213d9c 1fbe 44ed 86ab f67179f12640", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 41z" }, { "entityid" null, "operationuid" "1b213d9c 1fbe 44ed 86ab f67179f12640", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 05 72z" }, { "entityid" null, "operationuid" "1b213d9c 1fbe 44ed 86ab f67179f12640", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 06 163z" }, { "entityid" null, "operationuid" "1b213d9c 1fbe 44ed 86ab f67179f12640", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 06 73z" }, { "entityid" null, "operationuid" "1b213d9c 1fbe 44ed 86ab f67179f12640", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 07 337z" } ] }, { "uid" "b15c6202 171f 40ac 80db 507f1b4f83e2", "singularname" "unit control", "pluralname" "unit control", "fullname" "device (full control) unit control", "targetentity" "device", "appliance" "instance, collection", "parent" { "uid" "9bf0a633 52a5 6b94 2d45 16c4c1c8c025", "singularname" "full control", "pluralname" "device (full control)", "fullname" "device (full control)", "targetentity" "device", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "b15c6202 171f 40ac 80db 507f1b4f83e2", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 153z" }, { "entityid" null, "operationuid" "b15c6202 171f 40ac 80db 507f1b4f83e2", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 41z" }, { "entityid" null, "operationuid" "b15c6202 171f 40ac 80db 507f1b4f83e2", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 05 72z" }, { "entityid" null, "operationuid" "b15c6202 171f 40ac 80db 507f1b4f83e2", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 06 163z" }, { "entityid" null, "operationuid" "b15c6202 171f 40ac 80db 507f1b4f83e2", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 06 73z" }, { "entityid" null, "operationuid" "b15c6202 171f 40ac 80db 507f1b4f83e2", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 07 337z" } ] }, { "uid" "6e41336d be6b 4549 9acb afb1cefe5211", "singularname" "add subscriptions", "pluralname" "add subscriptions", "fullname" "device (full control) add subscriptions", "targetentity" "device", "appliance" "instance, collection", "parent" { "uid" "9bf0a633 52a5 6b94 2d45 16c4c1c8c025", "singularname" "full control", "pluralname" "device (full control)", "fullname" "device (full control)", "targetentity" "device", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "6e41336d be6b 4549 9acb afb1cefe5211", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 153z" }, { "entityid" null, "operationuid" "6e41336d be6b 4549 9acb afb1cefe5211", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 41z" }, { "entityid" null, "operationuid" "6e41336d be6b 4549 9acb afb1cefe5211", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 05 72z" }, { "entityid" null, "operationuid" "6e41336d be6b 4549 9acb afb1cefe5211", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 06 163z" }, { "entityid" null, "operationuid" "6e41336d be6b 4549 9acb afb1cefe5211", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 06 73z" }, { "entityid" null, "operationuid" "6e41336d be6b 4549 9acb afb1cefe5211", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 07 337z" } ] }, { "uid" "3ec8d3c9 5ceb c404 b976 cbc6ce2d95be", "singularname" "edit permissions", "pluralname" "edit permissions", "fullname" "device (full control) edit permissions", "targetentity" "device", "appliance" "collection", "parent" { "uid" "9bf0a633 52a5 6b94 2d45 16c4c1c8c025", "singularname" "full control", "pluralname" "device (full control)", "fullname" "device (full control)", "targetentity" "device", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "3ec8d3c9 5ceb c404 b976 cbc6ce2d95be", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 153z" }, { "entityid" null, "operationuid" "3ec8d3c9 5ceb c404 b976 cbc6ce2d95be", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 41z" }, { "entityid" null, "operationuid" "3ec8d3c9 5ceb c404 b976 cbc6ce2d95be", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 05 72z" }, { "entityid" null, "operationuid" "3ec8d3c9 5ceb c404 b976 cbc6ce2d95be", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 06 163z" }, { "entityid" null, "operationuid" "3ec8d3c9 5ceb c404 b976 cbc6ce2d95be", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 06 73z" }, { "entityid" null, "operationuid" "3ec8d3c9 5ceb c404 b976 cbc6ce2d95be", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 07 337z" } ] }, { "uid" "da52a016 4e82 ce64 dded a8dcd0de0ce3", "singularname" "delete device", "pluralname" "delete device", "fullname" "device (full control) delete device", "targetentity" "device", "appliance" "instance, collection", "parent" { "uid" "9bf0a633 52a5 6b94 2d45 16c4c1c8c025", "singularname" "full control", "pluralname" "device (full control)", "fullname" "device (full control)", "targetentity" "device", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "da52a016 4e82 ce64 dded a8dcd0de0ce3", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 153z" }, { "entityid" null, "operationuid" "da52a016 4e82 ce64 dded a8dcd0de0ce3", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 41z" }, { "entityid" null, "operationuid" "da52a016 4e82 ce64 dded a8dcd0de0ce3", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 05 72z" }, { "entityid" null, "operationuid" "da52a016 4e82 ce64 dded a8dcd0de0ce3", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 06 163z" }, { "entityid" null, "operationuid" "da52a016 4e82 ce64 dded a8dcd0de0ce3", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 06 73z" }, { "entityid" null, "operationuid" "da52a016 4e82 ce64 dded a8dcd0de0ce3", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 07 337z" } ] }, { "uid" "9e8c409d b81f 46ed bd60 c24ee77ce139", "singularname" "revoke tokens", "pluralname" "revoke tokens", "fullname" "device (full control) revoke tokens", "targetentity" "device", "appliance" "instance, collection", "parent" { "uid" "9bf0a633 52a5 6b94 2d45 16c4c1c8c025", "singularname" "full control", "pluralname" "device (full control)", "fullname" "device (full control)", "targetentity" "device", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "9e8c409d b81f 46ed bd60 c24ee77ce139", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 153z" }, { "entityid" null, "operationuid" "9e8c409d b81f 46ed bd60 c24ee77ce139", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 41z" }, { "entityid" null, "operationuid" "9e8c409d b81f 46ed bd60 c24ee77ce139", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 05 72z" }, { "entityid" null, "operationuid" "9e8c409d b81f 46ed bd60 c24ee77ce139", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 06 163z" }, { "entityid" null, "operationuid" "9e8c409d b81f 46ed bd60 c24ee77ce139", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 06 73z" }, { "entityid" null, "operationuid" "9e8c409d b81f 46ed bd60 c24ee77ce139", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 07 337z" } ] } ], "permissions" \[ { "entityid" null, "operationuid" "9bf0a633 52a5 6b94 2d45 16c4c1c8c025", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 03 05t16 59 05 153z" }, { "entityid" null, "operationuid" "9bf0a633 52a5 6b94 2d45 16c4c1c8c025", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 03 05t16 59 05 41z" }, { "entityid" null, "operationuid" "9bf0a633 52a5 6b94 2d45 16c4c1c8c025", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" false, "isallowed" false, "creationdate" "2020 03 05t16 59 05 72z" }, { "entityid" null, "operationuid" "9bf0a633 52a5 6b94 2d45 16c4c1c8c025", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" false, "isallowed" false, "creationdate" "2020 03 05t16 59 06 163z" }, { "entityid" null, "operationuid" "9bf0a633 52a5 6b94 2d45 16c4c1c8c025", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 03 05t16 59 06 73z" }, { "entityid" null, "operationuid" "9bf0a633 52a5 6b94 2d45 16c4c1c8c025", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" false, "isallowed" false, "creationdate" "2020 03 05t16 59 07 337z" } ] } failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{id\ int}/permissions/ returns the list of permissions allowing or denying specific business operations to be executed on the specified device required scope token bsn api main devices retrieve segment id int int a unique identifier for the device request example the example request parameters and headers are set as follows id is set to 12345 get /2022/06/rest/devices/12345/permissions/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response body 200 200 returns an array of permission entity (2022/06) docid\ jwfymc42cdrg5jy2skysu entities example \[ { "entityid" 12345, "operationuid" "7d71c53e ae40 59c4 f972 28e8b4dfabcf", "principal" { "login" "janedoe\@brightsign biz", "type" "user", "id" 54321 }, "isfixed" false, "isinherited" false, "isallowed" false, "creationdate" "2023 10 06t15 55 35 587z" }, { "entityid" 12345, "operationuid" "0cf93b59 dbd4 4ad1 89b4 4024c08d8ddc", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 54321 }, "isfixed" false, "isinherited" false, "isallowed" true, "creationdate" "2023 10 06t15 55 35 553z" } ] failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error post /{id\ int}/permissions/ applies permissions allowing or denying specific business operations to be executed on a specified device required scope token bsn api main devices update segment id int int a unique identifier for the device request body an array of permission entity (2022/06) docid\ jwfymc42cdrg5jy2skysu entities request example the example request parameters and headers are set as follows id is set to 12345 post /2022/06/rest/devices/12345/permissions/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate content type application/json content length 322 this is the example request body \[ { "entityid" 12345, "operationuid" "7d71c53e ae40 59c4 f972 28e8b4dfabcf", "principal" { "login" "janedoe\@brightsign biz", "type" "user", "id" 54321 }, "isfixed" false, "isinherited" false, "isallowed" false, "creationdate" "0001 01 01t00 00 00" } ] success response 204 204 the specified permissions were successfully granted failure response 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance to the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error delete /{id\ int}/permissions/ removes custom permissions granted to execute business operations from a specified device required scope token bsn api main devices update segment id int int a unique identifier for the device request body an array of permission entity (2022/06) docid\ jwfymc42cdrg5jy2skysu entities request example the example request parameters and headers are set as follows id is set to 12345 delete /2022/06/rest/devices/12345/permissions/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate content type application/json content length 322 this is the example request body \[ { "entityid" 12345, "operationuid" "7d71c53e ae40 59c4 f972 28e8b4dfabcf", "principal" { "login" "janedoe\@brightsign biz", "type" "user", "id" 54321 }, "isfixed" false, "isinherited" false, "isallowed" false, "creationdate" "0001 01 01t00 00 00" } ] success response 204 204 the specified permissions were successfully deleted from the device failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance to the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{serial}/permissions/ returns the list of permissions allowing or denying specific business operations to be executed on a specified device required scope token bsn api main devices retrieve segment serial string string the serial number of the device request example the example request parameters and headers are set as follows serial is set to 46d89c001033 get /2022/06/rest/devices/46d89c001033/permissions/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response body 200 200 returns an array of permission entity (2022/06) docid\ jwfymc42cdrg5jy2skysu entities example \[ { "entityid" 12345, "operationuid" "7d71c53e ae40 59c4 f972 28e8b4dfabcf", "principal" { "login" "janedoe\@brightsign biz", "type" "user", "id" 54321 }, "isfixed" false, "isinherited" false, "isallowed" false, "creationdate" "2023 10 06t15 55 35 587z" }, { "entityid" 12345, "operationuid" "0cf93b59 dbd4 4ad1 89b4 4024c08d8ddc", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 54321 }, "isfixed" false, "isinherited" false, "isallowed" true, "creationdate" "2023 10 06t15 55 35 553z" } ] failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error post /{serial}/permissions/ applies permissions allowing or denying specific business operations to be executed on a specified device required scope token bsn api main devices update segment serial string string the serial number of the device request body an array of permission entity (2022/06) docid\ jwfymc42cdrg5jy2skysu entities request example the example request parameters and headers are set as follows serial is set to 46d89c001032 post /2022/06/rest/devices/46d89c001032/permissions/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate content type application/json content length 322 this is the example request body \[ { "entityid" 12345, "operationuid" "7d71c53e ae40 59c4 f972 28e8b4dfabcf", "principal" { "login" "janedoe\@brightsign biz", "type" "user", "id" 54321 }, "isfixed" false, "isinherited" false, "isallowed" false, "creationdate" "0001 01 01t00 00 00" } ] success response 204 204 the specified permissions were successfully granted failure response 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance to the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error delete /{serial}/permissions/ removes custom permissions granted to execute business operations from a specified device required scope token bsn api main devices update segment serial string string the serial number of the device request body an array of permission entity (2022/06) docid\ jwfymc42cdrg5jy2skysu entities request example the example request parameters and headers are set as follows serial is set to 46d89c001033 delete /2022/06/rest/devices/46d89c001033/permissions/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate content type application/json content length 322 this is the example request body \[ { "entityid" 12345, "operationuid" "7d71c53e ae40 59c4 f972 28e8b4dfabcf", "principal" { "login" "janedoe\@brightsign biz", "type" "user", "id" 54321 }, "isfixed" false, "isinherited" false, "isallowed" false, "creationdate" "0001 01 01t00 00 00" } ] success response 204 204 the specified permissions were successfully deleted from the device failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance to the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{serial}/tokens/{token}/ validates an oauth2 device access or refresh token on a specified device required scope token bsn api main devices token validate segment serial string string the serial number of the device token string string an oauth2 device access or refresh token issued for the specified device request example the example request parameters and headers are set as follows serial is set to 47g49c000042 token is set to {{token}} get /2022/06/rest/device/47g49c000042/tokens/{{token}}/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{usersaccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response body 200 200 returns the token info entity (2022/06) docid\ rmbcir76z7ojsyjb u2pp example { "token" {{token}}, "scope" "bdeploy certs bsn api device bsn api main groups regular retrieve bsn api main groups regular schedule retrieve bsn api main content retrieve", "validfrom" "2023 11 29t17 43 55z", "validto" "2023 11 29t17 58 55z" } failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error delete /{serial}/tokens/{token}/ revokes an oauth2 device access or refresh token on a specified device required scope token bsn api main devices token revoke segment serial string string the serial number of the device token string string an oauth2 device access or refresh token issued for the specified device request example the example request parameters and headers are set as follows serial is set to 47g49c000042 token is set to {{token}} delete /2022/06/rest/device/47g49c000042/tokens/{{token}}/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response 204 204 the specified token was successfully deleted from the device failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance to the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{id\ int}/tokens/{token}/ validates an oauth2 device access or refresh token on a specified device required scope token bsn api main devices token validate segment id int int a unique identifier for the device token string string an oauth2 device access or refresh token issued for the specified device request example the example request parameters and headers are set as follows id is set to 123456 token is set to {{token}} get /2022/06/rest/device/123456/tokens/{{token}}/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response body 200 200 returns the token info entity (2022/06) docid\ rmbcir76z7ojsyjb u2pp example { "token" {{token}}, "scope" "bdeploy certs bsn api device bsn api main groups regular retrieve bsn api main groups regular schedule retrieve bsn api main content retrieve", "validfrom" "2023 11 29t17 43 55z", "validto" "2023 11 29t17 58 55z" } failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error delete /{id\ int}/tokens/{token}/ revokes an oauth2 device access or refresh token on a specified device required scope token bsn api main devices revoke segment id int int a unique identifier for the device token string string an oauth2 device access or refresh token issued for the specified device request example the example request parameters and headers are set as follows id is set to 123456 token is set to {{token}} delete /2022/06/rest/device/123456/tokens/{{token}}/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response 204 204 the specified token was successfully deleted from the device failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance to the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /all/notes/ retrieves a list of notes for all players on the network required scope token bsn api main devices retrieve query string parameters filter string string optional optional an filtering and sorting expressions in the main api docid 3l0afyd3xooe ytvfk2vs for filtering search results the default value is null sort string string optional optional an expression for sorting the search results the sort expression specifies the entry used for sorting and the ascending/descending (asc/desc) sorting order (see filtering and sorting expressions in the main api docid 3l0afyd3xooe ytvfk2vs for more information) the default value is null marker string string optional optional a value specifying which page to retrieve this value is useful if the istruncated entry in the response body of the previous get call indicates that the number of autorun plugin instances exceeds the pagesize this parameter is only required if you need more elements in the paged list than the pagesize (100) pagesize int int optional optional the maximum number of player instances that can be contained in the response body this defaults to the maximum allowed page size (100) request example the example request parameters and headers are set as follows pagesize is set to 1 filter is set to \[device] \[id] is ' inaccessible ' sort is set to \[lastmodifieddate] desc marker value is set to the \[pagedlist] \[nextmarker] property value from the previous bsn cloud api response get /2022/06/rest/devices/all/notes/?pagesize=1\&sort=%5blastmodifieddate%5d%20desc\&filter=%5bdevice%5d %5bid%5d%20is%20%27%2ainaccessible%2a%27\&marker=oxnjo0nydaldy0njg2na%3d http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response body 200 200 returns a paged list entity (2022/06) docid\ pwwr0ln3 binngl mr3st of player note entity (2022/06) docid\ amshqpc9ioqfhzaj szmi instances on a network this will return not more than 100 entities along with the information necessary to return any other remaining pages example { "items" \[ { "device" { "id" 12345, "serial" "abcd12345678" }, "notes" "this player is behind the tv in an inaccessible place", "creationdate" "2024 01 10t18 30 11 123z", "lastmodifieddate" "2024 03 15t15 51 01 123z" }], "totalitemcount" 1024, "matchingitemcount" 1, "pagesize" 100, "nextmarker" "ldexotc4m2a=", "prevmarker" "ldexotc489ui", "istruncated" false, "sortexpression" "\[lastmodifieddate] desc", "filterexpression" "\[device] \[id] is ' inaccessible '" } failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{id\ int}/notes/ return the notes for a specified player required scope token bsn api main devices retrieve segment id int int a unique identifier for the player request example the example request parameters and headers are set as follows id is set to 12345 get /2022/06/rest/devices/12345/notes/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} if modified since mon, 11 mar 2024 10 00 00 gmt accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response with body 200 200 returns the player note entity (2022/06) docid\ amshqpc9ioqfhzaj szmi instance for the specified player example { "device" { "id" 12345, "serial" "abcd12345678" }, "notes" "this player is behind the tv in an inaccessible place", "creationdate" "2024 01 10t18 30 11 123z", "lastmodifieddate" "2024 03 15t15 51 01 123z" } success response 304 304 the resource was not modified since the time specified in the “if modified since” header failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error put /{id\ int}/notes/ updates the notes for the specified player required scope token bsn api main devices update segment id int int a unique identifier for the player request body the player note entity (2022/06) docid\ amshqpc9ioqfhzaj szmi request example the example request parameters and headers are set as follows id is set to 12345 put /2022/06/rest/devices/12345/notes/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate if unmodified since wed, 13 mar 2024 15 51 01 gmt content type application/json content length 59 this is the example request body { "device" { "id" 12345, "serial" "abcd12345678" }, "notes" "this player is behind the tv in an inaccessible place", "creationdate" "0001 01 01t00 00 00", "lastmodifieddate" "0001 01 01t00 00 00" } success response 204 204 the notes on the specified player were successfully updated failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance to the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error get /{serial}/notes/ return the notes for a specified player required scope token bsn api main devices retrieve segment serial string string the serial number of the player request example the example request parameters and headers are set as follows id is set to abcd12345678 get /2022/06/rest/devices/abcd12345678/notes/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} if modified since mon, 11 mar 2024 10 00 00 gmt accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response with body 200 200 returns the player note entity (2022/06) docid\ amshqpc9ioqfhzaj szmi instance for the specified player example { "device" { "id" 12345, "serial" "abcd12345678" }, "notes" "this player is behind the tv in an inaccessible place", "creationdate" "2024 01 10t18 30 11 123z", "lastmodifieddate" "2024 03 15t15 51 01 123z" } success response 304 304 the resource was not modified since the time specified in the “if modified since” header failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error put /{serial}/notes/ updates the notes for the specified player required scope token bsn api main devices update segment serial string string the serial number of the player request body the player note entity (2022/06) docid\ amshqpc9ioqfhzaj szmi request example the example request parameters and headers are set as follows serial is set to abcd12345678 put /2022/06/rest/devices/abcd12345678/notes/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate if unmodified since wed, 13 mar 2024 15 51 01 gmt content type application/json content length 59 this is the example request body { "device" { "id" 12345, "serial" "abcd12345678" }, "notes" "this player is behind the tv in an inaccessible place", "creationdate" "0001 01 01t00 00 00", "lastmodifieddate" "0001 01 01t00 00 00" } success response 204 204 the note on the specified player was successfully updated failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance to the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error