Groups/Tagged Endpoints (2022/06)

21 min

use these endpoints to manage tagged groups on the network base url for these endpoints https //api bsn cloud/2022/06/rest/groups/tagged get / retrieves a list of tagged groups on the network required scope token bsn api main groups tagged retrieve query string parameters filter \string\ \optional \ an expression docid 3l0afyd3xooe ytvfk2vs for filtering search results the default value is null sort \string\ \optional \ an expression for sorting the search results the sort expression specifies the entry used for sorting and the ascending/descending (asc/desc) sorting order (e g " \[device] \[serial] asc ") the default value is null marker \string\ \optional \ a value specifying which page to retrieve this value is useful if the istruncated entry in the response body of the previous get call indicates that the number of tagged 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\ \optional \ the maximum number of tagged group instances that can be contained in the response body this defaults to the maximum allowed page size (100) success response body \200\ returns a paged list docid\ pwwr0ln3 binngl mr3st of tagged groups entity docid 7raxufh54wfvbwphf1hj instances on a network this will return not more than 100 entities along with the information necessary to return any other remaining pages failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error post / creates a tagged group on a network required scope token bsn api main groups tagged create request body the tagged groups entity docid 7raxufh54wfvbwphf1hj success response body \201\ returns the tagged groups entity docid 7raxufh54wfvbwphf1hj created and referenced by the uri (given by the location header field) in the response failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \415\ the server cannot accept the data representation that you sent (as specified in the "content type" header) \5xx\ any 500 code is an internal server error delete / removes tagged groups, specified by a filter, from a network this allows multiple tagged groups to be deleted at once required scope token bsn api main groups tagged delete query string parameter filter \string\ \required \ an expression docid 3l0afyd3xooe ytvfk2vs for filtering search results success response body \200\ returns the number of affected tagged groups as an integer value failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error get /count/ returns the number of tagged groups on the network that match the specified filter criteria if no filter is included, this call returns the total number of tagged groups on the network required scope token bsn api main groups tagged retrieve query string parameter filter \string\ \optional \ an expression docid 3l0afyd3xooe ytvfk2vs for filtering search results success response body \200\ the number of tagged groups is returned as an integer value failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error get /{id}/ returns the specified tagged group required scope token bsn api main groups tagged retrieve segment id \int \ the unique identifier for the tagged group success response with body \200\ returns the tagged groups entity docid 7raxufh54wfvbwphf1hj success response \304\ the resource was not modified since the time specified in the “if modified since” header failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error put /{id}/ updates the specified tagged group required scope token bsn api main groups tagged update segment id \int \ the unique identifier for the tagged group request body the tagged groups entity docid 7raxufh54wfvbwphf1hj success response \204\ the tagged group was updated failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \412\ precondition failed (the resource/group changed since the time specified in the “if unmodified since” header value) \415\ the server cannot accept the data representation that you sent (as specified in the "content type" header) \5xx\ any 500 code is an internal server error delete /{id}/ deletes a specified tagged group required scope token bsn api main groups tagged delete segment id \int \ the unique identifier for the tagged group success response \204\ the tagged group was deleted failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \412\ precondition failed (the resource changed since the time specified in the “if unmodified since” header value) \5xx\ any 500 code is an internal server error get /{name}/ returns the specified tagged group required scope token bsn api main groups tagged retrieve segment name \string \ the name of the tagged group success response with body \200\ returns the tagged groups entity docid 7raxufh54wfvbwphf1hj success response \304\ the resource was not modified since the time specified in the “if modified since” header failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error put /{name}/ updates the specified tagged group required scope token bsn api main groups tagged update segment name \string \ the name of the tagged group request body the tagged groups entity docid 7raxufh54wfvbwphf1hj success response \204\ the tagged group was updated failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \412\ precondition failed (the resource/group changed since the time specified in the “if unmodified since” header value) \415\ the server cannot accept the data representation that you sent (as specified in the "content type" header) \5xx\ any 500 code is an internal server error delete /{name}/ deletes a specified tagged group required scope token bsn api main groups tagged delete segment name \string \ the name of the tagged group success response \204\ the tagged group was deleted failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \412\ precondition failed (the resource changed since the time specified in the “if unmodified since” header value) \5xx\ any 500 code is an internal server error get /operations/ returns operational permissions granted to roles for specific business operations required scope token bsn api main groups operations retrieve success response body \200\ returns the business operations entity docid\ ei98k7oul6z5i 5b d6js failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error get /{id}/permissions/ includes object permissions for a given tagged group instance required scope token bsn api main groups tagged retrieve segment id \int \ the unique identifier for the tagged group success response body \200\ returns an array of permission docid\ jwfymc42cdrg5jy2skysu entities failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error post /{id}/permissions/ adds permissions for a specified tagged group required scope token bsn api main groups tagged update segment id \int \ the unique identifier for the tagged group request body an array of permission docid\ jwfymc42cdrg5jy2skysu entities success response \204\ the permissions were successfully added to the specified tagged group instance failure response \400\ the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \415\ the server cannot accept the data representation that you sent (as specified in the "content type" header) \5xx\ any 500 code is an internal server error delete /{id}/permissions/ removes permissions for a specified tagged group required scope token bsn api main groups tagged update segment id \int \ the unique identifier for the tagged group request body an array of permission docid\ jwfymc42cdrg5jy2skysu entities success response \204\ the specified permissions were removed from the tagged group failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error get /{name}/permissions/ includes object permissions for a given tagged group instance required scope token bsn api main groups tagged retrieve segment name \string \ the name of the tagged group success response body \200\ returns an array of permission docid\ jwfymc42cdrg5jy2skysu entities failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error post /{name}/permissions/ adds permissions for a specified tagged group required scope token bsn api main groups tagged update segment name \string \ the name of the tagged group request body an array of permission docid\ jwfymc42cdrg5jy2skysu entities success response \204\ the permissions were successfully added to the specified tagged group instance failure response \400\ the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \415\ the server cannot accept the data representation that you sent (as specified in the "content type" header) \5xx\ any 500 code is an internal server error delete /{name}/permissions/ removes permissions for a specified tagged group required scope token bsn api main groups tagged update segment name \string \ the name of the tagged group request body an array of permission docid\ jwfymc42cdrg5jy2skysu entities success response \204\ the specified permissions were removed from the tagged group failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error