Groups/Regular Endpoints (2020/10)

Use these endpoints to manage groups on the network. 

/Groups/Regular/

GET

Retrieves a list of groups on the network.

Parameters

  • [string] filter:  An expression for filtering search results.
  • [string] sort: 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. "[Group].[Autorun].[Version] DESC")
  • [string] marker: 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.
  • [int] pageSize: The maximum number of group instances that can be contained in the response body

Response Body

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.

POST

Creates a group on the network.

Request Body

The Regular Groups 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 Regular Groups Entity.

DELETE

Removes groups, specified by a filter, from a network. This allows multiple groups to be deleted at once.

Parameters

  • [string] filter: An expression for filtering search results
  • [int] reassignmentGroupId: 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.

Response Body

Returns the number of affected groups as an integer value.

/Groups/Regular/Count/

GET

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. 

Parameters

  • [string] filter:  An expression for filtering search results.

Response Body

The number of groups is returned as an integer value.

ON THIS PAGE


/Groups/Regular/{id:int}/

GET

Returns a group, specified by id, on the network

Parameters

  • [int] id: The unique identifier for the group

Response Body

Returns the Scheduled Presentation Entity

PUT

Updates the specified group on a network

Parameters

  • [int] id: The unique identifier for the group

Request Body

The Regular Groups Entity

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 performed
  • value:  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

  • [int] id: The unique identifier for the group
  • [int] reassignmentGroupId: 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.

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

  • [string] name: The name of the group

Response Body

Returns the Scheduled Presentation Entity

PUT

Updates a group, specified by name, on the network

Parameters

  • [string] name: The name of the group

Request Body

The Regular Groups Entity

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 performed
  • value:  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

  • [string] name: The name of the group
  • [int] reassignmentGroupId: 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.

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 the isTruncated entry in the response body of the previous GET call indicates that the number of group instances exceeds the pageSize.
  • [int] pageSize: The maximum number of group instances that can be contained in the response body.

Response Body

Returns a list of the scheduled presentations of the specified group

POST

Adds a scheduled presentation to the specified group

Parameters

  • [int] groupId: The unique identifier of the group

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 the isTruncated entry in the response body of the previous GET call indicates that the number of group instances exceeds the pageSize.
  • [int] pageSize: The maximum number of group instances that can be contained in the response body.

Response Body

Returns a list of the scheduled presentations of the specified group

POST

Adds a scheduled presentation to the specified group

Parameters

  • [string] groupName: The name of the group

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

  • [int] groupId: The unique identifier of the group
  • [int] scheduledPresentationId: The unique identifier for the scheduled presentation

Response Body

Returns the Scheduled Presentation Entity.

PUT

Updates the specified scheduled presentation in the specified group.

Parameters

  • [int] groupId: The unique identifier of the group
  • [int] scheduledPresentationId: The unique identifier for the scheduled presentation

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

  • [int] groupId: The unique identifier of the group
  • [int] scheduledPresentationId: The unique identifier for the scheduled presentation

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
  • [int] scheduledPresentationId: The unique identifier for the scheduled presentation

Response Body

Returns the Scheduled Presentation Entity.

PUT

Updates the specified scheduled presentation in the specified group.

Parameters

  • [string] groupName: The name of the group
  • [int] scheduledPresentationId: The unique identifier for the scheduled presentation

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

  • [int] groupName: The name of the group
  • [int] scheduledPresentationId: The unique identifier for the scheduled presentation

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

The Permission Entity

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

The Permission Entity

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

The Permission Entity

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

The Permission Entity

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.