Autoruns/Plugins Endpoints (2017/01)

These endpoints allow users to manage autorun plugins on a network. 

Base URL for these endpoints:  https://api.brightsignnetwork.com/2017/01/REST/Autoruns/Plugins

GET /

Returns a list of autorun plugins on a network

Query String 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. "[Device].[Serial] ASC")

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 plugin instances exceeds the pageSize.

pageSize int

The maximum number of plugin instances that can be contained in the response body

______________________________________________________________

Response Body

Returns a paged list of Autorun Plugin 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 new autorun plugin on a network.

Request Body

The Autorun Plugin Entity

______________________________________________________________

Response Body

Returns a 201 status code and the Autorun Plugin Entity created and referenced by the Uri (given by the Location header field) in the response. 

DELETE /

Removes autorun plugins, specified by a filter, from a network. This allows multiple autorun plugins to be deleted at once.

Query String Parameters

filter string

An expression for filtering search results

______________________________________________________________

Response Body

Returns the number of affected autorun plugins as an integer value

GET /Count/ 

Returns the number of autorun plugins on the network

Query String Parameters

filter string

An expression for filtering search results

______________________________________________________________

Response 

The autorun plugin count is returned as an integer value.

GET /{id:int}/ 

Returns the specified autorun plugin on a network

Segment

id int

A unique identifier for a plugin instance

______________________________________________________________

Response Body

The Autorun Plugin Entity 

PUT /{id:int}/ 

Update a specified autorun plugin on a network

Segment

id int 

A unique identifier for a plugin instance

______________________________________________________________

Request Body

The Autorun Plugin Entity 

______________________________________________________________

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX

DELETE /{id:int}/ 

Remove a specified autorun plugin from a network

Segment

id int

A unique identifier for a plugin instance

______________________________________________________________

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.