Web Application Endpoints (2022/06)

these endpoints allow users to manage web applications on a network base url for these endpoints https //api bsn cloud/2022/06/rest/webapplications get / returns a list of web applications on a network required scope token bsn api main webapplications retrieve query string parameters pagesize int int optional optional the maximum number of web application instances that can be contained in the response body this defaults to the maximum allowed page size (100) 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 (e g " \[device] \[serial] asc ") 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 web application instances exceeds the pagesize this parameter is only required if you need more elements in the paged list than the pagesize (100) success response body 200 200 returns a paged list entity (2022/06) docid\ pwwr0ln3 binngl mr3st of web application entity (2022/06) docid\ zpezy9vbwrq 9z8hvx10e instances on a network this will return not more than 100 entities along with the information necessary to return any other remaining pages 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 delete / deletes web applications, specified by a filter, on a network this allows multiple web applications to be deleted at once required scope token bsn api main webapplications delete query string parameter filter string string required required an filtering and sorting expressions in the main api docid 3l0afyd3xooe ytvfk2vs for filtering search results success response 200 200 returns the number of affected web applications, 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, or it is rejected in accordance with the business rules for example, you cannot delete a web application that is in use by a presentation 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 web applications on a network required scope token bsn api main webapplications 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 success response body 200 200 the web application 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 /{applicationid}/ returns the specified web application required scope token bsn api main webapplications retrieve segment id int int a unique identifier for the web application success response with body 200 200 returns the web application entity (2022/06) docid\ zpezy9vbwrq 9z8hvx10e success response 304 304 the resource was not modified since the time specified in the “if modified since” header 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 the server cannot find the requested resource (the path 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 delete /{applicationid}/ deletes the specified web application required scope token bsn api main webapplications delete segment id int int a unique identifier for the web application success response 204 204 the specified web application was deleted 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, you cannot delete a web application that is in use by a presentation 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 (the path does not exist) 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 get /{applicationname}/ returns the specified web application required scope token bsn api main webapplications retrieve segment name string string a unique identifier for the web application success response with body 200 200 returns the web application entity (2022/06) docid\ zpezy9vbwrq 9z8hvx10e success response 304 304 the resource was not modified since the time specified in the “if modified since” header 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 the server cannot find the requested resource (the path 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 delete /{applicationname}/ deletes the specified web application required scope token bsn api main webapplications delete segment name string string a unique identifier for the web application success response 204 204 the specified web application was deleted 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, you cannot delete a web application that is in use by a presentation 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 (the path does not exist) 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 get /operations/ returns the operational permissions granted to roles for specific business operations required scope token bsn api main operations retrieve success response body 200 200 returns the list of associated business operations entity (2022/06) docid\ ei98k7oul6z5i 5b d6js entities 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