DeviceWebPages Endpoints (2022/06)

22 min

these endpoints allow users to manage device webpages on the network base url for these endpoints https //api bsn cloud/2022/06/rest/devicewebpages get / returns a list of player webpages required scope token bsn api main devicewebpages retrieve query string parameters filter \string\ \optional \ an expression docid 3l0afyd3xooe ytvfk2vs for filtering search results the default value is null sort \string\ \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 this page docid 3l0afyd3xooe ytvfk2vs for more information) the default value is null marker \string\ \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 webpage instances exceeds the pagesize this parameter is only required if you need more elements in the paged list than the pagesize (100) pagesize \int\ \optional \ the maximum number of player webpage 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 \[name] contains 'page' and \[uploaddate] is in the range '2020 07 01' and '2023 11 01' sort is set to \[name] desc get /2022/06/rest/devicewebpages/?marker=twf0dhnjbnrlcm5hbfbhz2usotczmtk1nq%3d%3d\&pagesize=1\&filter=%5bname%5d%20contains%20%27page%27%20and%20%5buploaddate%5d%20is%20in%20the%20range%20%272020 07 01%27%20and%20%272023 11 01%27\&sort=%5bname%5d%20desc 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\ returns a paged list docid\ pwwr0ln3 binngl mr3st of webpage entity docid\ o5v0ui933wvereinm7ls7 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" 11335061, "name" "html red dot test webpage", "uploaddate" "2023 10 17t14 24 21 63z", "lastmodifieddate" "2023 10 17t14 24 21 63z", "indexfile" { "filename" "village of menomonee falls events html", "physicalpath" "https //bsncloud s3 amazonaws com/contentcloud/ee9d33406bf95280fd4bfa4a03ec9965", "relativepath" "\\\\", "filesize" 1569, "filehash" "sha1 2614bfe3ec74fee729fb6eq291e6324e0432317e" }, "assets" null, "presentations" \[ { "id" 242058, "name" "html red dot test", "type" "presentation", "link" null }], "permissions" \[] }], "totalitemcount" 9, "matchingitemcount" 6, "pagesize" 1, "nextmarker" "sfrntf9szwrfrg90x1rlc3qtv2viugfnzswxmtm0nta1ma==", "prevmarker" "sfrntf9szwrfrg90x1rlc3qtv2viugfnzswxmtm0nta134hu", "istruncated" true, "sortexpression" "\[name] desc", "filterexpression" "\[name] contains 'page' and \[uploaddate] is in the range '2020 07 01t00 00 00 000z' and '2023 11 01t00 00 00 000z'" } failure \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error delete / removes player webpages, specified by a filter, from a network this allows multiple player webpages to be deleted at once required scope token bsn api main devicewebpages delete query string parameter filter \string\ \required \ an expression docid 3l0afyd3xooe ytvfk2vs for filtering search results the default value is null request example the example request parameters and headers are set as follows filter is set to \[uploaddate] is in the range '2020 07 01' and '2020 08 01' delete /2022/06/rest/devicewebpages/?filter=%5bname%5d%20contains%20%27default%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\ returns the number of affected player webpages as an integer value failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid for example, you cannot delete a device webpage that is in use by a presentation \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error get /count/ returns the number of player webpages on a device required scope token bsn api main devicewebpages retrieve query string parameter filter \string\ \optional \ an expression docid 3l0afyd3xooe ytvfk2vs for filtering search results the default value is null request example the example request parameters and headers are set as follows filter is set to \[uploaddate] is in the range '2018 01 01' and '2023 09 01' get /2022/06/rest/devicewebpages/count/?filter=%5buploaddate%5d%20is%20in%20the%20range%20%272018 01 01%27%20and%20%272023 09 01 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\ the player webpages count is returned as an integer value failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error get /{id}/ returns the specified player webpage required scope token bsn api main devicewebpages retrieve segment id \int \ a unique identifier for the player webpage request example the example request parameters and headers are set as follows id is set to 646879 the optional if modified since header value equals the last modified header value retrieved from the previous get /id or get /name response get /2022/06/rest/devicewebpages/646879/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} if modified since wed, 20 dec 2023 21 30 34 gmt accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response with body \200\ returns the webpage entity docid\ o5v0ui933wvereinm7ls7 example this is an example of a 200 level response { "id" 646879, "name" "default presentationwebpage", "uploaddate" "2020 07 27t16 23 35z", "lastmodifieddate" "2023 12 20t21 30 35 093z", "indexfile" { "filename" " devicewebpage html", "physicalpath" "https //bsncloud s3 amazonaws com/testing/5ced8fc8c47741c190a19c41f56c85d3", "relativepath" "\\\\", "filesize" 116305, "filehash" "sha1\ f84hf1b0d0361bdc4c2072ebe8c21b16p0ha0031" }, "assets" \[], "presentations" \[ { "id" 15762, "name" "cc testing", "type" "presentation", "link" null } ], "permissions" \[] } success response \304\ the resource was not modified since the time specified in the “if modified since” header failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error delete /{id}/ deletes the specified player webpage required scope token bsn api main devicewebpages delete segment id \int \ a unique identifier for the player webpage to delete request example the example request parameters and headers are set as follows id is set to 646879 the optional if unmodified since header value equals the last modified header value retrieved from the get /id or get /name response delete /2022/06/rest/devicewebpages/646879/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} if unmodified since wed, 20 dec 2023 21 30 34 gmt accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response \204\ the specified player webpage(s) were deleted failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid for example, you cannot delete a device webpage that is in use by a presentation \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \412\ precondition failed (the resource changed since the time specified in the “if unmodified since” header value) \5xx\ any 500 code is an internal server error get /{name}/ returns the specified player webpage required scope token bsn api main devicewebpages retrieve segment name \string \ the name of the player webpage request example the example request parameters and headers are set as follows name is set to default presentationwebpage the optional if modified since header value equals the last modified header value retrieved from the previous get /id or get /name response get /2022/06/rest/devicewebpages/default presentationwebpage/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} if modified since wed, 20 dec 2023 21 30 34 gmt accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response with body \200\ returns the webpage entity docid\ o5v0ui933wvereinm7ls7 example this is an example of a 200 level response { "id" 646879, "name" "default presentationwebpage", "uploaddate" "2020 07 27t16 23 35z", "lastmodifieddate" "2023 12 20t21 30 35 093z", "indexfile" { "filename" " devicewebpage html", "physicalpath" "https //bsncloud s3 amazonaws com/janedoetesting/5ced8fc8c47741c190a19c41f56c85d3", "relativepath" "\\\\", "filesize" 116305, "filehash" "sha1\ f841n1a0d4351bdc4c2072ebc8c21b1550da0061" }, "assets" \[], "presentations" \[ { "id" 15762, "name" "cc testing", "type" "presentation", "link" null } ], "permissions" \[] } success response \304\ the resource was not modified since the time specified in the “if modified since” header failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error delete /{name}/ deletes the specified player webpage required scope token bsn api main devicewebpages delete segment name \string \ the name of the player webpage to delete request example the example request parameters and headers are set as follows name is set to default presentationwebpage the optional if unmodified since header value equals the last modified header value retrieved from the get /id or get /name response delete /2022/06/rest/devicewebpages/default presentationwebpage/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} if unmodified since wed, 20 dec 2023 21 30 34 gmt accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response \204\ the specified player webpage(s) were deleted failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid for example, you cannot delete a device webpage that is in use by a presentation \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \412\ precondition failed (the resource changed since the time specified in the “if unmodified since” header value) \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/devicewebpages/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\ returns the business operations entity docid\ ei98k7oul6z5i 5b d6js example { "uid" "74c0bd18 cb38 4a7a b78d 127ffd5716d0", "singularname" "full control", "pluralname" "device web page (full control)", "fullname" "device web page (full control)", "targetentity" "devicewebpage", "appliance" "instance, collection", "parent" null, "descendants" \[ { "uid" "b484e2f0 af97 41a2 996f 731816e907af", "singularname" "view device web page", "pluralname" "view device web pages", "fullname" "device web page (full control) view device web pages", "targetentity" "devicewebpage", "appliance" "instance, collection", "parent" { "uid" "74c0bd18 cb38 4a7a b78d 127ffd5716d0", "singularname" "full control", "pluralname" "device web page (full control)", "fullname" "device web page (full control)", "targetentity" "devicewebpage", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "b484e2f0 af97 41a2 996f 731816e907af", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 03 05t16 59 06 553z" }, { "entityid" null, "operationuid" "b484e2f0 af97 41a2 996f 731816e907af", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 03 05t16 59 07 067z" }, { "entityid" null, "operationuid" "b484e2f0 af97 41a2 996f 731816e907af", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 08z" }, { "entityid" null, "operationuid" "b484e2f0 af97 41a2 996f 731816e907af", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 34z" }, { "entityid" null, "operationuid" "b484e2f0 af97 41a2 996f 731816e907af", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 587z" }, { "entityid" null, "operationuid" "b484e2f0 af97 41a2 996f 731816e907af", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 05 907z" } ] }, { "uid" "fecc26f4 31aa 4a7a a206 afabf885d1e6", "singularname" "upload device web page", "pluralname" "upload device web page", "fullname" "device web page (full control) upload device web page", "targetentity" "devicewebpage", "appliance" "collection", "parent" { "uid" "74c0bd18 cb38 4a7a b78d 127ffd5716d0", "singularname" "full control", "pluralname" "device web page (full control)", "fullname" "device web page (full control)", "targetentity" "devicewebpage", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "fecc26f4 31aa 4a7a a206 afabf885d1e6", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 08z" }, { "entityid" null, "operationuid" "fecc26f4 31aa 4a7a a206 afabf885d1e6", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 34z" }, { "entityid" null, "operationuid" "fecc26f4 31aa 4a7a a206 afabf885d1e6", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 587z" }, { "entityid" null, "operationuid" "fecc26f4 31aa 4a7a a206 afabf885d1e6", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 05 907z" }, { "entityid" null, "operationuid" "fecc26f4 31aa 4a7a a206 afabf885d1e6", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 06 54z" }, { "entityid" null, "operationuid" "fecc26f4 31aa 4a7a a206 afabf885d1e6", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 07 053z" } ] }, { "uid" "5c6ef943 d660 4907 aa56 e91903ff1772", "singularname" "update device web page", "pluralname" "update device web page", "fullname" "device web page (full control) update device web page", "targetentity" "devicewebpage", "appliance" "instance, collection", "parent" { "uid" "74c0bd18 cb38 4a7a b78d 127ffd5716d0", "singularname" "full control", "pluralname" "device web page (full control)", "fullname" "device web page (full control)", "targetentity" "devicewebpage", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "5c6ef943 d660 4907 aa56 e91903ff1772", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 08z" }, { "entityid" null, "operationuid" "5c6ef943 d660 4907 aa56 e91903ff1772", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 34z" }, { "entityid" null, "operationuid" "5c6ef943 d660 4907 aa56 e91903ff1772", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 587z" }, { "entityid" null, "operationuid" "5c6ef943 d660 4907 aa56 e91903ff1772", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 05 907z" }, { "entityid" null, "operationuid" "5c6ef943 d660 4907 aa56 e91903ff1772", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 06 54z" }, { "entityid" null, "operationuid" "5c6ef943 d660 4907 aa56 e91903ff1772", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 07 053z" } ] }, { "uid" "ba132cfb 475f 44ab bfe5 eeadb23af065", "singularname" "assign device web page", "pluralname" "assign device web page", "fullname" "device web page (full control) assign device web page", "targetentity" "devicewebpage", "appliance" "instance, collection", "parent" { "uid" "74c0bd18 cb38 4a7a b78d 127ffd5716d0", "singularname" "full control", "pluralname" "device web page (full control)", "fullname" "device web page (full control)", "targetentity" "devicewebpage", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "ba132cfb 475f 44ab bfe5 eeadb23af065", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 08z" }, { "entityid" null, "operationuid" "ba132cfb 475f 44ab bfe5 eeadb23af065", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 34z" }, { "entityid" null, "operationuid" "ba132cfb 475f 44ab bfe5 eeadb23af065", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 587z" }, { "entityid" null, "operationuid" "ba132cfb 475f 44ab bfe5 eeadb23af065", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 05 907z" }, { "entityid" null, "operationuid" "ba132cfb 475f 44ab bfe5 eeadb23af065", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 06 54z" }, { "entityid" null, "operationuid" "ba132cfb 475f 44ab bfe5 eeadb23af065", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 07 053z" } ] }, { "uid" "e0a3a34b 74d9 46ac a2f5 d03674cb9ac3", "singularname" "unassign device web page", "pluralname" "unassign device web page", "fullname" "device web page (full control) unassign device web page", "targetentity" "devicewebpage", "appliance" "instance, collection", "parent" { "uid" "74c0bd18 cb38 4a7a b78d 127ffd5716d0", "singularname" "full control", "pluralname" "device web page (full control)", "fullname" "device web page (full control)", "targetentity" "devicewebpage", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "e0a3a34b 74d9 46ac a2f5 d03674cb9ac3", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 08z" }, { "entityid" null, "operationuid" "e0a3a34b 74d9 46ac a2f5 d03674cb9ac3", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 34z" }, { "entityid" null, "operationuid" "e0a3a34b 74d9 46ac a2f5 d03674cb9ac3", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 587z" }, { "entityid" null, "operationuid" "e0a3a34b 74d9 46ac a2f5 d03674cb9ac3", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 05 907z" }, { "entityid" null, "operationuid" "e0a3a34b 74d9 46ac a2f5 d03674cb9ac3", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 06 54z" }, { "entityid" null, "operationuid" "e0a3a34b 74d9 46ac a2f5 d03674cb9ac3", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 07 053z" } ] }, { "uid" "136c2201 f5f9 4f16 be52 35db9b1444d0", "singularname" "edit permissions", "pluralname" "edit permissions", "fullname" "device web page (full control) edit permissions", "targetentity" "devicewebpage", "appliance" "collection", "parent" { "uid" "74c0bd18 cb38 4a7a b78d 127ffd5716d0", "singularname" "full control", "pluralname" "device web page (full control)", "fullname" "device web page (full control)", "targetentity" "devicewebpage", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "136c2201 f5f9 4f16 be52 35db9b1444d0", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 08z" }, { "entityid" null, "operationuid" "136c2201 f5f9 4f16 be52 35db9b1444d0", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 34z" }, { "entityid" null, "operationuid" "136c2201 f5f9 4f16 be52 35db9b1444d0", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 587z" }, { "entityid" null, "operationuid" "136c2201 f5f9 4f16 be52 35db9b1444d0", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 05 907z" }, { "entityid" null, "operationuid" "136c2201 f5f9 4f16 be52 35db9b1444d0", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 06 54z" }, { "entityid" null, "operationuid" "136c2201 f5f9 4f16 be52 35db9b1444d0", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 07 053z" } ] }, { "uid" "220b7755 3d09 4934 b583 69beb2d4976a", "singularname" "delete device web page", "pluralname" "delete device web page", "fullname" "device web page (full control) delete device web page", "targetentity" "devicewebpage", "appliance" "instance, collection", "parent" { "uid" "74c0bd18 cb38 4a7a b78d 127ffd5716d0", "singularname" "full control", "pluralname" "device web page (full control)", "fullname" "device web page (full control)", "targetentity" "devicewebpage", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "220b7755 3d09 4934 b583 69beb2d4976a", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 03 05t16 59 06 567z" }, { "entityid" null, "operationuid" "220b7755 3d09 4934 b583 69beb2d4976a", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 08z" }, { "entityid" null, "operationuid" "220b7755 3d09 4934 b583 69beb2d4976a", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 34z" }, { "entityid" null, "operationuid" "220b7755 3d09 4934 b583 69beb2d4976a", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 05 587z" }, { "entityid" null, "operationuid" "220b7755 3d09 4934 b583 69beb2d4976a", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 05 907z" }, { "entityid" null, "operationuid" "220b7755 3d09 4934 b583 69beb2d4976a", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 07 053z" } ] } ], "permissions" \[ { "entityid" null, "operationuid" "74c0bd18 cb38 4a7a b78d 127ffd5716d0", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 03 05t16 59 05 08z" }, { "entityid" null, "operationuid" "74c0bd18 cb38 4a7a b78d 127ffd5716d0", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 03 05t16 59 05 34z" }, { "entityid" null, "operationuid" "74c0bd18 cb38 4a7a b78d 127ffd5716d0", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 03 05t16 59 05 587z" }, { "entityid" null, "operationuid" "74c0bd18 cb38 4a7a b78d 127ffd5716d0", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" false, "isallowed" false, "creationdate" "2020 03 05t16 59 05 907z" }, { "entityid" null, "operationuid" "74c0bd18 cb38 4a7a b78d 127ffd5716d0", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" false, "isallowed" false, "creationdate" "2020 03 05t16 59 06 54z" }, { "entityid" null, "operationuid" "74c0bd18 cb38 4a7a b78d 127ffd5716d0", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" false, "isallowed" false, "creationdate" "2020 03 05t16 59 07 053z" } ] } failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error get /{id}/permissions/ includes object permissions for a given player webpage instance required scope token bsn api main devicewebpages retrieve segment id \int \ a unique identifier for the player webpage request example the example request parameters and headers are set as follows id is set to 646879 get /2022/06/rest/devicewebpages/646879/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\ returns an array of permission docid\ jwfymc42cdrg5jy2skysu entities example \[ { "entityid" 546701, "operationuid" "5c6ef943 d660 4907 aa56 e91903ff1772", "principal" { "login" "janedoe\@brightsign biz", "type" "user", "id" 102359 }, "isfixed" false, "isinherited" false, "isallowed" true, "creationdate" "2023 10 11t18 46 30 1z" } ] failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error post /{id}/permissions/ adds permissions for a player webpage required scope token bsn api main devicewebpages update segment id \int \ a unique identifier for the player webpage request body an array of permission docid\ jwfymc42cdrg5jy2skysu entities request example the example request parameters and headers are set as follows id is set to 646879 post /2022/06/rest/devicewebpages/646879/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 316 this is the example request body \[ { "entityid" 546701, "operationuid" "5c6ef943 d660 4907 aa56 e91903ff1772", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 0 }, "isfixed" false, "isinherited" false, "isallowed" true, "creationdate" "2023 10 11t18 46 30 1z" } ] success response \204\ the specified permissions were successfully granted failure response \400\ the request or request body is malformed and therefore invalid, or it is rejected in accordance to the business rules \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \415\ the server cannot accept the data representation that you sent (as specified in the "content type" header) \5xx\ any 500 code is an internal server error delete /{id}/permissions/ removes permissions from a player webpage required scope token bsn api main devicewebpages update segment id \int \ a unique identifier for the player webpage request body an array of permission docid\ jwfymc42cdrg5jy2skysu entities request example the example request parameters and headers are set as follows id is set to 646879 delete /2022/06/rest/devicewebpages/646879/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 316 this is the example request body \[ { "entityid" 546701, "operationuid" "5c6ef943 d660 4907 aa56 e91903ff1772", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 0 }, "isfixed" false, "isinherited" false, "isallowed" true, "creationdate" "2023 10 11t18 46 30 1z" } ] success response \204\ the specified permissions were successfully deleted from the player webpage failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request or request body is malformed and therefore invalid, or it is rejected in accordance to the business rules \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error get /{name}/permissions/ includes object permissions for a given player webpage instance required scope token bsn api main devicewebpages retrieve segment name \string \ the name of the player webpage request example the example request parameters and headers are set as follows name is set to default presentationwebpage get /2022/06/rest/devicewebpages/default presentationwebpage/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\ returns an array of permission docid\ jwfymc42cdrg5jy2skysu entities example \[ { "entityid" 546701, "operationuid" "5c6ef943 d660 4907 aa56 e91903ff1772", "principal" { "login" "janedoe\@brightsign biz", "type" "user", "id" 102359 }, "isfixed" false, "isinherited" false, "isallowed" true, "creationdate" "2023 10 11t18 46 30 1z" } ] failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error post /{name}/permissions/ adds permissions for a player webpage required scope token bsn api main devicewebpages update segment name \string \ the name of the player webpage request body an array of permission docid\ jwfymc42cdrg5jy2skysu entities request example the example request parameters and headers are set as follows name is set to default presentationwebpage post /2022/06/rest/devicewebpages/default presentationwebpage/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 316 this is the example request body \[ { "entityid" 546701, "operationuid" "5c6ef943 d660 4907 aa56 e91903ff1772", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 0 }, "isfixed" false, "isinherited" false, "isallowed" true, "creationdate" "2023 10 11t18 46 30 1z" } ] success response \204\ the specified permissions were successfully granted failure response \400\ the request or request body is malformed and therefore invalid, or it is rejected in accordance to the business rules \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \415\ the server cannot accept the data representation that you sent (as specified in the "content type" header) \5xx\ any 500 code is an internal server error delete /{name}/permissions/ removes permissions from a player webpage required scope token bsn api main devicewebpages update segment name \string \ the name of the player webpage request body an array of permission docid\ jwfymc42cdrg5jy2skysu entities request example the example request parameters and headers are set as follows name is set to default presentationwebpage delete /2022/06/rest/devicewebpages/default presentationwebpage/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 316 this is the example request body \[ { "entityid" 546701, "operationuid" "5c6ef943 d660 4907 aa56 e91903ff1772", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 0 }, "isfixed" false, "isinherited" false, "isallowed" true, "creationdate" "2023 10 11t18 46 30 1z" } ] success response \204\ the specified permissions were successfully deleted from the player webpage failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request or request body is malformed and therefore invalid, or it is rejected in accordance to the business rules \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error