Groups/Tagged Endpoints (2017/01)
Use these endpoints to manage tagged groups on the network.
Base URL for these endpoints: https://api.brightsignnetwork.com/2017/01/REST/Groups/Tagged
GET /
Retrieves a list of tagged groups on the network
Parameters
filter string
An expressionexpression 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 tagged group instances exceeds the pageSize.
pageSize int
The maximum number of tagged group instances that can be contained in the response body
______________________________________________________________
Response Body
Returns a paged listpaged list of Tagged Group Entity (2017/01) 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 tagged group on a network
Request Body
______________________________________________________________
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 Tagged Group Entity (2017/01).
DELETE /
Removes tagged groups, specified by a filter, from a network. This allows multiple tagged groups to be deleted at once.
Parameters
filter string
An expressionexpression for filtering search results
______________________________________________________________
Response Body
Returns the number of affected tagged groups as an integer value.
GET /Count/
Returns the number of tagged groups on the network that match the specified filter criteria. If no filter is included, this call returns the total number of tagged groups on the network.
Parameters
filter string
An expressionexpression for filtering search results
______________________________________________________________
Response Body
The number of tagged groups is returned as an integer value.
GET /{id:int}/
Returns the specified tagged group
Parameters
id int
The unique identifier for the tagged group
______________________________________________________________
Response Body
Returns the Tagged Group Entity (2017/01)
PUT /{id:int}/
Updates the specified tagged group
Parameters
id int
The unique identifier for the tagged 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}/
Deletes a specified tagged group on a network.
Parameters
id int
The unique identifier of the tagged group
______________________________________________________________
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
GET /{name}/
Returns the specified tagged group
Parameters
name string
The name of the tagged group
______________________________________________________________
Response Body
PUT /{name}/
Updates the specified tagged group
Parameters
name string
The name of the tagged 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}/
Deletes a specified tagged group on a network.
Parameters
name string
The name of the tagged group
______________________________________________________________
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 EntityBusiness Operations Entity
GET /{id:int}/Permissions/
Includes object permissions for a given tagged group instance.
Parameters
id int
The unique identifier for the tagged group
______________________________________________________________
Response Body
POST /{id:int}/Permissions/
Adds permissions for a specified tagged group
Parameters
id int
The unique identifier for the tagged 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 for a specified tagged group
Parameters
id int
The unique identifier for the tagged 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 tagged group instance.
Parameters
name string
The name of the tagged group
______________________________________________________________
Response Body
Returns the Permission Entity (2017/01)
POST /{name}/Permissions/
Adds permissions for a specified tagged group
Parameters
name string
The name of the tagged 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 for a specified tagged group
Parameters
name string
The name of the tagged group
______________________________________________________________
Request Body
______________________________________________________________
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.