Web Application Endpoints (2022/06) http examples

These endpoints allow users to manage web applications on a network.

Base URL for these endpoints: https://api.bsn.cloud/2022/06/REST/WebApplications

1/5/2023: Eugene says that examples are not needed/possible for this page.

_________________________________________________________________________

GET /

Returns a list of web applications on a network

Required Scope Token

bsn.api.main.webapplications.retrieve

______________________________________________________________

Query String Parameters

pageSize int 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 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 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).

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

pageSize is set to 1
sort is set to [LastModifiedDate] DESC
marker value is set to the [PagedList].[NextMarker] property value from the previous BSN.cloud API response.

GET /2022/06/REST/WebApplications/?pageSize=1&sort=%5BLastModifiedDate%5D%20DESC 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

______________________________________________________________

Response

Success Response Body

200: Returns a paged list of Web Application Entity (2022/06) 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": [],
   "totalItemCount": 0,
   "matchingItemCount": 0,
   "pageSize": 1,
   "nextMarker": "",
   "isTruncated": false,
   "sortExpression": "[LastModifiedDate] DESC",
   "filterExpression": ""
}

Failure

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

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 required

An expression for filtering search results

______________________________________________________________

Response

Success

200: Returns the number of affected web applications, as an integer value.

Failure

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, 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: 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

GET /Count/

Returns the number of web applications on a network

Required Scope Token

bsn.api.main.webapplications.retrieve

______________________________________________________________

Query String Parameters

filter string optional

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

______________________________________________________________

Response

Success Response Body

200: The web application count is returned as an integer value.

Failure

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

GET /{applicationId}/

Returns the specified web application

Required Scope Token

bsn.api.main.webapplications.retrieve

______________________________________________________________

Segment

id int

A unique identifier for the web application

______________________________________________________________

Response

Success Response with Body

200: Returns the Web Application Entity (2022/06)

Success Response

304: The resource was not modified since the time specified in the “If-Modified-Since” header

Failure

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

404: The server cannot find the requested resource (the path does not exist)

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

DELETE /{applicationId}/

Deletes the specified web application

Required Scope Token

bsn.api.main.webapplications.delete

______________________________________________________________

Segment

id int

A unique identifier for the web application

______________________________________________________________

Response

Success

204: The specified web application was deleted

Failure

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

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: The access token is invalid or not specified

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

404: The server cannot find the requested resource (the path does not exist)

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

412: Precondition failed (the resource changed since the time specified in the “If-Unmodified-Since” header value)

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

A unique identifier for the web application

______________________________________________________________

Response

Success Response with Body

200: Returns the Web Application Entity (2022/06)

Success Response

304: The resource was not modified since the time specified in the “If-Modified-Since” header

Failure

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

404: The server cannot find the requested resource (the path does not exist)

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

DELETE /{applicationName}/

Deletes the specified web application

Required Scope Token

bsn.api.main.webapplications.delete

______________________________________________________________

Segment

name string

A unique identifier for the web application

______________________________________________________________

Response

Success

204: The specified web application was deleted

Failure

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

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: The access token is invalid or not specified

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

404: The server cannot find the requested resource (the path does not exist)

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

412: Precondition failed (the resource changed since the time specified in the “If-Unmodified-Since” header value)

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

______________________________________________________________

Response

Success Response Body

200: Returns the list of associated Business Operations entities

Failure

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