Page Comparison

The Autoruns/Plugins endpoints allow users to manage autorun plugins on a network. 

...

bsn.api.main.autoruns.plugins.retrieve

______________________________________________________________

Query String Parameters

filter string optional

An expression for filtering search results. The default value is null.

sort string optional

An expression for sorting the search results. The sort expression specifies the entry used for sorting and the ascending/descending (ASC/DESC) sorting order (see this page for more information). The default value is null.

marker string optional

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

This parameter is only required if you need more elements in the paged list than the pageSize (100).

pageSize int optional

The maximum number of autorun plugin instances that can be contained in the response body. This defaults to the maximum allowed page size (100).

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

...

GET /2022/06/REST/Autoruns/Plugins/?marker=MjAyMy0wOC0zMVQyMDo1Nzo0Mi41MDdaLDE1Mjc3&pageSize=1&filter=%5BFileInfo%5D.%5BType%5D%20IS%20%27Stored%27%20AND%20%5BFileInfo%5D.%5BSize%5D%20IS%20GREATER%20THAN%200%20AND%20%5BFileInfo%5D.%5BName%5D%20IS%20%27*.brs%27&sort=%5BFileInfo%5D.%5BCreationDate%5D%20ASC HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate

______________________________________________________________

Success Response Body

200: 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.

...

{
   "items": [   {
      "id": 15342,
      "name": "liveTextPlugin",
      "fileInfo":       {
         "id": 15342,
         "path": "https://bsncloud.s3.amazonaws.com/bsts/9b6a47d278ad065a03ba680c345f0ea7",
         "type": "Stored",
         "name": "livetextboth.brs",
         "size": 12,
         "hash": "430CE34D020724ED75A196DFC2AD67C77772D169",
         "creationDate": "2023-09-08T15:44:01.717Z",
         "lastModifiedDate": "2023-09-08T15:44:01.717Z"
      },
      "presentations": [   {
         "id": 65425,
         "name": "GreatPresentation",
         "type": "Presentation",
         "link": null
   }],
   "totalItemCount": 4,
   "matchingItemCount": 4,
   "pageSize": 1,
   "nextMarker": "MjAyMy0wOS0wOFQxNTo0NDowMS43MTdaLDE1MzQy",
   "isTruncated": false,
   "sortExpression": "[FileInfo].[CreationDate] ASC",
   "filterExpression": "[FileInfo].[Type] IS 'Stored' AND [FileInfo].[Size] IS GREATER THAN 0 AND [FileInfo].[Name] IS '*.brs'"
}

Failure Response

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

...

bsn.api.main.autoruns.plugins.create

______________________________________________________________

Request Body

The Autorun Plugin Entity

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

...

{
	"id":0,
	"name":"liveTextPlugin",
	"fileInfo": {
		"id":0,
		"name":"livetextboth.brs",
		"type":"New",
		"body":"aGVsbG8gd29ybGQh",
		"transferEncoding":"base64",
		"size":0,
		"hash":"",
		"creationDate": "0001-01-01T00:00:00",
		"lastModifiedDate": "0001-01-01T00:00:00"
	},
	"presentations":null
}


______________________________________________________________

Success Response Body

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

...

bsn.api.main.autoruns.plugins.delete

______________________________________________________________

Query String Parameters

filter string required

An expression for filtering search results.

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

...

DELETE /2022/06/REST/Autoruns/Plugins/?filter=%5BFileInfo%5D.%5BName%5D%20IS%20%27livetextboth.brs%27 HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate

______________________________________________________________

Success Response Body

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

...

403: The supplied access token, though valid, doesn't provide access to this method 

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

...

bsn.api.main.autoruns.plugins.retrieve

______________________________________________________________

Query String Parameters

filter string optional

An expression for filtering search results. The default value is null.

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

...

GET /2022/06/REST/Autoruns/Plugins/Count/?filter=%5BFileInfo%5D.%5BType%5D%20IS%20%27Stored%27%20AND%20%5BFileInfo%5D.%5BSize%5D%20IS%20GREATER%20THAN%200%20AND%20%5BFileInfo%5D.%5BName%5D%20IS%20%27*.brs%27 HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate

______________________________________________________________

Success Response Body

200: The autorun plugin count is returned as an integer value.

...

bsn.api.main.autoruns.plugins.retrieve

______________________________________________________________

Segment

id int

A unique identifier for an autorun plugin instance

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

...

GET /2022/06/REST/Autoruns/Plugins/12345/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate

______________________________________________________________

Success Response Body

200: Returns the Autorun Plugin Entity

...

bsn.api.main.autoruns.plugins.update

______________________________________________________________

Segment

id int 

A unique identifier for an autorun plugin instance

______________________________________________________________

Request Body

The Autorun Plugin Entity

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

...

{
   "id": 0,
   "name": "liveTextPlugin",
   "fileInfo":    {
      "id": 1,
      "path": "https://bsncloud.s3.amazonaws.com/bsts/3d1a47da65ed068k76ba641c345f3dd5",
      "type": "Stored",
      "name": "plugin.brs",
      "size": 4,
      "hash": "5BF1FD927DFB8679496A2E6CF00CBE50C1C87145",
      "creationDate": "0001-01-01T00:00:00",
      "lastModifiedDate": "0001-01-01T00:00:00"
   },
   "presentations": []
}

______________________________________________________________

Success Response

204: The specified autorun plugin has been updated on the network 

...

bsn.api.main.autoruns.plugins.delete

______________________________________________________________

Segment

id int 

A unique identifier for an autorun plugin instance

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

...

DELETE /2022/06/REST/Autoruns/Plugins/12345/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate

______________________________________________________________

Success Response

204: The specified autorun plugin has been removed from the network 

...