BrightSignNetwork (BSN) Main A...
Main REST HTTP API version 201...

Roles Endpoints (2017/01)

10min
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 entity (2017/01) docid\ yn3gu asyfisjdxgbjdvb 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 (2017/01) docid\ fwdujpp aohpf3res sz 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 (2017/01) docid\ horbsqti93 eafzzftgmy post /{id\ int}/permissions/ add permissions for specified roles on a network parameter id int a unique identifier for a role instance request body the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy 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 the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy 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 (2017/01) docid\ horbsqti93 eafzzftgmy post /{name}/permissions/ add permissions for specified roles on a network parameter name string the name of the role instance request body the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy 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 the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx