Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »

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

Parameters

  • [string] filter:  An expression for filtering search results.
  • [string] sort: 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")
  • [string] marker: 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.
  • [int] pageSize: 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.

Parameters

  • [string] filter:  An expression for filtering search results.

Response Body

Returns the number of affected autorun plugins as an integer value.

Endpoints:


GET /Count/ 

Returns the number of autorun plugins on the network

Parameters

  • [string] filter:  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

Parameters

  • [int] id: A unique identifier for a plugin instance

Response Body

The Autorun Plugin Entity 

PUT /{id:int}/ 

Update a specified autorun plugin on a network

Parameters

  • [int] id: 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

Parameters

  • [int] id: 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.





  • No labels