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 optional
An expression 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 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 group instances that can be contained in the response body. This defaults to the maximum allowed page size (100).
______________________________________________________________
Response
Success Response Body
200: Returns a paged list 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: 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 group on the network.
Required Scope Token
bsn.api.main.groups.regular.create
______________________________________________________________
Request Body
______________________________________________________________
Response
Success Response Body
201: Returns the Regular Groups Entity created and referenced by the Uri (given by the Location header field) in the response.
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: Either the request or request body 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)
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 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 required
An expression for filtering search results.
reassignmentGroupId
int 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: Returns the number of affected groups as an integer value
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
5XX: Any 500 code is an internal server error
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 optional
An expression for filtering search results. The default value is null.
______________________________________________________________
Response
Success Response Body
200: The number of groups is returned as an integer value.
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
5XX: Any 500 code is an internal server error
GET /{id:int}/
Returns the specified group
Required Scope Token
bsn.api.main.groups.regular.retrieve
______________________________________________________________
Segment
id
int
The unique identifier for the group
______________________________________________________________
Response
Success Response with Body
200: Returns the Regular Groups Entity
Success Response
304: The resource was not modified since the time specified in the “If-Modified-Since” header
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
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:int}/
Updates the specified group
Required Scope Token
bsn.api.main.groups.regular.update
______________________________________________________________
Segment
id
int
The unique identifier for the group
______________________________________________________________
Request Body
______________________________________________________________
Response
Success
204: The specified group has been updated
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: Either the request or request body 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)
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
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
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: The type of operation - in this case it is always "replace"
path
string: A Uri path that references the location within the target document where the update will be performed
value
object: The replacement value(s) for the id or serial of the group(s). This can be an array.
______________________________________________________________
Response
Success
204: The parameters have been successfully replaced.
Failure
400: Either the request or request body is malformed and therefore invalid
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)
412: Precondition failed (the resource 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:int}/
Removes the specified group
Required Scope Token
bsn.api.main.groups.regular.delete
______________________________________________________________
Segment
id
int
The unique identifier for the group
reassignmentGroupId
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: The specified group has been removed from the network
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
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 a specified group
Required Scope Token
bsn.api.main.groups.regular.retrieve
______________________________________________________________
Segment
name
string
The name of the group
______________________________________________________________
Response
Success Response with Body
200: Returns the Regular Groups Entity
Success Response
304: The resource was not modified since the time specified in the “If-Modified-Since” header
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
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 a specified group
Required Scope Token
bsn.api.main.groups.regular.update
______________________________________________________________
Segment
name
string
The name of the group
______________________________________________________________
Request Body
______________________________________________________________
Response
Success
204: The specified group has been updated
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: Either the request or request body 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)
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
PATCH /{name}/
Applies a sequence of changes to a specific group entity
Required Scope Token
bsn.api.main.groups.regular.update
______________________________________________________________
Segment
name
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: The type of operation - in this case it is always "replace"
path
string: A Uri path that references the location within the target document where the update will be performed
value
object: The replacement value(s) for the id or serial of the group(s). This can be an array.
______________________________________________________________
Response
Success
204: The parameters have been successfully replaced.
Failure
400: Either the request or request body is malformed and therefore invalid
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)
412: Precondition failed (the resource 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}/
Removes a specified group
Required Scope Token
bsn.api.main.groups.regular.delete
______________________________________________________________
Segment
name
string
The name of the group
reassignmentGroupId
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: The specified group has been removed from the network
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
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 /{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
The unique identifier of the group
______________________________________________________________
Query String Parameters
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 group instances exceeds the pageSize
.
pageSize
int optional
The maximum number of group instances that can be contained in the response body.
______________________________________________________________
Response
Success Response Body
200: Returns a list of the scheduled presentations of the specified group
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
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:int}/Schedule/
Adds a scheduled presentation to the specified group
Required Scope Token
bsn.api.main.groups.regular.update
______________________________________________________________
Segment
groupId
int
The unique identifier of the group
______________________________________________________________
Request Body
The scheduled presentation entity. See Scheduled Presentation Entity
______________________________________________________________
Response Body
Success Response Body
201: Returns the Scheduled Presentation Entity created and referenced by the Uri (given by the Location header field) in the response.
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: Either the request or request body 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)
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
GET /{name}/Schedule/
Returns a list of the Scheduled Presentations of the specified group
Required Scope Token
bsn.api.main.groups.regular.retrieve
______________________________________________________________
Segment
groupName
string
The name of the group
______________________________________________________________
Query String Parameters
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 group instances exceeds the pageSize
.
pageSize
int optional
The maximum number of group instances that can be contained in the response body.
______________________________________________________________
Response
Success Response Body
200: Returns a list of the scheduled presentations of the specified group
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
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}/Schedule/
Adds a scheduled presentation to the specified group
Required Scope Token
bsn.api.main.groups.regular.update
______________________________________________________________
Segment
groupName
string
The name of the group
______________________________________________________________
Request Body
The Scheduled Presentation Entity
______________________________________________________________
Response
Success Response Body
201: Returns the Scheduled Presentation Entity created and referenced by the Uri (given by the Location header field) in the response.
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: Either the request or request body 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)
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
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
The unique identifier of the group
scheduledPresentationId
int
The unique identifier for the scheduled presentation
______________________________________________________________
Response
Success Response Body
200: Returns the Scheduled Presentation Entity
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
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: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
The unique identifier of the group
scheduledPresentationId
int
The unique identifier for the scheduled presentation
______________________________________________________________
Request Body
The Scheduled Presentation Entity
______________________________________________________________
Response
Success
204: The scheduled presentation in the specified group has been updated
Failure
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
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)
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: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
The unique identifier of the group
scheduledPresentationId
int
The unique identifier for the scheduled presentation
______________________________________________________________
Response
Success
204: The scheduled presentation has been deleted from the specified group
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
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}/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
The name of the group
scheduledPresentationId
int
The unique identifier for the scheduled presentation
______________________________________________________________
Response
Success Response Body
200: Returns the Scheduled Presentation Entity.
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
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}/Schedule/{scheduledPresentationId:int}/
Updates the specified scheduled presentation in the specified group.
Required Scope Token
bsn.api.main.groups.regular.update
______________________________________________________________
Segment
groupName
string
The name of the group
scheduledPresentationId
int
The unique identifier for the scheduled presentation
______________________________________________________________
Request Body
The Scheduled Presentation Entity
______________________________________________________________
Response
Success
204: The specified scheduled presentation has been updated in the specified group
Failure
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
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)
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}/Schedule/{scheduledPresentationId:int}/
Removes the specified scheduled presentation from the specified group
Required Scope Token
bsn.api.main.groups.regular.update
______________________________________________________________
Segment
groupName
string
The name of the group
scheduledPresentationId
int
The unique identifier for the scheduled presentation
______________________________________________________________
Response
Success
204: The specified scheduled presentation has been deleted from the specified group
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
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 /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: Returns the Business Operations Entity
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
5XX: Any 500 code is an internal server error
GET /{id:int}/Permissions/
Returns object permissions for a given group instance
Required Scope Token
bsn.api.main.groups.regular.retrieve
______________________________________________________________
Segment
id
int
The unique identifier of the group
______________________________________________________________
Response
Success Response Body
200: Returns an array of Permission entities
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
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:int}/Permissions/
Adds permissions to the specified group
Required Scope Token
bsn.api.main.groups.regular.update
______________________________________________________________
Segment
id
int
The unique identifier of the group
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
Response
Success
204: The permissions were successfully added to the group
Failure
400: The request or request body 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)
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:int}/Permissions/
Deletes permissions from the specified group
Required Scope Token
bsn.api.main.groups.regular.update
______________________________________________________________
Segment
id
int
The unique identifier of the group
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
Response
Success
204: The specified permissions have been removed from the group
Failure
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
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/
Returns object permissions for a given group instance.
Required Scope Token
bsn.api.main.groups.regular.retrieve
______________________________________________________________
Segment
name
string
The name of the group
______________________________________________________________
Response
Success Response Body
200: Returns an array of Permission entities
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
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 to the specified group
Required Scope Token
bsn.api.main.groups.regular.update
______________________________________________________________
Segment
name
string
The name of the group
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
Response
Success
204: The permissions were successfully added to the group
Failure
400: The request or request body 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)
415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)
5XX: Any 500 code is an internal server error
DELETE /{name}/Permissions/
Removes permissions from the specified group
Required Scope Token
bsn.api.main.groups.regular.update
______________________________________________________________
Segment
name
string
The name of the group
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
Response
Success
204: The specified permissions have been removed from the group
Failure
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
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