Page Comparison

These endpoints allow for creation, modification, and retrieval of presentation objects.

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

_________________________________________________________________________

GET /

Retrieves a list of presentations on the network.

Required Scope Token

bsn.api.main.presentations.retrieve

______________________________________________________________

Query String Parameters

filter string

filter string optional

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

sort string

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

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 presentations exceeds the pageSize.

This parameter is

only

only required

if

if you need more elements in the paged list than

the

the pageSize (100).

pageSize

int

int optional

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

______________________________________________________________

Response

Success Response Body

200:

Returns

Returns apaged listof Presentation Entity instances on a network. This will return not more than 100 entities along with the information necessary to return any other remaining pages.

Failure

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

The

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

The

406:

The server cannot return the data

representation that

representation that you

requested

requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

Endpoints:

Table of Contents

maxLevel	2
indent	20px
exclude	Endpoints:

POST /

Creates a new presentation on the network.

Required Scope Token

bsn.api.main.presentations.create

______________________________________________________________

Request Body

The Presentation Entity

______________________________________________________________

Response

Success Response Body

201:

Returns

Returns the Presentation Entity created and referenced by the Uri (given by the Location header field) in the response.

Failure

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

400:

Either

Either the request or request body 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

The server cannot return the data

representation that

representation that you

requested The

requested (as specified in the "Accept" header)

415:

string

The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)

5XX: Any 500 code is an internal server error

DELETE /

Removes presentations, specified by a filter, from a network. This allows multiple presentations to be deleted at once.

Required Scope Token

bsn.api.main.presentations.delete

______________________________________________________________

Query String Parameter

filter

filter string required

An expression for filtering search results

______________________________________________________________

Response

Success Response Body

200:

Returns The

Returns the number of affected presentations 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 /Count/

Retrieves the number of presentations on the network matching the specified filter criteria. If no filter is included, this call returns the total number of presentations on the network.

Required Scope Token

bsn.api.main.presentations.retrieve

______________________________________________________________

Query String Parameter

filter string optional

filter string optional

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

______________________________________________________________

Response

Success Response Body

200:

The The

The number of presentations 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

representation that you

requested

requested (as specified in the "Accept" header)

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

Returns theBusiness Operations Entity

Failure

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

400:

The

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

representation that you

requested

requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

GET /{id:int}/

Returns the specified presentation

Required Scope Token

bsn.api.main.presentations.retrieve

______________________________________________________________

Segment

id int

id int

A unique identifier for the presentation

______________________________________________________________

Response

Success Response with Body

200:

Returns the

Returns the Presentation Entity

Success Response

304: The

rThe

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

representation that you

requested

requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

PUT /{id:int}/

Modifies the specified presentation

Required Scope Token

bsn.api.main.presentations.update

______________________________________________________________

Segment

id intThe

id int

A unique identifier for the presentation

______________________________________________________________

Request Body

The Presentation Entity

______________________________________________________________

Response

Success

204: The specified presentation instance was successfully updated

Failure

300:

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

400:

Either The

Either the request or request body 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

representation that you

requested

requested (as specified in the "Accept" header)

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

415:

The

The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)

5XX: Any 500 code is an internal server error

DELETE /{id:int}/

Removes the specified presentation

Required Scope Token

bsn.api.main.presentations.delete

______________________________________________________________

Segment

id int The

id int

A unique identifier for the presentation

______________________________________________________________

Response

Success

204: The specified presentation was successfully deleted from the network

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

The server cannot return the data

representation that

representation that you

requested

requested (as specified in the "Accept" header)

412:

Precondition

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 /{name}/

Returns the specified presentation

Required Scope Token

bsn.api.main.presentations.retrieve

______________________________________________________________

Segment

name string

name string

The name of the presentation

______________________________________________________________

Response

Success Response with Body

200:

Returns the

Returns the Presentation Entity

Success Response

304: The

rThe

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

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

representation that you

requested

requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

PUT /{name}/

Modifies the specified presentation

Required Scope Token

bsn.api.main.presentations.update

______________________________________________________________

Segment

name string The

name string

The name of the presentation

______________________________________________________________

Request Body

ThePresentation Entity

______________________________________________________________

Response

Success

204: The specified presentation instance was successfully updated

Failure

300:

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

400:

Either The

Either the request or request body 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

representation that you

requested

requested (as specified in the "Accept" header)

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

415:

The

The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)

5XX: Any 500 code is an internal server error

DELETE /{name}/

Removes the specified presentation

Required Scope Token

bsn.api.main.presentations.delete

______________________________________________________________

Segment

name string The

name string

The name of the presentation

______________________________________________________________

Response

Success

204: The specified presentation was successfully deleted from the network

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

The server cannot return the data

representation that

representation that you

requested

requested (as specified in the "Accept" header)

412:

Precondition

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 /{id:int}/Permissions/

Includes object permissions for a given presentation.

Required Scope Token

bsn.api.main.presentations.retrieve

______________________________________________________________

Segment

id int

id int

A unique identifier for the presentation

______________________________________________________________

Response

Success Response Body

200:

Returns

Returns an array

of The

of Permission entities

Failure

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

400:

The

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

representation that you

requested int

requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

POST /{id:int}/Permissions/

Adds permissions for the specified presentation.

Required Scope Token

bsn.api.main.presentations.update

______________________________________________________________

Segment

id

id int

The

A unique identifier for the presentation

______________________________________________________________

Request Body

An array of Permission entities

______________________________________________________________

Response

Success

204: The permissions were successfully added to the specified presentation

Failure

400: The request or request body 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)

415:

int

The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)

5XX: Any 500 code is an internal server error

DELETE /{id:int}/Permissions/

Removes permissions for the specified presentation instance.

Required Scope Token

bsn.api.main.presentations.update

______________________________________________________________

Segment

id

id int

The

A unique identifier for the presentation

______________________________________________________________

Request Body

An array of Permission entities

______________________________________________________________

Response

Success

204: The specified permissions were successfully 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

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

The server cannot return the data

representation that

representation that you

requested

requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

GET /{name}/Permissions/

Includes object permissions for a given presentation.

Required Scope Token

bsn.api.main.presentations.retrieve

______________________________________________________________

Segment

name string

name string

The name of the presentation

______________________________________________________________

Response

Success Response Body

200:

Returns

Returns an array

of The

of Permission entities

Failure

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

400:

The

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

representation that you

requested

requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

POST /{name}/Permissions/

Adds permissions for the specified presentation.

Required Scope Token

bsn.api.main.presentations.update

______________________________________________________________

Segment

name stringThe

name string

The name of the presentation

______________________________________________________________

Request Body

An array of Permission entities

______________________________________________________________

Response

Success

204: The permissions were successfully added to the specified presentation

Failure

400: The request or request body 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)

415:

string

The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)

5XX: Any 500 code is an internal server error

DELETE /{name}/Permissions/

Removes permissions for the specified presentation.

Required Scope Token

bsn.api.main.presentations.update

______________________________________________________________

Segment

name

name string

The

The name of the presentation

______________________________________________________________

Request Body

An array of Permission entities

______________________________________________________________

Response

Success

204: The specified permissions were successfully 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

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

The server cannot return the data

representation that

representation that you

requested

requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

Page Comparison

Versions Compared

Old Version 56

New Version 57

Key

GET /

Required Scope Token

Query String Parameters

Response

Success Response Body

Failure

Endpoints:

POST /

Required Scope Token

Request Body

Response

Success Response Body

Failure

DELETE /

Required Scope Token

Query String Parameter

Response

Success Response Body

Failure

GET /Count/

Required Scope Token

Query String Parameter

Response

Success Response Body

Failure

GET /Operations/

Required Scope Token

Response

Success Response Body

Failure

GET /{id:int}/

Required Scope Token

Segment

Response

Success Response with Body

Success Response

Failure

PUT /{id:int}/

Required Scope Token

Segment

Request Body

Response

Success

Failure

DELETE /{id:int}/

Required Scope Token

Segment

Response

Success

Failure

GET /{name}/

Required Scope Token

Segment

Response

Success Response with Body

Success Response

Failure

PUT /{name}/

Required Scope Token

Segment

Request Body

Response

Success

Failure

DELETE /{name}/

Required Scope Token

Segment

Response

Success

Failure

GET /{id:int}/Permissions/

Required Scope Token

Segment

Response

Success Response Body