Autoruns/Plugins Endpoints (2022/06)

the autoruns/plugins endpoints allow users to manage autorun plugins on a network base url for this endpoint https //api bsn cloud/2022/06/rest/autoruns/plugins get / returns a list of autorun plugins on a network required scope token bsn api main autoruns plugins retrieve query string parameters filter string string optional optional an filtering and sorting expressions in the main api docid 3l0afyd3xooe ytvfk2vs for filtering search results the default value is null sort string string optional 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 filtering and sorting expressions in the main api docid 3l0afyd3xooe ytvfk2vs for more information) the default value is null marker string string optional 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 int optional 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 marker value is set to the \[pagedlist] \[nextmarker] property value from the previous bsn cloud api response pagesize is set to 1 filter is set to \[fileinfo] \[type] is 'stored' and \[fileinfo] \[size] is greater than 0 and \[fileinfo] \[name] is ' brs' sort is set to \[fileinfo] \[creationdate] asc 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 200 returns a paged list entity (2022/06) docid\ pwwr0ln3 binngl mr3st of autorun plugin entity (2022/06) docid\ p6qurv3eoh sc3xnqggem instances on a network this will return not more than 100 entities along with the information necessary to return any other remaining pages example { "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", "prevmarker" "mjaymy0wos0wofqxnto0ndowms43mtdalde1gh78", "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 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error post / create a new autorun plugin on a network required scope token bsn api main autoruns plugins create request body the autorun plugin entity (2022/06) docid\ p6qurv3eoh sc3xnqggem request example the example request parameters and headers are set as follows post /2022/06/rest/autoruns/plugins/ 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 content type application/json content length 271 this is the example request body { 	"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 201 returns the autorun plugin entity (2022/06) docid\ p6qurv3eoh sc3xnqggem created and referenced by the uri (given by the location header field) in the response example { "id" 15342, "name" "livetextplugin", "fileinfo" { "id" 15342, "path" "https //bsncloud s3 amazonaws com/bsts/9b7f49d765ad795k06ba600c345f0ea7", "type" "stored", "name" "livetextboth brs", "size" 12, "hash" "430ce34d020724ed75a196dfc2ad67c77772d169", "creationdate" "2023 09 08t15 44 01 7152901z", "lastmodifieddate" "2023 09 08t15 44 01 7152901z" }, "presentations" null } failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules (for example, the name must be unique) 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error delete / removes autorun plugins matching the specified filter expression from a network this allows multiple autorun plugins to be deleted at once required scope token bsn api main autoruns plugins delete query string parameters filter string string required required an filtering and sorting expressions in the main api docid 3l0afyd3xooe ytvfk2vs for filtering search results request example the example request parameters and headers are set as follows filter is set to \[fileinfo] \[name] is 'livetextboth brs' 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 200 returns the number of affected autorun plugins as an integer value failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /count/ returns the number of autorun plugins matching the specified filter expression in the network required scope token bsn api main autoruns plugins retrieve query string parameters filter string string optional optional an filtering and sorting expressions in the main api docid 3l0afyd3xooe ytvfk2vs for filtering search results the default value is null request example the example request parameters and headers are set as follows filter is set to \[fileinfo] \[type] is 'stored' and \[fileinfo] \[size] is greater than 0 and \[fileinfo] \[name] is ' brs' 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 200 the autorun plugin count is returned as an integer value failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{id\ int}/ returns the specified autorun plugin on a network required scope token bsn api main autoruns plugins retrieve segment id int int a unique identifier for an autorun plugin instance request example the example request parameters and headers are set as follows id is set to 12345 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 200 returns the autorun plugin entity (2022/06) docid\ p6qurv3eoh sc3xnqggem example { "id" 12345, "name" "livetextplugin", "fileinfo" { "id" 15342, "path" "https //bsncloud s3 amazonaws com/bsts/9b7f47d765ad105k06ba680c345f0ea7", "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 } ] } failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 an autorun plugin with the specified id does not exist 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error put /{id\ int}/ update a specified autorun plugin on a network required scope token bsn api main autoruns plugins update segment id int int a unique identifier for an autorun plugin instance request body the autorun plugin entity (2022/06) docid\ p6qurv3eoh sc3xnqggem request example the example request parameters and headers are set as follows id is 12345 put /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 content type application/json content length 421 this is the example request body { "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 204 the specified autorun plugin has been updated on the network failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 412 412 precondition failed (the resource/autorun plugin changed since the time specified in the “if unmodified since” header value) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error delete /{id\ int}/ remove a specified autorun plugin from a network required scope token bsn api main autoruns plugins delete segment id int int a unique identifier for an autorun plugin instance request example the example request parameters and headers are set as follows id is set to 12345 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 204 the specified autorun plugin has been removed from the network failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 5xx 5xx any 500 code is an internal server error