POST /
Creates a new presentation on the network.
Required Scope Token
bsn.api.main.presentations.create
______________________________________________________________
Request Body
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
| Code Block |
|---|
POST /2022/06/REST/Presentations/ 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: 1184 |
This is the example request body:
| Code Block | ||
|---|---|---|
| ||
{
"id": 0,
"name": "BestTest",
"creationDate": "0001-01-01T00:00:00",
"lastModifiedDate": "0001-01-01T00:00:00",
"projectFile": null,
"autorun": {
"version": "10.0.98",
"isCustom": false
},
"deviceWebPage": {
"id": 2345678,
"name": "Default_PresentationWebPage"
},
"deviceModel": "HD1024",
"screenSettings": {
"videoMode": "1920x1080x60p",
"orientation": "Landscape",
"connector": "HDMI",
"backgroundColor": "RGB:000000",
"overscan": "NoOverscan"
},
"language": "English",
"status": "Draft",
"autoplayFile": null,
"resourcesFile": null,
"userDefinedEventsFile": null,
"thumbnailFile": {},
"files": [],
"autorunPlugins": null,
"applications": [],
"dependencies": [],
"groups": null,
"permissions": []
} |
______________________________________________________________
Response
Success Response Body
201: Returns the Presentation Entity created and referenced by the Uri (given by the Location header field) in the response.
Example
| Code Block | ||
|---|---|---|
| ||
{
"id": 098765,
"name": "BestTest",
"creationDate": "2023-11-08T22:37:53.9028274Z",
"lastModifiedDate": "2023-11-08T22:37:53.9028274Z",
"projectFile": null,
"autorun": {
"version": "10.0.98",
"isCustom": false
},
"deviceWebPage": {
"id": 2345678,
"name": "Default_PresentationWebPage"
},
"deviceModel": "HD1024",
"screenSettings": {
"videoMode": "1920x1080x60p",
"orientation": "Landscape",
"connector": "HDMI",
"backgroundColor": "RGB:000000",
"overscan": "NoOverscan"
},
"language": "English",
"status": "Draft",
"autoplayFile": null,
"resourcesFile": null,
"userDefinedEventsFile": null,
"thumbnailFile": null,
"files": [ {
"id": 000001,
"path": "https://bsncloud.s3.amazonaws.com/public/autoplugins.default.brs",
"type": "Stored",
"name": "autoplugins.brs",
"size": 146,
"hash": "SHA1:ABBCB3E76C85E48D326E802428B23F0325667410",
"creationDate": "2020-07-09T19:09:06.713Z",
"lastModifiedDate": "0001-01-01T00:00:00"
}],
"autorunPlugins": [],
"applications": [],
"dependencies": [],
"groups": null,
"permissions": []
} |
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: 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 server cannot return the data representation that you requested (as specified in the "Accept" header)
415: 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 string required
An expression for filtering search results
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
filteris set to[Status] IS 'Draft'
| Code Block |
|---|
DELETE /2022/06/REST/Presentations/?filter=%5BStatus%5D%20IS%20%27Draft%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 |
______________________________________________________________
Response
Success Response Body
200: 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
An expression for filtering search results. The default value is null.
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
filteris set to[LastModifiedDate] IS IN THE RANGE '2020-07-01' AND '2020-08-01'
| Code Block |
|---|
GET /2022/06/REST/Presentations/Count/?filter=%5BLastModifiedDate%5D%20IS%20IN%20THE%20RANGE%20%272020-07-01%27%20AND%20%272020-08-01%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 |
______________________________________________________________
Response
Success Response Body
200: 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 you 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
A unique identifier for the presentation
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
idis set to123456
| Code Block |
|---|
GET /2022/06/REST/Presentations/123456/ 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 with Body
200: Returns the Presentation Entity
Success Response
304: The resource was not modified since the time specified in the “If-Modified-Since” header
Example
This is an example of a 200 level response:
| Code Block | ||
|---|---|---|
| ||
{
"id": 123456,
"type": "Complete",
"name": "JaneDoeTest",
"creationDate": "2023-05-10T16:20:37.37Z",
"lastModifiedDate": "2023-11-08T22:37:53.903Z",
"projectFile": {
"id": 1234567,
"path": "https://bsncloud.s3.amazonaws.com/JaneDoeTesting/0a704ff75585f18147d83ac90d02bb8c",
"type": "Stored",
"name": "JaneDoeTest.bpfx",
"size": 36903,
"hash": "SHA1:36A3BBEC3E97F9B1C48248F7173FEE141245D122",
"creationDate": "2023-09-08T16:08:13.09Z",
"lastModifiedDate": "2023-09-08T16:08:12.523Z"
},
"autorun": {
"version": "10.0.98",
"isCustom": false
},
"deviceWebPage": {
"id": 2345678,
"name": "Default_PresentationWebPage"
},
"deviceModel": "HD1024",
"screenSettings": {
"videoMode": "1920x1080x60p",
"orientation": "Landscape",
"connector": "HDMI",
"backgroundColor": "RGB:000000",
"overscan": "NoOverscan"
},
"language": "English",
"status": "Draft",
"autoplayFile": {
"id": 12345,
"path": "https://bsncloud.s3.amazonaws.com/JaneDoeTesting/98b3a8e5f8179331bd54c5bd95178687",
"type": "Stored",
"name": "autoplay-JaneDoeTest.json",
"size": 128875,
"hash": "SHA1:BB9C850B156B799389B78F404448456A861BFD67",
"creationDate": "2023-11-08T22:37:53.903Z",
"lastModifiedDate": "2023-06-20T15:14:12.207Z"
},
"resourcesFile": {
"id": 12345,
"path": "https://bsncloud.s3.amazonaws.com/JaneDoeTesting/cd420f1f6e497e845e2b8350dda09e23",
"type": "Stored",
"name": "resources.txt",
"size": 0,
"hash": "SHA1:DA39A3BB5E6B4B0D3255BFEF95601890AFD80709",
"creationDate": "2023-05-10T16:25:06.717Z",
"lastModifiedDate": "2023-05-10T16:25:06.02Z"
},
"userDefinedEventsFile": null,
"thumbnailFile": {
"id": 12345,
"path": "https://bsncloud.s3.amazonaws.com/JaneDoeTesting/cc79c72f771fa58dac9b23788381b337",
"type": "Stored",
"name": "JaneDoeTest.thmb.jpg",
"size": 1977,
"hash": "SHA1:52G80141B47757FA2C541EBE6338FFC91EA6A52D",
"creationDate": "2023-05-11T04:15:51.913Z",
"lastModifiedDate": "2023-05-11T04:15:51.12Z"
},
"files": [ {
"id": 000001,
"path": "https://bsncloud.s3.amazonaws.com/public/autoplugins.default.brs",
"type": "Stored",
"name": "autoplugins.brs",
"size": 146,
"hash": "SHA1:A34CB3E76C85E48D326E802428B23F0325667410",
"creationDate": "2020-07-09T19:09:06.713Z",
"lastModifiedDate": "0001-01-01T00:00:00"
}],
"autorunPlugins": [],
"applications": [],
"dependencies": [],
"groups": [],
"permissions": []
} |
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
PUT /{id:int}/
Modifies the specified presentation
Required Scope Token
bsn.api.main.presentations.update
______________________________________________________________
Segment
id int
A unique identifier for the presentation
______________________________________________________________
Request Body
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
idis set to123456
| Code Block |
|---|
PUT /2022/06/REST/Presentations/123456/ 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: 1341 |
This is the example request body:
| Code Block | ||
|---|---|---|
| ||
{
"id": 123456,
"type": "Complete",
"name": "JaneDoeTest",
"creationDate": "0001-01-01T00:00:00",
"lastModifiedDate": "0001-01-01T00:00:00",
"projectFile": {
"id": 12345,
"path": null,
"type": "Stored",
"name": "JaneDoeTest.bpfx",
"size": 0,
"hash": null,
"creationDate": "0001-01-01T00:00:00",
"lastModifiedDate": "0001-01-01T00:00:00"
},
"autorun": {
"version": "10.0.98",
"isCustom": false
},
"deviceWebPage": {
"id": 2345678,
"name": "Default_PresentationWebPage"
},
"deviceModel": "HD1024",
"screenSettings": {
"videoMode": "1920x1080x60p",
"orientation": "Landscape",
"connector": "HDMI",
"backgroundColor": "RGB:000000",
"overscan": "NoOverscan"
},
"language": "English",
"status": "Draft",
"autoplayFile": {
"id": 12345,
"path": "https://bsncloud.s3.amazonaws.com/JaneDoeTesting/98b3a8e5f8179331bd54c5bd95178687",
"type": "Stored",
"name": "autoplay-JaneDoeTest.json",
"size": 128875,
"hash": "SHA1:BB9C850B156B799389B78F404448456A861BFD67",
"creationDate": "2023-11-08T22:37:53.903Z",
"lastModifiedDate": "2023-06-20T15:14:12.207Z"
},
"resourcesFile": {
"id": 12345,
"path": "https://bsncloud.s3.amazonaws.com/JaneDoeTesting/cd420f1f6e497e845e2b8350dda09e23",
"type": "Stored",
"name": "resources.txt",
"size": 0,
"hash": "SHA1:DA39A3BB5E6B4B0D3255BFEF95601890AFD80709",
"creationDate": "2023-05-10T16:25:06.717Z",
"lastModifiedDate": "2023-05-10T16:25:06.02Z"
},
"userDefinedEventsFile": null,
"thumbnailFile": {
"id": 12345,
"path": "https://bsncloud.s3.amazonaws.com/JaneDoeTesting/cc79c72f771fa58dac9b23788381b337",
"type": "Stored",
"name": "JaneDoeTest.thmb.jpg",
"size": 1977,
"hash": "SHA1:52G80141B47757FA2C541EBE6338FFC91EA6A52D",
"creationDate": "2023-05-11T04:15:51.913Z",
"lastModifiedDate": "2023-05-11T04:15:51.12Z"
},
"files": [
{ {
"mediaType": "Video",
"id": 12345,
"path": "https://bsncloud.s3.amazonaws.com/JaneDoeTesting/146bf3dd806cf10c940996c99c392a42",
"type": "Media",
"name": "New BrightWall Mockup.mp4",
"size": 14788538,
"hash": "SHA1:4271F163089C674826AECDDCD4FC6FA1B2332D66",
"creationDate": "2022-07-29T16:26:17.7Z",
"lastModifiedDate": "2022-07-26T14:58:26.57Z"
}
],
"autorunPlugins": [
{
"id": 12345,
"name": "SetMultiScreenVideoMode",
"fileInfo": {
"id": 12345,
"path": "https://bsncloud.s3.amazonaws.com/JaneDoeTesting/1d76cbeffb487d687fb8362593211e1b",
"type": "Stored",
"name": "SetMultiScreenVideoMode.brs",
"size": 2628,
"hash": "55F5B577643FBAFCF719016E04F1E458FCD2C104",
"creationDate": "2024-01-12T17:06:40.64Z",
"lastModifiedDate": "2024-01-12T17:06:40.64Z"
},
"presentations": null
}
],
"applications": [],
"dependencies": [],
"groups": null,
"permissions": []
} |
______________________________________________________________
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 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 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)
415: 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
A unique identifier for the presentation
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
idis set to123456
| Code Block |
|---|
DELETE /2022/06/REST/Presentations/123456/ 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
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 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 /{name}/
Returns the specified presentation
Required Scope Token
bsn.api.main.presentations.retrieve
______________________________________________________________
Segment
name string
The name of the presentation
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
nameis set toJaneDoeTest
| Code Block |
|---|
GET /2022/06/REST/Presentations/JaneDoeTest/ 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 with Body
200: Returns the Presentation Entity
Success Response
304: The resource was not modified since the time specified in the “If-Modified-Since” header
Example
This is an example of a 200 level response:
| Code Block | ||
|---|---|---|
| ||
{
"id": 123456,
"type": "Complete",
"name": "JaneDoeTest",
"creationDate": "2023-11-08T22:37:53.903Z",
"lastModifiedDate": "2023-11-08T22:37:53.903Z",
"projectFile": {
"id": 1234567,
"path": "https://bsncloud.s3.amazonaws.com/JaneDoeTesting/0a704ff75585f18147d83ac90d02bb8c",
"type": "Stored",
"name": "JaneDoeTest.bpfx",
"size": 36903,
"hash": "SHA1:36A3DDEC3E97F9B1C48248F7173FEE141245D122",
"creationDate": "2023-09-08T16:08:13.09Z",
"lastModifiedDate": "2023-09-08T16:08:12.523Z"
},
"autorun": {
"version": "10.0.98",
"isCustom": false
},
"deviceWebPage": {
"id": 2345678,
"name": "Default_PresentationWebPage"
},
"deviceModel": "HD1024",
"screenSettings": {
"videoMode": "1920x1080x60p",
"orientation": "Landscape",
"connector": "HDMI",
"backgroundColor": "RGB:000000",
"overscan": "NoOverscan"
},
"language": "English",
"status": "Draft",
"autoplayFile": null,
"resourcesFile": null,
"userDefinedEventsFile": null,
"thumbnailFile": {
"id": 12345,
"path": "https://bsncloud.s3.amazonaws.com/JaneDoeTesting/cc79c72f771fa58dac9b23788381b337",
"type": "Stored",
"name": "001-LeftScreen-Years.thmb.jpg",
"size": 1977,
"hash": "SHA1:52G80141B47757FA2C541EBE6338FFC91EA6A52D",
"creationDate": "2023-05-11T04:15:51.913Z",
"lastModifiedDate": "2023-05-11T04:15:51.12Z"
},
"files": [ {
"id": 000001,
"path": "https://bsncloud.s3.amazonaws.com/public/autoplugins.default.brs",
"type": "Stored",
"name": "autoplugins.brs",
"size": 146,
"hash": "SHA1:A0ACB3G96C85E48D326E802428B23F0325667410",
"creationDate": "2020-07-09T19:09:06.713Z",
"lastModifiedDate": "0001-01-01T00:00:00"
}],
"autorunPlugins": [],
"applications": [],
"dependencies": [],
"groups": [],
"permissions": []
} |
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
PUT /{name}/
Modifies the specified presentation
Required Scope Token
bsn.api.main.presentations.update
______________________________________________________________
Segment
name string
The name of the presentation
______________________________________________________________
Request Body
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
idis set to123456
| Code Block |
|---|
PUT /2022/06/REST/Presentations/123456/ 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: 1341 |
This is the example request body:
| Code Block | ||
|---|---|---|
| ||
{
"id": 123456,
"type": "Complete",
"name": "JaneDoeTest",
"creationDate": "0001-01-01T00:00:00",
"lastModifiedDate": "0001-01-01T00:00:00",
"projectFile": {
"id": 1234567,
"path": null,
"type": "Stored",
"name": "JaneDoeTest.bpfx",
"size": 0,
"hash": null,
"creationDate": "0001-01-01T00:00:00",
"lastModifiedDate": "0001-01-01T00:00:00"
},
"autorun": {
"version": "10.0.98",
"isCustom": false
},
"deviceWebPage": {
"id": 2345678,
"name": "Default_PresentationWebPage"
},
"deviceModel": "HD1024",
"screenSettings": {
"videoMode": "1920x1080x60p",
"orientation": "Landscape",
"connector": "HDMI",
"backgroundColor": "RGB:000000",
"overscan": "NoOverscan"
},
"language": "English",
"status": "Draft",
"autoplayFile": null,
"resourcesFile": null,
"userDefinedEventsFile": null,
"thumbnailFile": null,
"files": [ {
"id": 000001,
"path": null,
"type": "Stored",
"name": "autoplugins.brs",
"size": 0,
"hash": null,
"creationDate": "0001-01-01T00:00:00",
"lastModifiedDate": "0001-01-01T00:00:00"
}],
"autorunPlugins": [],
"applications": [],
"dependencies": [],
"groups": [],
"permissions": []
} |
______________________________________________________________
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 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 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)
415: 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 of the presentation
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
nameis set toJaneDoeTest
| Code Block |
|---|
DELETE /2022/06/REST/Presentations/JaneDoeTest/ 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
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 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
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
| Code Block |
|---|
GET /2022/06/REST/Presentations/Operations/ 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 the Business Operations Entity
Example
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
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 /{id:int}/Permissions/
Includes object permissions for a given presentation.
Required Scope Token
bsn.api.main.presentations.retrieve
______________________________________________________________
Segment
id int
A unique identifier for the presentation
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
idis set to987654
| Code Block |
|---|
GET /2022/06/REST/Presentations/987654/Permissions/ 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 an array of Permission entities
Example
| Code Block | ||
|---|---|---|
| ||
[
{
"entityId": 987654,
"operationUID": "840fc61a-5b1c-4362-a8e8-70d99b6fb5a4",
"principal": {
"login": "JaneDoe@brightsign.biZ",
"type": "User",
"id": 012345
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-11-13T23:56:31.11Z"
},
{
"entityId": 987654,
"operationUID": "5e368789-94d8-423e-bebb-2f5451398067",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 12345
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-11-13T23:56:31.09Z"
}
] |
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
POST /{id:int}/Permissions/
Adds permissions for the specified presentation.
Required Scope Token
bsn.api.main.presentations.update
______________________________________________________________
Segment
id int
A unique identifier for the presentation
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
idis987654
| Code Block |
|---|
POST /2022/06/REST/Presentations/987654/Permissions/ 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: 326 |
This is the example request body:
| Code Block | ||
|---|---|---|
| ||
[
{
"entityId": 987654,
"operationUID": "5e368789-94d8-423e-bebb-2f5451398067",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 12345
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-11-13T23:56:31.09Z"
}
] |
______________________________________________________________
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: 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 int
A unique identifier for the presentation
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
idis987654
| Code Block |
|---|
DELETE /2022/06/REST/Presentations/987654/Permissions/ 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: 326 |
This is the example request body:
| Code Block | ||
|---|---|---|
| ||
[
{
"entityId": 987654,
"operationUID": "5e368789-94d8-423e-bebb-2f5451398067",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 12345
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-11-13T23:56:31.09Z"
}
] |
______________________________________________________________
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 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 /{name}/Permissions/
Includes object permissions for a given presentation.
Required Scope Token
bsn.api.main.presentations.retrieve
______________________________________________________________
Segment
name string
The name of the presentation
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
nameis set toOctober2023Prez
| Code Block |
|---|
GET /2022/06/REST/Presentations/October2023Prez/Permissions/ 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 an array of Permission entities
Example
| Code Block | ||
|---|---|---|
| ||
[
{
"entityId": 123456,
"operationUID": "840fc61a-5b1c-4362-a8e8-70d99b6fb5a4",
"principal": {
"login": "JaneDoe@brightsign.biZ",
"type": "User",
"id": 012345
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-11-13T23:56:31.11Z"
},
{
"entityId": 123456,
"operationUID": "5e368789-94d8-423e-bebb-2f5451398067",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 12345
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-11-13T23:56:31.09Z"
}
] |
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
POST /{name}/Permissions/
Adds permissions for the specified presentation.
Required Scope Token
bsn.api.main.presentations.update
______________________________________________________________
Segment
name string
The name of the presentation
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
nameis set toOctober2023Prez
| Code Block |
|---|
POST /2022/06/REST/Presentations/October2023Prez/Permissions/ 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: 326 |
This is the example request body:
| Code Block | ||
|---|---|---|
| ||
[
{
"entityId": 123456,
"operationUID": "5e368789-94d8-423e-bebb-2f5451398067",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 12345
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-11-13T23:56:31.09Z"
}
] |
______________________________________________________________
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: 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 string
The name of the presentation
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
nameisOctober2023Prez
| Code Block |
|---|
DELETE /2022/06/REST/Presentations/October2023Prez/Permissions/ 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: 326 |
This is the example request body:
| Code Block | ||
|---|---|---|
| ||
[
{
"entityId": 123456,
"operationUID": "5e368789-94d8-423e-bebb-2f5451398067",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 12345
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-11-13T23:56:31.09Z"
}
] |
______________________________________________________________
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 server cannot return the data representation that you requested (as specified in the "Accept" header)
5XX: Any 500 code is an internal server error