/Groups/Regular/{id:int}/
GET
Returns a group, specified by id, on the network
Parameters
: The unique identifier for the group[int]
id
Response Body
Returns the Scheduled Presentation Entity
PUT
Updates the specified group on a network
Parameters
The unique identifier for the group[int] id:
Request Body
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
PATCH
Applies a sequence of changes to a specific group entity specified by id.
Parameters
[int]
id:
The identifier for the group entity, which is a resource Uri
Request Body
The request body is an array of instructions:
[string] op:
The type of operation - in this case it is always "replace"[string] path:
A Uri path that references the location within the target document where the update will be performedvalue:
The replacement value(s) for the id or serial of the group(s). This can be an array.
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
DELETE
Removes the specified groups from the network
Parameters
The unique identifier for the group[int] id:
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.[int] reassignmentGroupId:
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
/Groups/Regular/{name}/
GET
Returns a group, specified by name, on the network
Parameters
: The name of the group[string] name
Response Body
Returns the Scheduled Presentation Entity
PUT
Updates a group, specified by name, on the network
Parameters
: The name of the group[string] name
Request Body
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
PATCH
Applies a sequence of changes to a specific group entity specified by name.
Parameters
[string] name:
The name of the group entity, which is a resource Uri
Request Body
The request body is an array of instructions:
[string] op:
The type of operation - in this case it is always "replace"[string] path:
A Uri path that references the location within the target document where the update will be performedvalue:
The replacement value(s) for the id or serial of the group(s). This can be an array.
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
DELETE
Removes a group, specified by name, from the network
Parameters
The name of the group[string] name:
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.[int] reassignmentGroupId:
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
/Groups/Regular/{groupId:int}/Schedule/
GET
Returns a list of the scheduled presentations of the specified group
Parameters
[int] groupId:
The unique identifier of the group[string]
marker
: A value specifying which page to retrieve. This value is useful if theisTruncated
entry in the response body of the previous GET call indicates that the number of group instances exceeds thepageSize
.
: The maximum number of group instances that can be contained in the response body.[int]
pageSize
Response Body
Returns a list of the scheduled presentations of the specified group
POST
Adds a scheduled presentation to the specified group
Parameters
The unique identifier of the group[int] groupId:
Request Body
The scheduled presentation entity. See Scheduled Presentation Entity
Response Body
Returns a 201 status code and the new resource created and referenced by the Uri (given by the Location header field) in the response. The response includes the Scheduled Presentation Entity.
/Groups/Regular/{groupName}/Schedule/
GET
Returns a list of the scheduled presentations of the specified group
Parameters
[string] groupName:
The name of the group[string]
marker
: A value specifying which page to retrieve. This value is useful if theisTruncated
entry in the response body of the previous GET call indicates that the number of group instances exceeds thepageSize
.
: The maximum number of group instances that can be contained in the response body.[int]
pageSize
Response Body
Returns a list of the scheduled presentations of the specified group
POST
Adds a scheduled presentation to the specified group
Parameters
The name of the group[string] groupName:
Request Body
The Scheduled Presentation Entity
Response Body
Returns a 201 status code and the new resource created and referenced by the Uri (given by the Location header field) in the response. The response includes the Scheduled Presentation Entity.
/Groups/Regular/{groupId:int}/Schedule/{scheduledPresentationId:int}/
GET
Returns the schedule of the specified presentation in the specified group
Parameters
The unique identifier of the group[int] groupId:
: The unique identifier for the scheduled presentation[int] s
cheduledPresentationId
Response Body
Returns the Scheduled Presentation Entity.
PUT
Updates the specified scheduled presentation in the specified group.
Parameters
The unique identifier of the group[int] groupId:
: The unique identifier for the scheduled presentation[int] s
cheduledPresentationId
Request Body
The Scheduled Presentation Entity.
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
DELETE
Removes a specified scheduled presentation from the specified group
Parameters
The unique identifier of the group[int] groupId:
: The unique identifier for the scheduled presentation[int] s
cheduledPresentationId
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
/Groups/Regular/{groupName}/Schedule/{scheduledPresentationId:int}/
GET
Returns the schedule of the specified presentation in the specified group
Parameters
[int] groupName:
The name of the group
: The unique identifier for the scheduled presentation[int] s
cheduledPresentationId
Response Body
Returns the Scheduled Presentation Entity.
PUT
Updates the specified scheduled presentation in the specified group.
Parameters
The name of the group[string] groupName:
: The unique identifier for the scheduled presentation[int] s
cheduledPresentationId
Request Body
The Scheduled Presentation Entity.
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
DELETE
Removes the specified scheduled presentation from the specified group
Parameters
The name of the group[int] groupName:
: The unique identifier for the scheduled presentation[int] s
cheduledPresentationId
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
/Groups/Regular/Operations/
GET
Returns operational permissions granted to roles for specific business operations
Response Body
Returns the Business Operations Entity
/Groups/Regular/{id:int}/Permissions/
GET
Includes object permissions for a given group instance.
Parameters
[int] id:
The unique identifier for the group
Response Body
Returns the Permission Entity
POST
Adds permissions to the specified group
Parameters
[int] id:
The unique identifier for the group
Request Body
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
DELETE
Parameters
[int] id:
The unique identifier for the group
Request Body
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
/Groups/Regular/{name}/Permissions/
GET
Includes object permissions for a given group instance.
Parameters
[string] name:
The name of the group
Response Body
Returns the Permission Entity
POST
Adds permissions to the specified group
Parameters
[string] name:
The name of the group
Request Body
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
DELETE
Removes permissions from the specified group
Parameters
[string] name:
The name of the group
Request Body
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.