These endpoints allow for creation, modification, and retrieval of presentation objects.
Base URL for these endpoints: https://api.bsn.cloud/2022/06/REST/Presentations
_________________________________________________________________________
Retrieves a list of presentations on the network.
Required Scope Token
bsn.api.main.presentations.retrieve
______________________________________________________________
Query String Parameters
filter string optional
An expression for filtering search results. The default value is null.
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 presentations exceeds the pageSize.
This parameter is only required if you need more elements in the paged list than the pageSize (100).
pageSize int optional
The maximum number of presentations 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 [Status] IS 'Published'
sort is set to [Name] ASC
GET /2022/06/REST/Presentations/?marker=MDAxIC0gVXBwZXIgTGVmdCBNYXN0ZXIsOTQwODI%3D&pageSize=1&filter=%5BStatus%5D%20IS%20%27Published%27&sort=%5BName%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: Returns a paged list of 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.
Example
{
"items": [ {
"id": 098765,
"type": "Complete",
"name": "001-LeftScreen-Years",
"creationDate": "2023-05-10T16:20:37.37Z",
"lastModifiedDate": "2023-06-20T15:14:13.063Z",
"projectFile": {
"id": 1234567,
"path": "https://bsncloud.s3.amazonaws.com/JaneDoeTesting/6391b7b4fa3cfd6213b053506824b940",
"type": "Stored",
"name": "001-LeftScreen-Years.bpfx",
"size": 194873,
"hash": "SHA1:9C36970CD4337F9D83D932500A173B590436F94CC",
"creationDate": "2023-06-20T15:14:12.74Z",
"lastModifiedDate": "2023-06-20T15:14:12.207Z"
},
"autorun": {
"version": "10.0.97",
"isCustom": false
},
"deviceWebPage": {
"id": 2345678,
"name": "Default_PresentationWebPage"
},
"deviceModel": "XT1144",
"screenSettings": {
"videoMode": "1920x1080x60p",
"orientation": "Landscape",
"connector": "HDMI",
"backgroundColor": "RGB:000000",
"overscan": "NoOverscan"
},
"language": "English",
"status": "Published",
"autoplayFile": {
"id": 12345,
"path": "https://bsncloud.s3.amazonaws.com/JaneDoeTesting/98b3a8e5f8179331bd54c5bd95178687",
"type": "Stored",
"name": "autoplay-001-LeftScreen-Years.json",
"size": 128875,
"hash": "SHA1:BB9C840B156B799389B78F404438456A861BFD67",
"creationDate": "2023-06-20T15:14:12.613Z",
"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:AA39B34B5E6B4B0D3255BFEF95601890AFD80709",
"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": "001-LeftScreen-Years.thmb.jpg",
"size": 1977,
"hash": "SHA1:52G80141B47757FA2C540EBE6338FFC91EA6A52D",
"creationDate": "2023-05-11T04:15:51.913Z",
"lastModifiedDate": "2023-05-11T04:15:51.12Z"
},
"files": null,
"autorunPlugins": null,
"applications": [],
"dependencies": null,
"groups": [],
"permissions": []
}],
"totalItemCount": 163,
"matchingItemCount": 110,
"pageSize": 1,
"nextMarker": "MDAxLUxlZnRTY3JlZW4tWWVhcnMsMTcyMDU4",
"prevMarker": "MDAxLUxlZnRTY3JlZW4tWWVhcnMsMTc45gh",
"isTruncated": true,
"sortExpression": "[Name] ASC",
"filterExpression": "[Status] IS 'Published'"
} |
Failure Response
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
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:
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:
{
"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": []
} |
______________________________________________________________
Success Response Body
201: Returns the Presentation Entity created and referenced by the Uri (given by the Location header field) in the response.
Example
{
"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 Response
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
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
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:
filter is set to [Status] IS 'Draft'
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 |
______________________________________________________________
Success Response Body
200: Returns the number of affected presentations as an integer value
Failure Response
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
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
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:
filter is set to [LastModifiedDate] IS IN THE RANGE '2020-07-01' AND '2020-08-01'
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 |
______________________________________________________________
Success Response Body
200: The number of presentations is returned as an integer value.
Failure Response
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
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:
id is set to 123456
The optional If-Modified-Since header value equals the Last-Modified header value retrieved from the previous GET /id or GET /name response
GET /2022/06/REST/Presentations/123456/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
If-Modified-Since: Wed, 20 Dec 2023 21:32:34 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate |
______________________________________________________________
Success Response with Body
200: Returns the Presentation Entity
Example
This is an example of a 200 level response:
{
"id": 123456,
"type": "Complete",
"name": "JaneDoeTest",
"creationDate": "2023-05-10T16:20:37.37Z",
"lastModifiedDate": "2023-12-20T21:32:35.093Z",
"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": []
} |
Success Response
304: The resource was not modified since the time specified in the “If-Modified-Since” header
Failure Response
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
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:
id is set to 123456
The optional If-Unmodified-Since header value equals the Last-Modified header value retrieved from the GET /id or GET /name response.
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
If-Unmodified-Since: Wed, 20 Dec 2023 21:32:34 GMT
Content-Type: application/json
Content-Length: 1341 |
This is the example request body:
{
"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": []
} |
______________________________________________________________
Success Response
204: The specified presentation instance was successfully updated
Failure Response
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
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
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:
id is set to 123456
The optional If-Unmodified-Since header value equals the Last-Modified header value retrieved from the GET /id or GET /name response.
DELETE /2022/06/REST/Presentations/123456/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
If-Unmodified-Since: Wed, 20 Dec 2023 21:32:34 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate |
______________________________________________________________
Success Response
204: The specified presentation was successfully deleted from the network
Failure Response
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
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
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:
name is set to JaneDoeTest
The optional If-Modified-Since header value equals the Last-Modified header value retrieved from the previous GET /id or GET /name response
GET /2022/06/REST/Presentations/JaneDoeTest/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
If-Modified-Since: Wed, 20 Dec 2023 21:32:34 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate |
______________________________________________________________
Success Response with Body
200: Returns the Presentation Entity
Example
{
"id": 123456,
"type": "Complete",
"name": "JaneDoeTest",
"creationDate": "2023-05-10T16:20:37.37Z",
"lastModifiedDate": "2023-12-20T21:32:35.093Z",
"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:DA39A3BB5E6B4A0D3255BFEF95601890AFD80709",
"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:52G80141B47857FA2C541EBE6338FFC91EA6A52D",
"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:A34CB3E76C85E58D326E802428B23F0325667410",
"creationDate": "2020-07-09T19:09:06.713Z",
"lastModifiedDate": "0001-01-01T00:00:00"
}],
"autorunPlugins": [],
"applications": [],
"dependencies": [],
"groups": [],
"permissions": []
} |
Success Response
304: The resource was not modified since the time specified in the “If-Modified-Since” header
Failure Response
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
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:
name is set to JaneDoeTest
The optional If-Unmodified-Since header value equals the Last-Modified header value retrieved from the GET /id or GET /name response.
PUT /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
If-Unmodified-Since: Wed, 20 Dec 2023 21:32:34 GMT
Content-Type: application/json
Content-Length: 1341 |
This is the example request body:
{
"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": []
} |
______________________________________________________________
Success Response
204: The specified presentation instance was successfully updated
Failure Response
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
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
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:
name is set to JaneDoeTest
The optional If-Unmodified-Since header value equals the Last-Modified header value retrieved from the GET /id or GET /name response.
DELETE /2022/06/REST/Presentations/JaneDoeTest/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
If-Unmodified-Since: Wed, 20 Dec 2023 21:32:34 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate |
______________________________________________________________
Success Response
204: The specified presentation was successfully deleted from the network
Failure Response
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
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
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:
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 |
______________________________________________________________
Success Response Body
200: Returns the Business Operations Entity
Example
|
Failure Response
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)
500: Any 500 code is an internal server error
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:
id is set to 12345
GET /2022/06/REST/Presentations/12345/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 |
______________________________________________________________
Success Response Body
200: Returns an array of Permission entities
Example
[
{
"entityId": 12345,
"operationUID": "840fc61a-5b1c-4362-a8e8-70d99b6fb5a4",
"principal": {
"login": "JaneDoe@brightsign.biZ",
"type": "User",
"id": 123
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-11-13T23:56:31.11Z"
},
{
"entityId": 12345,
"operationUID": "5e368789-94d8-423e-bebb-2f5451398067",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 456
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-11-13T23:56:31.09Z"
}
] |
Failure Response
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
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:
id is 12345
POST /2022/06/REST/Presentations/12345/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:
[
{
"entityId": 12345,
"operationUID": "5e368789-94d8-423e-bebb-2f5451398067",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 123
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "0001-01-01T00:00:00"
}
] |
______________________________________________________________
Success Response
204: The permissions were successfully added to the specified presentation
Failure Response
400: The request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules
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
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:
id is 12345
DELETE /2022/06/REST/Presentations/12345/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:
[
{
"entityId": 12345,
"operationUID": "5e368789-94d8-423e-bebb-2f5451398067",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 123
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "0001-01-01T00:00:00"
}
] |
______________________________________________________________
Success Response
204: The specified permissions were successfully deleted
Failure Response
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
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
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:
name is set to October2023Prez
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 |
______________________________________________________________
Success Response Body
200: Returns an array of Permission entities
Example
[
{
"entityId": 12345,
"operationUID": "840fc61a-5b1c-4362-a8e8-70d99b6fb5a4",
"principal": {
"login": "JaneDoe@brightsign.biZ",
"type": "User",
"id": 123
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-11-13T23:56:31.11Z"
},
{
"entityId": 12345,
"operationUID": "5e368789-94d8-423e-bebb-2f5451398067",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 456
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-11-13T23:56:31.09Z"
}
] |
Failure Response
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
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:
name is set to October2023Prez
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:
[
{
"entityId": 12345,
"operationUID": "5e368789-94d8-423e-bebb-2f5451398067",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 123
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "0001-01-01T00:00:00"
}
] |
______________________________________________________________
Success Response
204: The permissions were successfully added to the specified presentation
Failure Response
400: The request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules
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
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:
name is October2023Prez
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:
[
{
"entityId": 12345,
"operationUID": "5e368789-94d8-423e-bebb-2f5451398067",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 123
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "0001-01-01T00:00:00"
}
] |
______________________________________________________________
Success Response
204: The specified permissions were successfully deleted
Failure Response
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
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