Groups/Regular Endpoints (2022/06)

use these endpoints to manage groups on the network base url for these endpoints https //api bsn cloud/2022/06/rest/groups/regular get / retrieves a list of groups on the network required scope token bsn api main groups regular 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 group 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 group 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 \[pagedlist] \[nextmarker] property value from the previous bsn cloud api response pagesize is set to 1 filter is set to \[creationdate] is in the range '2020 07 01' and '2023 08 01' sort is set to \[name] asc get /2022/06/rest/groups/regular/?marker=yxvkaw8tdgvzdcwynjq1mjg%3d\&pagesize=1\&filter=%5bcreationdate%5d%20is%20in%20the%20range%20%272020 07 01%27%20and%20%272023 08 01%27\&sort=%5bname%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 regular groups entity (2022/06) docid\ uzvwhpbopgry2z9pqo9gd 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" 123456, "name" "conferenceroom", "creationdate" "2023 7 11t22 24 51 347z", "lastmodifieddate" "2023 12 11t22 45 47 007z", "autorun" null, "hdx23firmware" "", "hdx23firmwareid" 1, "lsx23firmware" "", "lsx23firmwareid" 1, "hsx23firmware" "", "hsx23firmwareid" 1, "hox23firmware" "", "hox23firmwareid" 1, "xdx33firmware" "", "xdx33firmwareid" 1, "xtx43firmware" "", "xtx43firmwareid" 1, "xdx34 xtx44firmware" "", "xdx34 xtx44firmwareid" 1, "hdx4 hsx4 lsx4firmware" "8 5 47", "hdx4 hsx4 lsx4firmwareid" 12345678, "aux5firmware" "", "aux5firmwareid" 1, "4kx42firmware" "", "4kx42firmwareid" 1, "xcx55firmware" "", "xcx55firmwareid" 1, "xtx45 xdx35 hdx25 ls4x5 hs1x5firmware" "", "xtx45 xdx35 hdx25 ls4x5 hs1x5firmwareid" 1, "enableserialdebugging" false, "enablesystemlogdebugging" false, "enablestoragespacelimit" false, "storagespacelimitunits" "percentage", "publisheddatasizelimit" 0, "dynamicdatasizelimit" 0, "htmldatasizelimit" 0, "htmllocalstoragesizelimit" 0, "webdatabasesizelimit" 0, "devicescount" 2, "deviceshealthstatus" { "normal" 1, "error" 1 }, "devices" null, "schedule" \[], "permissions" \[] }], "totalitemcount" 8, "matchingitemcount" 8, "pagesize" 1, "nextmarker" "q29uzmvyzw5jzvjvb20smziwmza3", "prevmarker" "q29uzmvyzw5jzvjvb20smziwmpg8", "istruncated" true, "sortexpression" "\[name] asc", "filterexpression" "\[creationdate] is in the range '2020 07 01t00 00 00 000z' and '2023 08 01t00 00 00 000z'" } 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 post / creates a group on the network required scope token bsn api main groups regular create request body the regular groups entity (2022/06) docid\ uzvwhpbopgry2z9pqo9gd request example the example request parameters and headers are set as follows post /2022/06/rest/groups/regular/ 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 1053 this is the example request body { "id" 0, "name" "newgroup", "creationdate" "0001 01 01t00 00 00 000z", "lastmodifieddate" "0001 01 01t00 00 00 000z", "autorun" null, "hdx23firmware" "", "hdx23firmwareid" 1, "lsx23firmware" "", "lsx23firmwareid" 1, "hsx23firmware" "", "hsx23firmwareid" 1, "hox23firmware" "", "hox23firmwareid" 1, "xdx33firmware" "", "xdx33firmwareid" 1, "xtx43firmware" "", "xtx43firmwareid" 1, "xdx34 xtx44firmware" "", "xdx34 xtx44firmwareid" 1, "hdx4 hsx4 lsx4firmware" "8 5 47", "hdx4 hsx4 lsx4firmwareid" 1, "4kx42firmware" "", "4kx42firmwareid" 1, "enableserialdebugging" false, "enablesystemlogdebugging" false, "enablestoragespacelimit" false, "storagespacelimitunits" "percentage", "publisheddatasizelimit" 0, "dynamicdatasizelimit" 0, "htmldatasizelimit" 0, "htmllocalstoragesizelimit" 0, "webdatabasesizelimit" 0, "devicescount" 0, "deviceshealthstatus" null, "devices" null, "schedule" null, "permissions" \[] } success response body 201 201 returns the regular groups entity (2022/06) docid\ uzvwhpbopgry2z9pqo9gd created and referenced by the uri (given by the location header field) in the response example { "id" 123456, "name" "newgroup", "creationdate" "2023 10 19t20 30 35 833z", "lastmodifieddate" "2023 10 19t20 30 35 833z", "autorun" null, "hdx23firmware" "", "hdx23firmwareid" 1, "lsx23firmware" "", "lsx23firmwareid" 1, "hsx23firmware" "", "hsx23firmwareid" 1, "hox23firmware" "", "hox23firmwareid" 1, "xdx33firmware" "", "xdx33firmwareid" 1, "xtx43firmware" "", "xtx43firmwareid" 1, "xdx34 xtx44firmware" "", "xdx34 xtx44firmwareid" 1, "hdx4 hsx4 lsx4firmware" "8 5 47", "hdx4 hsx4 lsx4firmwareid" 12345, "aux5firmware" "", "aux5firmwareid" 1, "4kx42firmware" "", "4kx42firmwareid" 1, "xcx55firmware" "", "xcx55firmwareid" 1, "xtx45 xdx35 hdx25 ls4x5 hs1x5firmware" "", "xtx45 xdx35 hdx25 ls4x5 hs1x5firmwareid" 1, "enableserialdebugging" false, "enablesystemlogdebugging" false, "enablestoragespacelimit" false, "storagespacelimitunits" "percentage", "publisheddatasizelimit" 0, "dynamicdatasizelimit" 0, "htmldatasizelimit" 0, "htmllocalstoragesizelimit" 0, "webdatabasesizelimit" 0, "devicescount" 0, "deviceshealthstatus" {}, "devices" null, "schedule" \[], "permissions" \[] } 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 with 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) 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 / removes groups, specified by a filter, from a network this allows multiple groups to be deleted at once required scope token bsn api main groups regular 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 reassignmentgroupid int int optional optional the identifier of the group instance to which affected devices should be reassigned if this value is negative, the devices will be reassigned to the default “unassigned” group instance if a group instance with the specified positive \[int] id does not exist, the method will return a descriptive error the default value is 0 request example the example request parameters and headers are set as follows filter is set to \[devicescount] is 0 reassignmentgroupid is set to 12345 delete /2022/06/rest/groups/regular/?reassignmentgroupid=12345\&filter=%5bdevicescount%5d%20is%200 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 groups 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 with 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 /count/ returns the number of groups on the network that match the specified filter criteria if no filter is included, this call returns the total number of groups on the network required scope token bsn api main groups regular 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 the default value is null request example the example request parameters and headers are set as follows filter is set to \[name] contains 'test' get /2022/06/rest/groups/regular/count/?filter=%5bname%5d%20contains%20%27test%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 the number of groups 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}/ returns a specified group required scope token bsn api main groups regular retrieve segment id int int the unique identifier for the group 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 /name response get /2022/06/rest/groups/regular/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 modified since wed, 20 dec 2023 21 32 34 gmt success response with body 200 200 returns the regular groups entity (2022/06) docid\ uzvwhpbopgry2z9pqo9gd example this is an example of a 200 level response { "id" 12345, "name" "conferenceroom", "creationdate" "2023 12 11t22 24 51 347z", "lastmodifieddate" "2023 12 20t21 32 35 093z", "autorun" null, "hdx23firmware" "", "hdx23firmwareid" 1, "lsx23firmware" "", "lsx23firmwareid" 1, "hsx23firmware" "", "hsx23firmwareid" 1, "hox23firmware" "", "hox23firmwareid" 1, "xdx33firmware" "", "xdx33firmwareid" 1, "xtx43firmware" "", "xtx43firmwareid" 1, "xdx34 xtx44firmware" "", "xdx34 xtx44firmwareid" 1, "hdx4 hsx4 lsx4firmware" "", "hdx4 hsx4 lsx4firmwareid" 1, "aux5firmware" "", "aux5firmwareid" 1, "4kx42firmware" "", "4kx42firmwareid" 1, "xcx55firmware" "", "xcx55firmwareid" 1, "xtx45 xdx35 hdx25 ls4x5 hs1x5firmware" "", "xtx45 xdx35 hdx25 ls4x5 hs1x5firmwareid" 1, "enableserialdebugging" true, "enablesystemlogdebugging" false, "enablestoragespacelimit" false, "storagespacelimitunits" "percentage", "publisheddatasizelimit" 0, "dynamicdatasizelimit" 0, "htmldatasizelimit" 0, "htmllocalstoragesizelimit" 0, "webdatabasesizelimit" 0, "devicescount" 2, "deviceshealthstatus" { "normal" 1, "error" 1 }, "devices" \[ { "id" 12345, "serial" "xxxxxx000000" }, { "id" 67890, "serial" "yyyyyy000000" } ], "schedule" \[], "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}/ updates the specified group required scope token bsn api main groups regular update segment id int int the unique identifier for the group request body the regular groups entity (2022/06) docid\ uzvwhpbopgry2z9pqo9gd 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 /name response put /2022/06/rest/groups/regular/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, 20 dec 2023 21 32 34 gmt content type application/json content length 1785 this is the example request body { "id" 0, "name" "default", "creationdate" "0001 01 01t00 00 00", "lastmodifieddate" "0001 01 01t00 00 00", "autorun" null, "hdx23firmware" "", "hdx23firmwareid" 1, "lsx23firmware" "", "lsx23firmwareid" 1, "hsx23firmware" "", "hsx23firmwareid" 1, "hox23firmware" "", "hox23firmwareid" 1, "xdx33firmware" "", "xdx33firmwareid" 1, "xtx43firmware" "", "xtx43firmwareid" 1, "xdx34 xtx44firmware" "", "xdx34 xtx44firmwareid" 1, "hdx4 hsx4 lsx4firmware" "8 5 47", "hdx4 hsx4 lsx4firmwareid" 1, "aux5firmware" "", "aux5firmwareid" 1, "4kx42firmware" "", "4kx42firmwareid" 1, "xcx55firmware" "", "xcx55firmwareid" 1, "xtx45 xdx35 hdx25 ls4x5 hs1x5firmware" "", "xtx45 xdx35 hdx25 ls4x5 hs1x5firmwareid" 1, "enableserialdebugging" false, "enablesystemlogdebugging" true, "enablestoragespacelimit" false, "storagespacelimitunits" "percentage", "publisheddatasizelimit" 0, "dynamicdatasizelimit" 0, "htmldatasizelimit" 0, "htmllocalstoragesizelimit" 0, "webdatabasesizelimit" 0, "devicescount" 0, "deviceshealthstatus" null, "devices" null, "schedule" null, "permissions" \[] } success response 204 204 the specified group has been 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 with 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/group 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}/ applies a sequence of changes to a specific group entity specified by id see rfc 6902 https //datatracker ietf org/doc/html/rfc6902 required scope token bsn api main groups regular update segment id int int the identifier for the group entity, which is a resource uri 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 this can be an array 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 /name response patch /2022/06/rest/groups/regular/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, 20 dec 2023 21 32 34 gmt content type application/json patch+json content length 91 this is the example request body \[ { "op" "replace", "path" "/xdx34 xtx44firmware/", "value" "8 5 33" } ] 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 with 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) 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}/ removes the specified group required scope token bsn api main groups regular delete segment id int int the unique identifier for the group query string parameter reassignmentgroupid int int optional optional the identifier of the group instance to which affected devices should be reassigned if this value is negative, the devices will be reassigned to the default “unassigned” group instance if a group instance with the specified positive \[int] id does not exist, the method will return a descriptive error the default value is 0 request example the example request parameters and headers are set as follows id is set to 12345 reassignmentgroupid is set to 90 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/groups/regular/12345/?reassignmentgroupid=90 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, 20 dec 2023 21 32 34 gmt success response 204 204 the specified group has been removed from the network 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 with 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 /{name}/ returns a specified group required scope token bsn api main groups regular retrieve segment name string string the name of the group request example the example request parameters and headers are set as follows name is set to conferenceroom 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/groups/regular/conferenceroom/ 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 modified since wed, 20 dec 2023 21 32 34 gmt success response with body 200 200 returns the regular groups entity (2022/06) docid\ uzvwhpbopgry2z9pqo9gd example this is an example of a 200 level response { "id" 456789, "name" "conferenceroom", "creationdate" "2023 12 11t22 24 51 347z", "lastmodifieddate" "2023 12 20t21 32 35 093z", "autorun" null, "hdx23firmware" "", "hdx23firmwareid" 1, "lsx23firmware" "", "lsx23firmwareid" 1, "hsx23firmware" "", "hsx23firmwareid" 1, "hox23firmware" "", "hox23firmwareid" 1, "xdx33firmware" "", "xdx33firmwareid" 1, "xtx43firmware" "", "xtx43firmwareid" 1, "xdx34 xtx44firmware" "", "xdx34 xtx44firmwareid" 1, "hdx4 hsx4 lsx4firmware" "", "hdx4 hsx4 lsx4firmwareid" 1, "aux5firmware" "", "aux5firmwareid" 1, "4kx42firmware" "", "4kx42firmwareid" 1, "xcx55firmware" "", "xcx55firmwareid" 1, "xtx45 xdx35 hdx25 ls4x5 hs1x5firmware" "", "xtx45 xdx35 hdx25 ls4x5 hs1x5firmwareid" 1, "enableserialdebugging" true, "enablesystemlogdebugging" false, "enablestoragespacelimit" false, "storagespacelimitunits" "percentage", "publisheddatasizelimit" 0, "dynamicdatasizelimit" 0, "htmldatasizelimit" 0, "htmllocalstoragesizelimit" 0, "webdatabasesizelimit" 0, "devicescount" 2, "deviceshealthstatus" { "normal" 1, "error" 1 }, "devices" \[ { "id" 12345, "serial" "xxxxxx000000" }, { "id" 67890, "serial" "yyyyyy000000" } ], "schedule" \[], "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 /{name}/ updates a specified group required scope token bsn api main groups regular update segment name string string the name of the group request body the regular groups entity (2022/06) docid\ uzvwhpbopgry2z9pqo9gd request example the example request parameters and headers are set as follows name is set to default the optional if unmodified since header value equals the last modified header value retrieved from the get /id or get /name response put /2022/06/rest/groups/regular/default/ 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, 20 dec 2023 21 32 34 gmt content type content type application/json patch+json content length 1785 this is the example request body { "id" 0, "name" "default", "creationdate" "0001 01 01t00 00 00", "lastmodifieddate" "0001 01 01t00 00 00", "autorun" null, "hdx23firmware" "", "hdx23firmwareid" 1, "lsx23firmware" "", "lsx23firmwareid" 1, "hsx23firmware" "", "hsx23firmwareid" 1, "hox23firmware" "", "hox23firmwareid" 1, "xdx33firmware" "", "xdx33firmwareid" 1, "xtx43firmware" "", "xtx43firmwareid" 1, "xdx34 xtx44firmware" "", "xdx34 xtx44firmwareid" 1, "hdx4 hsx4 lsx4firmware" "8 5 47", "hdx4 hsx4 lsx4firmwareid" 1, "aux5firmware" "", "aux5firmwareid" 1, "4kx42firmware" "", "4kx42firmwareid" 1, "xcx55firmware" "", "xcx55firmwareid" 1, "xtx45 xdx35 hdx25 ls4x5 hs1x5firmware" "", "xtx45 xdx35 hdx25 ls4x5 hs1x5firmwareid" 1, "enableserialdebugging" false, "enablesystemlogdebugging" true, "enablestoragespacelimit" false, "storagespacelimitunits" "percentage", "publisheddatasizelimit" 0, "dynamicdatasizelimit" 0, "htmldatasizelimit" 0, "htmllocalstoragesizelimit" 0, "webdatabasesizelimit" 0, "devicescount" 0, "deviceshealthstatus" null, "devices" null, "schedule" null, "permissions" \[] } success response 204 204 the specified group has been 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 with 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/group 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 /{name}/ applies a sequence of changes to a specific group entity specified by name see rfc 6902 https //datatracker ietf org/doc/html/rfc6902 required scope token bsn api main groups regular update segment name string string the name of the group entity, which is a resource uri 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 this can be an array request example the example request parameters and headers are set as follows name is default the optional if unmodified since header value equals the last modified header value retrieved from the get /id or get /name response patch /2022/06/rest/groups/regular/default/ 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, 20 dec 2023 21 32 34 gmt content type application/json patch+json content length 91 this is the example request body \[ { "op" "replace", "path" "/xdx34 xtx44firmware/", "value" "8 5 33" } ] 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 with 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) 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 /{name}/ removes a specified group required scope token bsn api main groups regular delete segment name string string the name of the group query string parameter reassignmentgroupid int int optional optional the identifier of the group instance to which affected devices should be reassigned if this value is negative, the devices will be reassigned to the default “unassigned” group instance if a group instance with the specified positive \[int] id does not exist, the method will return a descriptive error the default value is 0 request example the example request parameters and headers are set as follows id is set to default reassignmentgroupid is set to 90 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/groups/regular/default/?reassignmentgroupid=90 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, 20 dec 2023 21 32 34 gmt success response 204 204 the specified group has been removed from the network 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 with 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 /{id\ int}/schedule/ returns a list of the scheduled presentation entity (2022/06) docid\ drsrsrfhj2cz61wdol7qm in the specified group required scope token bsn api main groups regular retrieve segment groupid int int the unique identifier of the group query string parameter 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 group instances exceeds the pagesize pagesize int int optional optional the maximum number of group instances that can be contained in the response body request example the example request parameters and headers are set as follows groupid is set to 12345 pagesize is set to 1 marker value is set to the \[pagedlist] \[nextmarker] property value from the previous bsn cloud api response get /2022/06/rest/groups/regular/12345/schedule/?marker=zy023g2b8\&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 a list of the scheduled presentations of the specified group example { "items" \[ { "id" 2345678, "presentationid" 123456, "presentationname" "october2023prez", "isrecurrent" false, "eventdate" "2023 11 03t00 00 00", "starttime" "00 00 00", "duration" "23 59 00", "recurrencestartdate" null, "recurrenceenddate" null, "daysofweek" "none", "creationdate" "2023 11 03t21 04 32 81z", "lastmodifieddate" "2023 11 03t21 04 32 81z", "expirationdate" "2023 11 04t11 59 00z", "interruptscheduling" false }], "totalitemcount" 3, "matchingitemcount" 3, "pagesize" 1, "nextmarker" "gwpbwfcsw15nji5mjn0", "prevmarker" "gwpbwfcsw15nji5hu8u", "istruncated" true, "sortexpression" "\[scheduledpresentation] \[expiredate] 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 post /{id\ int}/schedule/ adds a scheduled presentation to the specified group required scope token bsn api main groups regular update segment groupid int int the unique identifier of the group request body the scheduled presentation entity (2022/06) docid\ drsrsrfhj2cz61wdol7qm request example the example request parameters and headers are set as follows groupid is set to 12345 post /2022/06/rest/groups/regular/12345/schedule/ 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 419 this is the example request body { "id" 0, "presentationid" 23456, "presentationname" "october2023prez", "isrecurrent" false, "eventdate" "2023 11 04t00 00 00", "starttime" "00 00 00", "duration" "23 59 00", "recurrencestartdate" null, "recurrenceenddate" null, "daysofweek" "none", "creationdate" "0001 01 01t00 00 00", "lastmodifieddate" "0001 01 01t00 00 00", "expirationdate" null, "interruptscheduling" false } 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 scheduled presentation entity (2022/06) docid\ drsrsrfhj2cz61wdol7qm example { "id" 1234567, "presentationid" 23456, "presentationname" "october2023prez", "isrecurrent" false, "eventdate" "2023 11 04t00 00 00", "starttime" "00 00 00", "duration" "23 59 00", "recurrencestartdate" null, "recurrenceenddate" null, "daysofweek" "none", "creationdate" "2023 11 03t18 14 09 3506335z", "lastmodifieddate" "2023 11 03t18 14 09 3506335z", "expirationdate" "2023 11 05t11 59 00z", "interruptscheduling" false } 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 with 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 /{name}/schedule/ returns a list of the scheduled presentation entity (2022/06) docid\ drsrsrfhj2cz61wdol7qm in the specified group required scope token bsn api main groups regular retrieve segment groupname string string the name of the group 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 group instances exceeds the pagesize pagesize int int optional optional the maximum number of group instances that can be contained in the response body request example the example request parameters and headers are set as follows groupname is set to october2023prez pagesize is set to 1 marker value is set to the \[pagedlist] \[nextmarker] property value from the previous bsn cloud api response get /2022/06/rest/groups/regular/october2023prez/schedule/?marker=rgvmyxvsdmdkxna\&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 a list of the scheduled presentations of the specified group example { "items" \[ { "id" 2345678, "presentationid" 123456, "presentationname" "october2023prez", "isrecurrent" true, "eventdate" null, "starttime" "00 00 00", "duration" "1 00 00 00", "recurrencestartdate" null, "recurrenceenddate" null, "daysofweek" "everyday", "creationdate" "2023 10 20t21 11 48 233z", "lastmodifieddate" "2023 10 20t21 11 48 233z", "expirationdate" null, "interruptscheduling" false }], "totalitemcount" 3, "matchingitemcount" 3, "pagesize" 1, "nextmarker" "gwpbwfcsw15nji5mjn0", "prevmarker" "gwpbwfcsw15nji58901", "istruncated" true, "sortexpression" "\[scheduledpresentation] \[expiredate] 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 post /{name}/schedule/ adds a scheduled presentation to the specified group required scope token bsn api main groups regular update segment groupname string string the name of the group request body the scheduled presentation entity (2022/06) docid\ drsrsrfhj2cz61wdol7qm request example the example request parameters and headers are set as follows groupname is set to october2023prez post /2022/06/rest/groups/regular/october2023prez/schedule/ 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 419 this is the example request body { "id" 0, "presentationid" 123456, "presentationname" "october2023prez", "isrecurrent" false, "eventdate" "2023 11 04t00 00 00", "starttime" "00 00 00", "duration" "23 59 00", "recurrencestartdate" null, "recurrenceenddate" null, "daysofweek" "none", "creationdate" "0001 01 01t00 00 00", "lastmodifieddate" "0001 01 01t00 00 00", "expirationdate" null, "interruptscheduling" false } 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 scheduled presentation entity (2022/06) docid\ drsrsrfhj2cz61wdol7qm example { "id" 2345678, "presentationid" 23456, "presentationname" "october2023prez", "isrecurrent" false, "eventdate" "2023 11 04t00 00 00", "starttime" "00 00 00", "duration" "23 59 00", "recurrencestartdate" null, "recurrenceenddate" null, "daysofweek" "none", "creationdate" "2023 11 03t18 14 09 3506335z", "lastmodifieddate" "2023 11 03t18 14 09 3506335z", "expirationdate" "2023 11 05t11 59 00z", "interruptscheduling" false } 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 with 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}/schedule/{scheduledpresentationid\ int}/ returns the schedule of the specified presentation in the specified group required scope token bsn api main groups regular retrieve segment groupid int int the unique identifier of the group scheduledpresentationid int int the unique identifier for the scheduled presentation request example the example request parameters and headers are set as follows groupid is set to 12345 scheduledpresentationid is set to 234567 get /2022/06/rest/groups/regular/12345/schedule/234567/ 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 scheduled presentation entity (2022/06) docid\ drsrsrfhj2cz61wdol7qm example { "id" 234567, "presentationid" 1234567, "presentationname" "default", "isrecurrent" true, "eventdate" null, "starttime" "00 00 00", "duration" "1 00 00 00", "recurrencestartdate" null, "recurrenceenddate" null, "daysofweek" "everyday", "creationdate" "2023 10 19t17 21 32 767z", "lastmodifieddate" "2023 10 19t17 21 32 767z", "expirationdate" null, "interruptscheduling" false } 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}/schedule/{scheduledpresentationid\ int}/ updates the specified scheduled presentation in the specified group required scope token bsn api main groups regular update segment groupid int int the unique identifier of the group scheduledpresentationid int int the unique identifier for the scheduled presentation request body the scheduled presentation entity (2022/06) docid\ drsrsrfhj2cz61wdol7qm request example the example request parameters and headers are set as follows groupid is set to 12345 scheduledpresentationid is set to 234567 put /2022/06/rest/groups/regular/12345/schedule/234567/ 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 443 this is the example request body { "id" 0, "presentationid" 1234567, "presentationname" "default", "isrecurrent" true, "eventdate" null, "starttime" "00 00 00", "duration" "1 00 00 00", "recurrencestartdate" null, "recurrenceenddate" null, "daysofweek" "everyday", "creationdate" "0001 01 01t00 00 00", "lastmodifieddate" "0001 01 01t00 00 00", "expirationdate" null, "interruptscheduling" false } success response 204 204 the scheduled presentation in the specified group has been 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 with 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 delete /{id\ int}/schedule/{scheduledpresentationid\ int}/ removes a specified scheduled presentation from the specified group required scope token bsn api main groups regular update segment groupid int int the unique identifier of the group scheduledpresentationid int int the unique identifier for the scheduled presentation request example the example request parameters and headers are set as follows groupid is set to 12345 scheduledpresentationid is set to 234567 delete /2022/06/rest/groups/regular/12345/schedule/234567/ 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 scheduled presentation has been deleted from the specified group 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 with 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 /{name}/schedule/{scheduledpresentationid\ int}/ returns the schedule of the specified presentation in the specified group required scope token bsn api main groups regular retrieve segment groupname string string the name of the group scheduledpresentationid int int the unique identifier for the scheduled presentation request example the example request parameters and headers are set as follows groupname is set to default scheduledpresentationid is set to 234567 get /2022/06/rest/groups/regular/default/schedule/234567/ 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 scheduled presentation entity (2022/06) docid\ drsrsrfhj2cz61wdol7qm example { "id" 234567, "presentationid" 987654, "presentationname" "default", "isrecurrent" true, "eventdate" null, "starttime" "00 00 00", "duration" "1 00 00 00", "recurrencestartdate" null, "recurrenceenddate" null, "daysofweek" "everyday", "creationdate" "2023 10 19t17 21 32 767z", "lastmodifieddate" "2023 10 19t17 21 32 767z", "expirationdate" null, "interruptscheduling" false } 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 /{name}/schedule/{scheduledpresentationid\ int}/ updates the specified scheduled presentation in the specified group required scope token bsn api main groups regular update segment groupname string string the name of the group scheduledpresentationid int int the unique identifier for the scheduled presentation request body the scheduled presentation entity (2022/06) docid\ drsrsrfhj2cz61wdol7qm request example the example request parameters and headers are set as follows groupname is set to default scheduledpresentationid is set to 234567 put /2022/06/rest/groups/regular/default/schedule/234567/ 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 443 this is the example request body { "id" 0, "presentationid" 987654, "presentationname" "default", "isrecurrent" true, "eventdate" null, "starttime" "00 00 00", "duration" "1 00 00 00", "recurrencestartdate" null, "recurrenceenddate" null, "daysofweek" "everyday", "creationdate" "0001 01 01t00 00 00", "lastmodifieddate" "0001 01 01t00 00 00", "expirationdate" null, "interruptscheduling" false } success response 204 204 the specified scheduled presentation has been updated in the specified group 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 with 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 delete /{name}/schedule/{scheduledpresentationid\ int}/ removes the specified scheduled presentation from the specified group required scope token bsn api main groups regular update segment groupname string string the name of the group scheduledpresentationid int int the unique identifier for the scheduled presentation request example the example request parameters and headers are set as follows groupname is set to default scheduledpresentationid is set to 234567 delete /2022/06/rest/groups/regular/default/schedule/234567/ 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 scheduled presentation has been deleted from the specified group 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 with 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 /operations/ returns operational permissions granted to roles for specific business operations required scope token bsn api main groups operations retrieve request example the example request parameters and headers are set as follows get /2022/06/rest/groups/regular/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" "d430853f c05f 61b4 d137 0237a6984032", "singularname" "full control", "pluralname" "group (full control)", "fullname" "group (full control)", "targetentity" "group", "appliance" "instance, collection", "parent" null, "descendants" \[ { "uid" "67b9b0ab fb5f 36c4 d598 a71aa8998e4e", "singularname" "view group", "pluralname" "view groups", "fullname" "group (full control) view groups", "targetentity" "group", "appliance" "instance, collection", "parent" { "uid" "d430853f c05f 61b4 d137 0237a6984032", "singularname" "full control", "pluralname" "group (full control)", "fullname" "group (full control)", "targetentity" "group", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "67b9b0ab fb5f 36c4 d598 a71aa8998e4e", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 08 17t20 49 46 907z" }, { "entityid" null, "operationuid" "67b9b0ab fb5f 36c4 d598 a71aa8998e4e", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 08 17t20 49 47 983z" }, { "entityid" null, "operationuid" "67b9b0ab fb5f 36c4 d598 a71aa8998e4e", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 45 95z" }, { "entityid" null, "operationuid" "67b9b0ab fb5f 36c4 d598 a71aa8998e4e", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 46 237z" }, { "entityid" null, "operationuid" "67b9b0ab fb5f 36c4 d598 a71aa8998e4e", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 46 553z" }, { "entityid" null, "operationuid" "67b9b0ab fb5f 36c4 d598 a71aa8998e4e", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 47 487z" }, { "entityid" null, "operationuid" "67b9b0ab fb5f 36c4 d598 a71aa8998e4e", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 10498 }, "isfixed" false, "isinherited" true, "isallowed" false, "creationdate" "2023 10 05t22 24 13 543z" } ] }, { "uid" "2e0ef6d3 8e8e f704 258c 82c8ecae089d", "singularname" "view devices", "pluralname" "view devices", "fullname" "group (full control) view devices", "targetentity" "group", "appliance" "instance, collection", "parent" { "uid" "d430853f c05f 61b4 d137 0237a6984032", "singularname" "full control", "pluralname" "group (full control)", "fullname" "group (full control)", "targetentity" "group", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "2e0ef6d3 8e8e f704 258c 82c8ecae089d", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 08 17t20 49 47 993z" }, { "entityid" null, "operationuid" "2e0ef6d3 8e8e f704 258c 82c8ecae089d", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 45 95z" }, { "entityid" null, "operationuid" "2e0ef6d3 8e8e f704 258c 82c8ecae089d", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 46 237z" }, { "entityid" null, "operationuid" "2e0ef6d3 8e8e f704 258c 82c8ecae089d", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 46 553z" }, { "entityid" null, "operationuid" "2e0ef6d3 8e8e f704 258c 82c8ecae089d", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 46 893z" }, { "entityid" null, "operationuid" "2e0ef6d3 8e8e f704 258c 82c8ecae089d", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 47 487z" }, { "entityid" null, "operationuid" "2e0ef6d3 8e8e f704 258c 82c8ecae089d", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 10498 }, "isfixed" false, "isinherited" true, "isallowed" false, "creationdate" "2023 10 05t22 24 13 543z" } ] }, { "uid" "432d38a8 7055 40f0 8dd2 348805c1b725", "singularname" "view schedule", "pluralname" "view schedule", "fullname" "group (full control) view schedule", "targetentity" "group", "appliance" "instance, collection", "parent" { "uid" "d430853f c05f 61b4 d137 0237a6984032", "singularname" "full control", "pluralname" "group (full control)", "fullname" "group (full control)", "targetentity" "group", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "432d38a8 7055 40f0 8dd2 348805c1b725", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 08 17t20 49 46 93z" }, { "entityid" null, "operationuid" "432d38a8 7055 40f0 8dd2 348805c1b725", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 08 17t20 49 48 003z" }, { "entityid" null, "operationuid" "432d38a8 7055 40f0 8dd2 348805c1b725", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 45 95z" }, { "entityid" null, "operationuid" "432d38a8 7055 40f0 8dd2 348805c1b725", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 46 237z" }, { "entityid" null, "operationuid" "432d38a8 7055 40f0 8dd2 348805c1b725", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 46 553z" }, { "entityid" null, "operationuid" "432d38a8 7055 40f0 8dd2 348805c1b725", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 47 487z" }, { "entityid" null, "operationuid" "432d38a8 7055 40f0 8dd2 348805c1b725", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 10498 }, "isfixed" false, "isinherited" true, "isallowed" false, "creationdate" "2023 10 05t22 24 13 543z" } ] }, { "uid" "08a3a36f 163c 7f44 9586 839aeee44587", "singularname" "create group", "pluralname" "create group", "fullname" "group (full control) create group", "targetentity" "group", "appliance" "collection", "parent" { "uid" "d430853f c05f 61b4 d137 0237a6984032", "singularname" "full control", "pluralname" "group (full control)", "fullname" "group (full control)", "targetentity" "group", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "08a3a36f 163c 7f44 9586 839aeee44587", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 45 95z" }, { "entityid" null, "operationuid" "08a3a36f 163c 7f44 9586 839aeee44587", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 46 237z" }, { "entityid" null, "operationuid" "08a3a36f 163c 7f44 9586 839aeee44587", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 46 553z" }, { "entityid" null, "operationuid" "08a3a36f 163c 7f44 9586 839aeee44587", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 46 893z" }, { "entityid" null, "operationuid" "08a3a36f 163c 7f44 9586 839aeee44587", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 47 487z" }, { "entityid" null, "operationuid" "08a3a36f 163c 7f44 9586 839aeee44587", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 47 97z" }, { "entityid" null, "operationuid" "08a3a36f 163c 7f44 9586 839aeee44587", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 10498 }, "isfixed" false, "isinherited" true, "isallowed" false, "creationdate" "2023 10 05t22 24 13 543z" } ] }, { "uid" "294648cf 9961 4b93 9ab9 23264a58328d", "singularname" "update group", "pluralname" "update group", "fullname" "group (full control) update group", "targetentity" "group", "appliance" "instance, collection", "parent" { "uid" "d430853f c05f 61b4 d137 0237a6984032", "singularname" "full control", "pluralname" "group (full control)", "fullname" "group (full control)", "targetentity" "group", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "294648cf 9961 4b93 9ab9 23264a58328d", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 45 95z" }, { "entityid" null, "operationuid" "294648cf 9961 4b93 9ab9 23264a58328d", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 46 237z" }, { "entityid" null, "operationuid" "294648cf 9961 4b93 9ab9 23264a58328d", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 46 553z" }, { "entityid" null, "operationuid" "294648cf 9961 4b93 9ab9 23264a58328d", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 46 893z" }, { "entityid" null, "operationuid" "294648cf 9961 4b93 9ab9 23264a58328d", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 47 487z" }, { "entityid" null, "operationuid" "294648cf 9961 4b93 9ab9 23264a58328d", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 47 97z" }, { "entityid" null, "operationuid" "294648cf 9961 4b93 9ab9 23264a58328d", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 10498 }, "isfixed" false, "isinherited" true, "isallowed" false, "creationdate" "2023 10 05t22 24 13 543z" } ] }, { "uid" "2f860f4e c67b a9d4 95de f0bdd6c10f58", "singularname" "add device", "pluralname" "add device", "fullname" "group (full control) add device", "targetentity" "group", "appliance" "instance, collection", "parent" { "uid" "d430853f c05f 61b4 d137 0237a6984032", "singularname" "full control", "pluralname" "group (full control)", "fullname" "group (full control)", "targetentity" "group", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "2f860f4e c67b a9d4 95de f0bdd6c10f58", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 45 95z" }, { "entityid" null, "operationuid" "2f860f4e c67b a9d4 95de f0bdd6c10f58", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 46 237z" }, { "entityid" null, "operationuid" "2f860f4e c67b a9d4 95de f0bdd6c10f58", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 46 553z" }, { "entityid" null, "operationuid" "2f860f4e c67b a9d4 95de f0bdd6c10f58", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 46 893z" }, { "entityid" null, "operationuid" "2f860f4e c67b a9d4 95de f0bdd6c10f58", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 47 487z" }, { "entityid" null, "operationuid" "2f860f4e c67b a9d4 95de f0bdd6c10f58", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 47 97z" }, { "entityid" null, "operationuid" "2f860f4e c67b a9d4 95de f0bdd6c10f58", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 10498 }, "isfixed" false, "isinherited" true, "isallowed" false, "creationdate" "2023 10 05t22 24 13 543z" } ] }, { "uid" "31cd7f9e 1cd2 22b4 7909 83de98da8115", "singularname" "remove device", "pluralname" "remove device", "fullname" "group (full control) remove device", "targetentity" "group", "appliance" "instance, collection", "parent" { "uid" "d430853f c05f 61b4 d137 0237a6984032", "singularname" "full control", "pluralname" "group (full control)", "fullname" "group (full control)", "targetentity" "group", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "31cd7f9e 1cd2 22b4 7909 83de98da8115", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 45 95z" }, { "entityid" null, "operationuid" "31cd7f9e 1cd2 22b4 7909 83de98da8115", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 46 237z" }, { "entityid" null, "operationuid" "31cd7f9e 1cd2 22b4 7909 83de98da8115", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 46 553z" }, { "entityid" null, "operationuid" "31cd7f9e 1cd2 22b4 7909 83de98da8115", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 46 893z" }, { "entityid" null, "operationuid" "31cd7f9e 1cd2 22b4 7909 83de98da8115", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 47 487z" }, { "entityid" null, "operationuid" "31cd7f9e 1cd2 22b4 7909 83de98da8115", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 47 97z" }, { "entityid" null, "operationuid" "31cd7f9e 1cd2 22b4 7909 83de98da8115", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 10498 }, "isfixed" false, "isinherited" true, "isallowed" false, "creationdate" "2023 10 05t22 24 13 543z" } ] }, { "uid" "66702586 1ae4 4079 83e7 d803e6b105d5", "singularname" "update schedule", "pluralname" "update schedule", "fullname" "group (full control) update schedule", "targetentity" "group", "appliance" "instance, collection", "parent" { "uid" "d430853f c05f 61b4 d137 0237a6984032", "singularname" "full control", "pluralname" "group (full control)", "fullname" "group (full control)", "targetentity" "group", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "66702586 1ae4 4079 83e7 d803e6b105d5", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 08 17t20 49 46 943z" }, { "entityid" null, "operationuid" "66702586 1ae4 4079 83e7 d803e6b105d5", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" false, "isallowed" false, "creationdate" "2020 08 17t20 49 47 5z" }, { "entityid" null, "operationuid" "66702586 1ae4 4079 83e7 d803e6b105d5", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 45 95z" }, { "entityid" null, "operationuid" "66702586 1ae4 4079 83e7 d803e6b105d5", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 46 237z" }, { "entityid" null, "operationuid" "66702586 1ae4 4079 83e7 d803e6b105d5", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 46 553z" }, { "entityid" null, "operationuid" "66702586 1ae4 4079 83e7 d803e6b105d5", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 47 97z" }, { "entityid" null, "operationuid" "66702586 1ae4 4079 83e7 d803e6b105d5", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 10498 }, "isfixed" false, "isinherited" true, "isallowed" false, "creationdate" "2023 10 05t22 24 13 543z" } ] }, { "uid" "df37d180 183f 68e4 1515 5ea51a0d053f", "singularname" "edit permissions", "pluralname" "edit permissions", "fullname" "group (full control) edit permissions", "targetentity" "group", "appliance" "collection", "parent" { "uid" "d430853f c05f 61b4 d137 0237a6984032", "singularname" "full control", "pluralname" "group (full control)", "fullname" "group (full control)", "targetentity" "group", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "df37d180 183f 68e4 1515 5ea51a0d053f", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 45 95z" }, { "entityid" null, "operationuid" "df37d180 183f 68e4 1515 5ea51a0d053f", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 46 237z" }, { "entityid" null, "operationuid" "df37d180 183f 68e4 1515 5ea51a0d053f", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 46 553z" }, { "entityid" null, "operationuid" "df37d180 183f 68e4 1515 5ea51a0d053f", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 46 893z" }, { "entityid" null, "operationuid" "df37d180 183f 68e4 1515 5ea51a0d053f", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 47 487z" }, { "entityid" null, "operationuid" "df37d180 183f 68e4 1515 5ea51a0d053f", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 47 97z" }, { "entityid" null, "operationuid" "df37d180 183f 68e4 1515 5ea51a0d053f", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 10498 }, "isfixed" false, "isinherited" true, "isallowed" false, "creationdate" "2023 10 05t22 24 13 543z" } ] }, { "uid" "0720a4b7 7c43 76f4 4913 4d92f5709149", "singularname" "delete group", "pluralname" "delete group", "fullname" "group (full control) delete group", "targetentity" "group", "appliance" "instance, collection", "parent" { "uid" "d430853f c05f 61b4 d137 0237a6984032", "singularname" "full control", "pluralname" "group (full control)", "fullname" "group (full control)", "targetentity" "group", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "0720a4b7 7c43 76f4 4913 4d92f5709149", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 45 95z" }, { "entityid" null, "operationuid" "0720a4b7 7c43 76f4 4913 4d92f5709149", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 46 237z" }, { "entityid" null, "operationuid" "0720a4b7 7c43 76f4 4913 4d92f5709149", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 46 553z" }, { "entityid" null, "operationuid" "0720a4b7 7c43 76f4 4913 4d92f5709149", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 46 893z" }, { "entityid" null, "operationuid" "0720a4b7 7c43 76f4 4913 4d92f5709149", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 47 487z" }, { "entityid" null, "operationuid" "0720a4b7 7c43 76f4 4913 4d92f5709149", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 47 97z" }, { "entityid" null, "operationuid" "0720a4b7 7c43 76f4 4913 4d92f5709149", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 10498 }, "isfixed" false, "isinherited" true, "isallowed" false, "creationdate" "2023 10 05t22 24 13 543z" } ] } ], "permissions" \[ { "entityid" null, "operationuid" "d430853f c05f 61b4 d137 0237a6984032", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 08 17t20 49 45 95z" }, { "entityid" null, "operationuid" "d430853f c05f 61b4 d137 0237a6984032", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 08 17t20 49 46 237z" }, { "entityid" null, "operationuid" "d430853f c05f 61b4 d137 0237a6984032", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" false, "isallowed" false, "creationdate" "2020 08 17t20 49 46 553z" }, { "entityid" null, "operationuid" "d430853f c05f 61b4 d137 0237a6984032", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" false, "isallowed" false, "creationdate" "2020 08 17t20 49 46 893z" }, { "entityid" null, "operationuid" "d430853f c05f 61b4 d137 0237a6984032", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 08 17t20 49 47 487z" }, { "entityid" null, "operationuid" "d430853f c05f 61b4 d137 0237a6984032", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" false, "isallowed" false, "creationdate" "2020 08 17t20 49 47 97z" }, { "entityid" null, "operationuid" "d430853f c05f 61b4 d137 0237a6984032", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 10498 }, "isfixed" false, "isinherited" false, "isallowed" false, "creationdate" "2023 10 05t22 24 13 543z" } ] } 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/ includes object permissions for a given group instance required scope token bsn api main groups regular retrieve segment id int int the unique identifier of the group request example the example request parameters and headers are set as follows id is set to 56789 get /2022/06/rest/groups/regular/56789/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" 56789, "operationuid" "67b9b0ab fb5f 36c4 d598 a71aa8998e4e", "principal" { "login" "johndoe\@brightsign biz", "type" "user", "id" 5432 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 06 01t17 13 32 927z" }, { "entityid" 56789, "operationuid" "d430853f c05f 61b4 d137 0237a6984032", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 12345 }, "isfixed" false, "isinherited" false, "isallowed" false, "creationdate" "2023 10 27t18 48 11 053z" } ] 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/ adds permissions to the specified group required scope token bsn api main groups regular update segment id int int the unique identifier of the group 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/groups/regular/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 343 this is the example request body { "entityid" 12345, "operationuid" "67b9b0ab fb5f 36c4 d598 a71aa8998e4e", "principal" { "login" "janedoe\@brightsign biz", "type" "user", "id" 12345 }, "isfixed" false, "isinherited" false, "isallowed" true, "creationdate" "0001 01 01t00 00 00" } success response 204 204 the permissions were successfully added to the group failure response 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance with 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/ deletes permissions from the specified group required scope token bsn api main groups regular update segment id int int the unique identifier of the group 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 56789 delete /2022/06/rest/groups/regular/56789/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 604 this is the example request body \[ { "entityid" 56789, "operationuid" "d430853f c05f 61b4 d137 0237a6984032", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 12345 }, "isfixed" false, "isinherited" false, "isallowed" false, "creationdate" "2023 10 27t18 48 11 053z" } ] success response 204 204 the specified permissions have been removed from the group 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 with 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 /{name}/permissions/ includes object permissions for a given group instance required scope token bsn api main groups regular retrieve segment name string string the name of the group request example the example request parameters and headers are set as follows name is set to device control get /2022/06/rest/groups/regular/device control/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" "67b9b0ab fb5f 36c4 d598 a71aa8998e4e", "principal" { "login" "johndoe\@brightsign biz", "type" "user", "id" 1234 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 06 01t17 13 32 927z" }, { "entityid" 12345, "operationuid" "d430853f c05f 61b4 d137 0237a6984032", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 12345 }, "isfixed" false, "isinherited" false, "isallowed" false, "creationdate" "2023 10 27t18 48 11 053z" } ] 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 /{name}/permissions/ adds permissions to the specified group required scope token bsn api main groups regular update segment name string string the name of the group request body an array of permission entity (2022/06) docid\ jwfymc42cdrg5jy2skysu entities request example the example request parameters and headers are set as follows name is set to device control post /2022/06/rest/groups/regular/device control/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 343 this is the example request body { "entityid" 56789, "operationuid" "67b9b0ab fb5f 36c4 d598 a71aa8998e4e", "principal" { "login" "janedoe\@brightsign biz", "type" "user", "id" 12345 }, "isfixed" false, "isinherited" false, "isallowed" true, "creationdate" "0001 01 01t00 00 00" } success response 204 204 the permissions were successfully added to the group failure response 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance with 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 /{name}/permissions/ removes permissions from the specified group required scope token bsn api main groups regular update segment name string string the name of the group request body an array of permission entity (2022/06) docid\ jwfymc42cdrg5jy2skysu entities request example the example request parameters and headers are set as follows name is set to device control delete /2022/06/rest/groups/regular/device control/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 604 this is the example request body \[ { "entityid" 12345, "operationuid" "d430853f c05f 61b4 d137 0237a6984032", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 12345 }, "isfixed" false, "isinherited" false, "isallowed" false, "creationdate" "2023 10 27t18 48 11 053z" } ] success response 204 204 the specified permissions have been removed from the group 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 with 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