BrightSignNetwork (BSN) Main A...
Main REST HTTP API version 201...
Groups/Tagged Endpoints (2017/01)
12min
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 filter expressions in the main api (2017/01) docid\ l8mfvfdghpy9xgiuquwcm 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 list entity (2017/01) docid\ yn3gu asyfisjdxgbjdvb of tagged group entity (2017/01) docid\ ovtoxubbzrr1cuej6 wde 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 the tagged group entity (2017/01) docid\ ovtoxubbzrr1cuej6 wde 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) docid\ ovtoxubbzrr1cuej6 wde 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 filter expressions in the main api (2017/01) docid\ l8mfvfdghpy9xgiuquwcm 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 filter expressions in the main api (2017/01) docid\ l8mfvfdghpy9xgiuquwcm 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) docid\ ovtoxubbzrr1cuej6 wde put /{id\ int}/ updates the specified tagged group parameters id int the unique identifier for the tagged group request body the tagged group entity (2017/01) docid\ ovtoxubbzrr1cuej6 wde 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 the tagged group entity (2017/01) docid\ ovtoxubbzrr1cuej6 wde put /{name}/ updates the specified tagged group parameters name string the name of the tagged group request body the tagged group entity (2017/01) docid\ ovtoxubbzrr1cuej6 wde 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 entity (2017/01) docid\ fwdujpp aohpf3res sz 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 the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy post /{id\ int}/permissions/ adds permissions for a specified tagged group parameters id int the unique identifier for the tagged group 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 a specified tagged group parameters id int the unique identifier for the tagged group 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 tagged group instance parameters name string the name of the tagged group response body returns the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy post /{name}/permissions/ adds permissions for a specified tagged group parameters name string the name of the tagged group 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 a specified tagged group parameters name string the name of the tagged group 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