Groups/Regular Endpoints (2020/10)

use these endpoints to manage groups on the network base url for these endpoints https //api bsn cloud/2020/10/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 (e g " \[device] \[serial] asc ") 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) response success response body 200 200 returns a paged list entity (2020/10) docid\ joielmbbiwrnzeqzvpqqa of regular groups entity instances on a network this will return not more than 100 entities along with the information necessary to return any other remaining pages failure 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 response success response body 201 201 returns the regular groups entity created and referenced by the uri (given by the location header field) in the response failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 either the request or request body 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) 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 parameters 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 response success response body 200 200 returns the number of affected groups as an integer value failure 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 /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 response success response body 200 200 the number of groups is returned as an integer value failure 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 the specified group required scope token bsn api main groups regular retrieve segment id int int the unique identifier for the group response success response with body 200 200 returns the regular groups entity success response 304 304 the resource was not modified since the time specified in the “if modified since” header failure 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 response success 204 204 the specified group has been updated failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 either the request or request body 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) 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 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 id or serial of the group(s) this can be an array response success 204 204 the parameters have been successfully replaced failure 400 400 either the request or request body is malformed and therefore invalid 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 reassignmentgroupid int int 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 response success 204 204 the specified group has been removed from the network failure 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) 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 response success response with body 200 200 returns the regular groups entity success response 304 304 the resource was not modified since the time specified in the “if modified since” header failure 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 response success 204 204 the specified group has been updated failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 either the request or request body 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) 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 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 id or serial of the group(s) this can be an array response success 204 204 the parameters have been successfully replaced failure 400 400 either the request or request body is malformed and therefore invalid 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 reassignmentgroupid int int 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 response success 204 204 the specified group has been removed from the network failure 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) 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 presentations of the specified group required scope token bsn api main groups regular retrieve segment groupid int int the unique identifier of the group query string parameters marker string 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 group instances exceeds the pagesize pagesize int int optional the maximum number of group instances that can be contained in the response body response success response body 200 200 returns a list of the scheduled presentations of the specified group failure 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 (2020/10) docid\ kvowp8p5b4ye9zmkvfkez response body success response body 201 201 returns the scheduled presentation entity (2020/10) docid\ kvowp8p5b4ye9zmkvfkez created and referenced by the uri (given by the location header field) in the response failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 either the request or request body 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) 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 (2020/10) docid\ kvowp8p5b4ye9zmkvfkez of 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 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 the maximum number of group instances that can be contained in the response body response success response body 200 200 returns a list of the scheduled presentations of the specified group failure 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 (2020/10) docid\ kvowp8p5b4ye9zmkvfkez response success response body 201 201 returns the scheduled presentation entity (2020/10) docid\ kvowp8p5b4ye9zmkvfkez created and referenced by the uri (given by the location header field) in the response failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 either the request or request body 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) 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 response success response body 200 200 returns the scheduled presentation entity (2020/10) docid\ kvowp8p5b4ye9zmkvfkez failure 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 (2020/10) docid\ kvowp8p5b4ye9zmkvfkez response success 204 204 the scheduled presentation in the specified group has been updated failure 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 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 response success 204 204 the scheduled presentation has been deleted from the specified group failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{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 response success response body 200 200 returns the scheduled presentation entity (2020/10) docid\ kvowp8p5b4ye9zmkvfkez failure 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 (2020/10) docid\ kvowp8p5b4ye9zmkvfkez response success 204 204 the specified scheduled presentation has been updated in the specified group failure 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 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 response success 204 204 the specified scheduled presentation has been deleted from the specified group failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /operations/ returns operational permissions granted to roles for specific business operations required scope token bsn api main groups operations retrieve response success response body 200 200 returns the business operations entity (2020/10) docid\ ychro4ocgshfhae1gvygf failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{id\ int}/permissions/ returns 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 response success response body 200 200 returns an array of permission entity (2020/10) docid 9p ncidl9xh7qdpkxgodl entities failure 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 permission entity (2020/10) docid 9p ncidl9xh7qdpkxgodl entities response success 204 204 the permissions were successfully added to the group failure 400 400 the request or request body 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) 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 (2020/10) docid 9p ncidl9xh7qdpkxgodl entities response success 204 204 the specified permissions have been removed from the group failure 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 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/ returns 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 response success response body 200 200 returns an array of permission entity (2020/10) docid 9p ncidl9xh7qdpkxgodl entities failure 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 permission entity (2020/10) docid 9p ncidl9xh7qdpkxgodl entities response success 204 204 the permissions were successfully added to the group failure 400 400 the request or request body 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) 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 permission entity (2020/10) docid 9p ncidl9xh7qdpkxgodl entities response success 204 204 the specified permissions have been removed from the group failure 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 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