Removes groups, specified by a filter, from a network. This allows multiple groups to be deleted at once.
bsn.api.main.groups.regular.delete
______________________________________________________________
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.
______________________________________________________________
200: Returns the number of affected groups as an integer value
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
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.
bsn.api.main.groups.regular.retrieve
______________________________________________________________
filter
string optional
An expression for filtering search results. The default value is null.
______________________________________________________________
200: The number of groups is returned as an integer value.
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
Returns the specified group
bsn.api.main.groups.regular.retrieve
______________________________________________________________
id
int
The unique identifier for the group
______________________________________________________________
200: Returns the Regular Groups Entity
304: The resource was not modified since the time specified in the “If-Modified-Since” header
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
Updates the specified group
bsn.api.main.groups.regular.update
______________________________________________________________
id
int
The unique identifier for the group
______________________________________________________________
______________________________________________________________
204: The specified group has been updated
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
Applies a sequence of changes to a specific group entity
bsn.api.main.groups.regular.update
______________________________________________________________
id
int
The identifier for the group entity, which is a resource Uri
______________________________________________________________
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
: The replacement value(s) for the id or serial of the group(s). This can be an array.
______________________________________________________________
204: The parameters have been successfully replaced.
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
Removes the specified group
bsn.api.main.groups.regular.delete
______________________________________________________________
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.
______________________________________________________________
204: The specified group has been removed from the network
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
Returns a specified group
bsn.api.main.groups.regular.retrieve
______________________________________________________________
name
string
The name of the group
______________________________________________________________
200: Returns the Regular Groups Entity
304: The resource was not modified since the time specified in the “If-Modified-Since” header
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
Updates a specified group
bsn.api.main.groups.regular.update
______________________________________________________________
name
string
The name of the group
______________________________________________________________
______________________________________________________________
204: The specified group has been updated
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
Applies a sequence of changes to a specific group entity
bsn.api.main.groups.regular.update
______________________________________________________________
name
string
The name of the group entity, which is a resource Uri
______________________________________________________________
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
: The replacement value(s) for the id or serial of the group(s). This can be an array.
______________________________________________________________
204: The parameters have been successfully replaced.
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
Removes a specified group
bsn.api.main.groups.regular.delete
______________________________________________________________
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.
______________________________________________________________
204: The specified group has been removed from the network
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
Returns a list of the scheduled presentations of the specified group
bsn.api.main.groups.regular.retrieve
______________________________________________________________
groupId
int
The unique identifier of the group
______________________________________________________________
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.
______________________________________________________________
200: Returns a list of the scheduled presentations of the specified group
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
Adds a scheduled presentation to the specified group
bsn.api.main.groups.regular.update
______________________________________________________________
groupId
int
The unique identifier of the group
______________________________________________________________
The scheduled presentation entity. See Scheduled Presentation Entity
______________________________________________________________
201: Returns the Scheduled Presentation Entity created and referenced by the Uri (given by the Location header field) in the response.
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
Returns a list of the Scheduled Presentations of the specified group
bsn.api.main.groups.regular.retrieve
______________________________________________________________
groupName
string
The name of the group
______________________________________________________________
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.
______________________________________________________________
200: Returns a list of the scheduled presentations of the specified group
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
Adds a scheduled presentation to the specified group
bsn.api.main.groups.regular.update
______________________________________________________________
groupName
string
The name of the group
______________________________________________________________
The Scheduled Presentation Entity
______________________________________________________________
201: Returns the Scheduled Presentation Entity created and referenced by the Uri (given by the Location header field) in the response.
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
Returns the schedule of the specified presentation in the specified group
bsn.api.main.groups.regular.retrieve
______________________________________________________________
groupId
int
The unique identifier of the group
scheduledPresentationId
int
The unique identifier for the scheduled presentation
______________________________________________________________
200: Returns the Scheduled Presentation Entity
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
Updates the specified scheduled presentation in the specified group.
bsn.api.main.groups.regular.update
______________________________________________________________
groupId
int
The unique identifier of the group
scheduledPresentationId
int
The unique identifier for the scheduled presentation
______________________________________________________________
The Scheduled Presentation Entity
______________________________________________________________
204: The scheduled presentation in the specified group has been updated
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
Removes a specified scheduled presentation from the specified group
bsn.api.main.groups.regular.update
______________________________________________________________
groupId
int
The unique identifier of the group
scheduledPresentationId
int
The unique identifier for the scheduled presentation
______________________________________________________________
204: The scheduled presentation has been deleted from the specified group
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
Returns the schedule of the specified presentation in the specified group
bsn.api.main.groups.regular.retrieve
______________________________________________________________
groupName
string
The name of the group
scheduledPresentationId
int
The unique identifier for the scheduled presentation
______________________________________________________________
200: Returns the Scheduled Presentation Entity.
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
Updates the specified scheduled presentation in the specified group.
bsn.api.main.groups.regular.update
______________________________________________________________
groupName
string
The name of the group
scheduledPresentationId
int
The unique identifier for the scheduled presentation
______________________________________________________________
The Scheduled Presentation Entity
______________________________________________________________
204: The specified scheduled presentation has been updated in the specified group
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
Removes the specified scheduled presentation from the specified group
bsn.api.main.groups.regular.update
______________________________________________________________
groupName
string
The name of the group
scheduledPresentationId
int
The unique identifier for the scheduled presentation
______________________________________________________________
204: The specified scheduled presentation has been deleted from the specified group
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
Returns operational permissions granted to roles for specific business operations
bsn.api.main.groups.operations.retrieve
______________________________________________________________
200: Returns the Business Operations Entity
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
Returns object permissions for a given group instance
bsn.api.main.groups.regular.retrieve
______________________________________________________________
id
int
The unique identifier of the group
______________________________________________________________
200: Returns an array of Permission entities
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
Adds permissions to the specified group
bsn.api.main.groups.regular.update
______________________________________________________________
id
int
The unique identifier of the group
______________________________________________________________
An array of Permission entities
______________________________________________________________
204: The permissions were successfully added to the group
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
Deletes permissions from the specified group
bsn.api.main.groups.regular.update
______________________________________________________________
id
int
The unique identifier of the group
______________________________________________________________
An array of Permission entities
______________________________________________________________
204: The specified permissions have been removed from the group
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
Returns object permissions for a given group instance.
bsn.api.main.groups.regular.retrieve
______________________________________________________________
name
string
The name of the group
______________________________________________________________
200: Returns an array of Permission entities
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
Adds permissions to the specified group
bsn.api.main.groups.regular.update
______________________________________________________________
name
string
The name of the group
______________________________________________________________
An array of Permission entities
______________________________________________________________
204: The permissions were successfully added to the group
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
Removes permissions from the specified group
bsn.api.main.groups.regular.update
______________________________________________________________
name
string
The name of the group
______________________________________________________________
An array of Permission entities
______________________________________________________________
204: The specified permissions have been removed from the group
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