Groups/Regular Endpoints (2017/01)
- BrightSign TechDocs
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
filter string
An expression for filtering search results
sort string
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")
marker string
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
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
filter string
An expression for filtering search results.
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.
______________________________________________________________
Response Body
Returns the number of affected groups as an integer value.
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
filter string
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
id int
The unique identifier for the group
______________________________________________________________
Response Body
Returns the Scheduled Presentation Entity
PUT /{id:int}/
Updates the specified group on a network
Parameters
id int
The unique identifier for the group
______________________________________________________________
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
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.
______________________________________________________________
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
name string
The name of the group
______________________________________________________________
Response Body
Returns the Scheduled Presentation Entity
PUT /{name}/
Updates a group, specified by name, on the network
Parameters
name string
The name of the group
______________________________________________________________
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
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.
______________________________________________________________
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
groupId int
The unique identifier of the group
marker string
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
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 /{groupId:int}/Schedule/
Adds a scheduled presentation to the specified group
Parameters
groupId int
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.
GET /{groupName}/Schedule/
Returns a list of the scheduled presentations of the specified group
Parameters
groupName string
The name of the group
marker string
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
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 /{groupName}/Schedule/
Adds a scheduled presentation to the specified group
Parameters
groupName string
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.
GET /{groupId:int}/Schedule/{scheduledPresentationId:int}/
Returns the schedule of the specified presentation in the specified group
Parameters
groupId int
The unique identifier of the group
scheduledPresentationId int
The unique identifier for the scheduled presentation
______________________________________________________________
Response Body
Returns the Scheduled Presentation Entity
PUT /{groupId:int}/Schedule/{scheduledPresentationId:int}/
Updates the specified scheduled presentation in the specified group.
Parameters
groupId int
The unique identifier of the group
scheduledPresentationId int
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 /{groupId:int}/Schedule/{scheduledPresentationId:int}/
Removes a specified scheduled presentation from the specified group
Parameters
groupId int
The unique identifier of the group
scheduledPresentationId int
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.
GET /{groupName}/Schedule/{scheduledPresentationId:int}/
Returns the schedule of the specified presentation in the specified group
Parameters
groupName int
The name of the group
scheduledPresentationId int
The unique identifier for the scheduled presentation
______________________________________________________________
Response Body
Returns the Scheduled Presentation Entity
PUT /{groupName}/Schedule/{scheduledPresentationId:int}/
Updates the specified scheduled presentation in the specified group.
Parameters
groupName int
The name of the group
scheduledPresentationId int
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 /{groupName}/Schedule/{scheduledPresentationId:int}/
Removes the specified scheduled presentation from the specified group
Parameters
groupName int
The name of the group
scheduledPresentationId int
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.
GET /Operations/
Returns operational permissions granted to roles for specific business operations
Response Body
Returns the Business Operations Entity
GET /{id:int}/Permissions/
Includes object permissions for a given group instance.
Parameters
id int
The unique identifier for the group
______________________________________________________________
Response Body
Returns the Permission Entity
POST /{id:int}/Permissions/
Adds permissions to the specified group
Parameters
id int
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 /{id:int}/Permissions/
Removes permissions from a specified group
Parameters
id int
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.
GET /{name}/Permissions/
Includes object permissions for a given group instance.
Parameters
name string
The name of the group
______________________________________________________________
Response Body
Returns the Permission Entity
POST /{name}/Permissions/
Adds permissions to the specified group
Parameters
name string
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 /{name}/Permissions/
Removes permissions from the specified group
Parameters
name string
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.
Endpoints:
- 1 GET /
- 2 POST /
- 3 DELETE /
- 4 GET /Count/
- 5 GET /{id:int}/
- 6 PUT /{id:int}/
- 7 DELETE /{id:int}/
- 8 GET /{name}/
- 9 PUT /{name}/
- 10 DELETE /{name}/
- 11 GET /{groupId:int}/Schedule/
- 12 POST /{groupId:int}/Schedule/
- 13 GET /{groupName}/Schedule/
- 14 POST /{groupName}/Schedule/
- 15 GET /{groupId:int}/Schedule/{scheduledPresentationId:int}/
- 16 PUT /{groupId:int}/Schedule/{scheduledPresentationId:int}/
- 17 DELETE /{groupId:int}/Schedule/{scheduledPresentationId:int}/
- 18 GET /{groupName}/Schedule/{scheduledPresentationId:int}/
- 19 PUT /{groupName}/Schedule/{scheduledPresentationId:int}/
- 20 DELETE /{groupName}/Schedule/{scheduledPresentationId:int}/
- 21 GET /Operations/
- 22 GET /{id:int}/Permissions/
- 23 POST /{id:int}/Permissions/
- 24 DELETE /{id:int}/Permissions/
- 25 GET /{name}/Permissions/
- 26 POST /{name}/Permissions/
- 27 DELETE /{name}/Permissions/