Roles Endpoints (2017/01)
- BrightSign TechDocs
These endpoints allow users to manage roles on a network.
Base URL for these endpoints: https://api.brightsignnetwork.com/2017/01/REST/Roles
GET /
Returns a list of roles on a network
Parameters
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 role instances exceeds the pageSize.
pageSize int
The maximum number of role instances that can be contained in the response body
______________________________________________________________
Response Body
Returns a paged list of Role 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 role on a network
Request Body
The Role 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 Role Entity.
GET /{id:int}/
Returns a list of roles on a network
Parameters
id int
A unique identifier for a role instance
______________________________________________________________
Response Body
Returns the Role Entity
PUT /{id:int}/
Updates a role on a network
Parameter
id int
A unique identifier for a role instance
______________________________________________________________
Request Body
The Role 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 a role on a network
Parameter
id int
A unique identifier for a role instance
______________________________________________________________
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
GET /{name}/
Returns a list of roles on a network
Parameters
name string
The name of the role instance
______________________________________________________________
Response Body
Returns the Role Entity
PUT /{name}/
Updates a role on a network
Parameter
name string
The name of the role instance
______________________________________________________________
Request Body
The Role 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 role from a network
Parameter
name string
The name of the role instance
______________________________________________________________
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 role instance.
Parameter
id int
A unique identifier for a role instance
______________________________________________________________
Response Body
Returns the Permission Entity
POST /{id:int}/Permissions/
Add permissions for specified roles on a network
Parameter
id int
A unique identifier for a role instance
______________________________________________________________
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 specified roles on a network
Parameter
id int
A unique identifier for a role instance
______________________________________________________________
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 role instance.
Parameter
name string
The name of the role instance
______________________________________________________________
Response Body
Returns the Permission Entity
POST /{name}/Permissions/
Add permissions for specified roles on a network
Parameter
name string
The name of the role instance
______________________________________________________________
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 specified role on a network
Parameter
name string
The name of the role instance
______________________________________________________________
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 GET /{id:int}/
- 4 PUT /{id:int}/
- 5 DELETE /{id:int}/
- 6 GET /{name}/
- 7 PUT /{name}/
- 8 DELETE /{name}/
- 9 GET /Operations/
- 10 GET /{id:int}/Permissions/
- 11 POST /{id:int}/Permissions/
- 12 DELETE /{id:int}/Permissions/
- 13 GET /{name}/Permissions/
- 14 POST /{name}/Permissions/
- 15 DELETE /{name}/Permissions/