Use this endpoint to manage groups and presentation schedules on the network.
Base URL for these endpoints: https://api.brightsignnetwork.com/2017/01/REST/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 theisTruncated
entry in the response body of the previous GET call indicates that the number of Group instances exceeds thepageSize
.[int] pageSize
: The maximum number of group instances that can be contained in the response body
Response Body
Returns a paged list of 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 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 Groups Entity.
DELETE /
Removes groups, specified by a filter, from a network. This allows multiple groups to be deleted at once.
Parameters
An expression for filtering search results[string] filter:
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
Returns the number of affected groups as an integer value.
Endpoints:
Table of Contents | ||||||
---|---|---|---|---|---|---|
|
GET /Count/
Retrieves 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.
GET /{id:int}/
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 /{id:int}/
Updates the specified group on a network
Parameters
The unique identifier for the group[int] id:
Request Body
The Groups Entity
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
DELETE /{id:int}/
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.
GET /{name}/
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 /{name}/
Updates a group, specified by name, on the network
Parameters
: The name of the group[string] name
Request Body
The Groups Entity
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
DELETE /{name}/
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.
GET /{groupId:int}/Schedule/
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 /{groupId:int}/Schedule/
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.
GET /{groupName}/Schedule/
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 /{groupName}/Schedule/
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.
GET /{groupId:int}/Schedule/{scheduledPresentationId:int}/
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 /{groupId:intUpdates in .[int] groupId:
The unique identifier Request Body
The Scheduled Presentation Entity
[int] s
cheduledPresentationId
: The unique identifier for the scheduled presentationDELETE /{groupId:int}/Schedule/{scheduledPresentationId:int}/
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.
GET /{groupName}/Schedule/{scheduledPresentationId:int}/
Returns the schedule of the specified presentation in the specified group
Parameters
[string] groupName:
The name of the group
: The unique identifier for the scheduled presentation[int] s
cheduledPresentationId
Response Body
Returns the Scheduled Presentation Entity
PUT /{groupName}/Schedule/{scheduledPresentationId:int}/
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
groupName}/Schedule/{scheduledPresentationId the specified scheduled presentation from the specified groupParameters
[int] groupName:
The name of the group[int] s
cheduledPresentationId
: The unique identifier for the scheduled presentationOperations/ Returns operational permissions granted to roles for specific business operations
Response Body
Returns the Business Operations Entity
GET /{id:int[int] id:
The unique identifier for the group the id:int[int] id:
The unique identifier for the groupResponse Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
DELETE /{id:int}/Permissions/
Removes permissions from a specified group
Parameters[int] id:
The unique identifier for the group
Request Body
GET Adds permissions to theIncludes object permissions for a given group instance.
Parameters
[string] name:
The name of the group
Response Body
Returns the Permission Entity
POST /{name}/Permissions/
[string] name:
The name of the group EntityOn success this method returns a status code 2XX, on failure it returns a status code of 5XX.DELETE /{name}/Permissions/
Removes permissions from the specified group
Parameters
[string] name:
The name of the group