Presentations Endpoints (2022/06)

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 string optional optional an filtering and sorting expressions in the main api docid 3l0afyd3xooe ytvfk2vs for filtering search results the default value is null sort string string optional optional an expression for sorting the search results the sort expression specifies the entry used for sorting and the ascending/descending (asc/desc) sorting order (e g " \[device] \[serial] asc ") the default value is null marker string string optional optional a value specifying which page to retrieve this value is useful if the istruncated entry in the response body of the previous get call indicates that the number of presentations exceeds the pagesize this parameter is only required if you need more elements in the paged list than the pagesize (100) pagesize int int optional 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 200 returns a paged list entity (2022/06) docid\ pwwr0ln3 binngl mr3st of presentation entity (2022/06) docid 57r8l5zhzfptus2rpv jw 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", "istruncated" true, "sortexpression" "\[name] asc", "filterexpression" "\[status] is 'published'" } failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error post / creates a new presentation on the network required scope token bsn api main presentations create request body the presentation entity (2022/06) docid 57r8l5zhzfptus2rpv jw 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 201 returns the presentation entity (2022/06) docid 57r8l5zhzfptus2rpv jw 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 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 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 string required required an filtering and sorting expressions in the main api docid 3l0afyd3xooe ytvfk2vs 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 200 returns the number of affected presentations as an integer value failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /count/ 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 string optional optional an filtering and sorting expressions in the main api docid 3l0afyd3xooe ytvfk2vs 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 200 the number of presentations is returned as an integer value failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{id\ int}/ returns the specified presentation required scope token bsn api main presentations retrieve segment id int 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 200 returns the presentation entity (2022/06) docid 57r8l5zhzfptus2rpv jw 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 304 the resource was not modified since the time specified in the “if modified since” header failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error put /{id\ int}/ modifies the specified presentation required scope token bsn api main presentations update segment id int int a unique identifier for the presentation request body the presentation entity (2022/06) docid 57r8l5zhzfptus2rpv jw 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 204 the specified presentation instance was successfully updated failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 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 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 204 the specified presentation was successfully deleted from the network failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 5xx 5xx any 500 code is an internal server error get /{name}/ returns the specified presentation required scope token bsn api main presentations retrieve segment name string 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 200 returns the presentation entity (2022/06) docid 57r8l5zhzfptus2rpv jw 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 304 the resource was not modified since the time specified in the “if modified since” header failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error put /{name}/ modifies the specified presentation required scope token bsn api main presentations update segment name string string the name of the presentation request body the presentation entity (2022/06) docid 57r8l5zhzfptus2rpv jw 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 204 the specified presentation instance was successfully updated failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 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 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 204 the specified presentation was successfully deleted from the network failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 5xx 5xx any 500 code is an internal server error get /operations/ returns the operational permissions granted to roles for specific business operations required scope token bsn api main operations retrieve 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 200 returns the business operations entity (2022/06) docid\ ei98k7oul6z5i 5b d6js example { "uid" "5e368789 94d8 423e bebb 2f5451398067", "singularname" "full control", "pluralname" "presentation (full control)", "fullname" "presentation (full control)", "targetentity" "presentation", "appliance" "instance, collection", "parent" null, "descendants" \[ { "uid" "c978aa8d c7ac 410f aec3 22e136d0ba58", "singularname" "view presentation", "pluralname" "view presentations", "fullname" "presentation (full control) view presentations", "targetentity" "presentation", "appliance" "instance, collection", "parent" { "uid" "5e368789 94d8 423e bebb 2f5451398067", "singularname" "full control", "pluralname" "presentation (full control)", "fullname" "presentation (full control)", "targetentity" "presentation", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "c978aa8d c7ac 410f aec3 22e136d0ba58", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2024 01 03t01 44 13 467z" }, { "entityid" null, "operationuid" "c978aa8d c7ac 410f aec3 22e136d0ba58", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2024 01 03t01 44 13 673z" }, { "entityid" null, "operationuid" "c978aa8d c7ac 410f aec3 22e136d0ba58", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2024 01 03t01 44 13 843z" }, { "entityid" null, "operationuid" "c978aa8d c7ac 410f aec3 22e136d0ba58", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 18z" }, { "entityid" null, "operationuid" "c978aa8d c7ac 410f aec3 22e136d0ba58", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 293z" }, { "entityid" null, "operationuid" "c978aa8d c7ac 410f aec3 22e136d0ba58", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 39z" } ] }, { "uid" "d08cf494 5a8d 45e5 99d8 0b8ec61547a0", "singularname" "view autorun plugin", "pluralname" "view autorun plugins", "fullname" "presentation (full control) view autorun plugins", "targetentity" "presentation", "appliance" "instance, collection", "parent" { "uid" "5e368789 94d8 423e bebb 2f5451398067", "singularname" "full control", "pluralname" "presentation (full control)", "fullname" "presentation (full control)", "targetentity" "presentation", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "d08cf494 5a8d 45e5 99d8 0b8ec61547a0", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2024 01 03t01 44 13 843z" }, { "entityid" null, "operationuid" "d08cf494 5a8d 45e5 99d8 0b8ec61547a0", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 18z" }, { "entityid" null, "operationuid" "d08cf494 5a8d 45e5 99d8 0b8ec61547a0", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 293z" }, { "entityid" null, "operationuid" "d08cf494 5a8d 45e5 99d8 0b8ec61547a0", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 39z" }, { "entityid" null, "operationuid" "d08cf494 5a8d 45e5 99d8 0b8ec61547a0", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 467z" }, { "entityid" null, "operationuid" "d08cf494 5a8d 45e5 99d8 0b8ec61547a0", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 673z" } ] }, { "uid" "ffea0d95 b04f 4fb9 90d2 c8d314c89cd7", "singularname" "view contents", "pluralname" "view contents", "fullname" "presentation (full control) view contents", "targetentity" "presentation", "appliance" "instance, collection", "parent" { "uid" "5e368789 94d8 423e bebb 2f5451398067", "singularname" "full control", "pluralname" "presentation (full control)", "fullname" "presentation (full control)", "targetentity" "presentation", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "ffea0d95 b04f 4fb9 90d2 c8d314c89cd7", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2024 01 03t01 44 13 843z" }, { "entityid" null, "operationuid" "ffea0d95 b04f 4fb9 90d2 c8d314c89cd7", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 18z" }, { "entityid" null, "operationuid" "ffea0d95 b04f 4fb9 90d2 c8d314c89cd7", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 293z" }, { "entityid" null, "operationuid" "ffea0d95 b04f 4fb9 90d2 c8d314c89cd7", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 39z" }, { "entityid" null, "operationuid" "ffea0d95 b04f 4fb9 90d2 c8d314c89cd7", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 467z" }, { "entityid" null, "operationuid" "ffea0d95 b04f 4fb9 90d2 c8d314c89cd7", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 673z" } ] }, { "uid" "8054f9c1 4afe 487c 921c 15e118d5e89e", "singularname" "create presentation", "pluralname" "create presentation", "fullname" "presentation (full control) create presentation", "targetentity" "presentation", "appliance" "collection", "parent" { "uid" "5e368789 94d8 423e bebb 2f5451398067", "singularname" "full control", "pluralname" "presentation (full control)", "fullname" "presentation (full control)", "targetentity" "presentation", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "8054f9c1 4afe 487c 921c 15e118d5e89e", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 18z" }, { "entityid" null, "operationuid" "8054f9c1 4afe 487c 921c 15e118d5e89e", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 293z" }, { "entityid" null, "operationuid" "8054f9c1 4afe 487c 921c 15e118d5e89e", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 39z" }, { "entityid" null, "operationuid" "8054f9c1 4afe 487c 921c 15e118d5e89e", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 467z" }, { "entityid" null, "operationuid" "8054f9c1 4afe 487c 921c 15e118d5e89e", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 673z" }, { "entityid" null, "operationuid" "8054f9c1 4afe 487c 921c 15e118d5e89e", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 843z" } ] }, { "uid" "bb823893 a8ff 49f1 8dca 63026c5e9787", "singularname" "overwrite presentation", "pluralname" "overwrite presentation", "fullname" "presentation (full control) overwrite presentation", "targetentity" "presentation", "appliance" "instance, collection", "parent" { "uid" "5e368789 94d8 423e bebb 2f5451398067", "singularname" "full control", "pluralname" "presentation (full control)", "fullname" "presentation (full control)", "targetentity" "presentation", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "bb823893 a8ff 49f1 8dca 63026c5e9787", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 18z" }, { "entityid" null, "operationuid" "bb823893 a8ff 49f1 8dca 63026c5e9787", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 293z" }, { "entityid" null, "operationuid" "bb823893 a8ff 49f1 8dca 63026c5e9787", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 39z" }, { "entityid" null, "operationuid" "bb823893 a8ff 49f1 8dca 63026c5e9787", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 467z" }, { "entityid" null, "operationuid" "bb823893 a8ff 49f1 8dca 63026c5e9787", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 673z" }, { "entityid" null, "operationuid" "bb823893 a8ff 49f1 8dca 63026c5e9787", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 843z" } ] }, { "uid" "a9db6cdb 513b 4cca a0ce 35d571c56cd6", "singularname" "update presentation", "pluralname" "update presentation", "fullname" "presentation (full control) update presentation", "targetentity" "presentation", "appliance" "instance, collection", "parent" { "uid" "5e368789 94d8 423e bebb 2f5451398067", "singularname" "full control", "pluralname" "presentation (full control)", "fullname" "presentation (full control)", "targetentity" "presentation", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[ { "uid" "f318d012 58f6 45e0 b347 a8e4418853f8", "singularname" "add autorun plugin", "pluralname" "add autorun plugin", "fullname" "presentation (full control) update presentation add autorun plugin", "targetentity" "presentation", "appliance" "instance, collection", "parent" { "uid" "a9db6cdb 513b 4cca a0ce 35d571c56cd6", "singularname" "update presentation", "pluralname" "update presentation", "fullname" "presentation (full control) update presentation", "targetentity" "presentation", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "f318d012 58f6 45e0 b347 a8e4418853f8", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 18z" }, { "entityid" null, "operationuid" "f318d012 58f6 45e0 b347 a8e4418853f8", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 293z" }, { "entityid" null, "operationuid" "f318d012 58f6 45e0 b347 a8e4418853f8", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 39z" }, { "entityid" null, "operationuid" "f318d012 58f6 45e0 b347 a8e4418853f8", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 467z" }, { "entityid" null, "operationuid" "f318d012 58f6 45e0 b347 a8e4418853f8", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 673z" }, { "entityid" null, "operationuid" "f318d012 58f6 45e0 b347 a8e4418853f8", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 843z" } ] }, { "uid" "b2defd99 0cf9 46f7 949e de9e6f5bce27", "singularname" "remove autorun plugin", "pluralname" "remove autorun plugin", "fullname" "presentation (full control) update presentation remove autorun plugin", "targetentity" "presentation", "appliance" "instance, collection", "parent" { "uid" "a9db6cdb 513b 4cca a0ce 35d571c56cd6", "singularname" "update presentation", "pluralname" "update presentation", "fullname" "presentation (full control) update presentation", "targetentity" "presentation", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "b2defd99 0cf9 46f7 949e de9e6f5bce27", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 18z" }, { "entityid" null, "operationuid" "b2defd99 0cf9 46f7 949e de9e6f5bce27", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 293z" }, { "entityid" null, "operationuid" "b2defd99 0cf9 46f7 949e de9e6f5bce27", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 39z" }, { "entityid" null, "operationuid" "b2defd99 0cf9 46f7 949e de9e6f5bce27", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 467z" }, { "entityid" null, "operationuid" "b2defd99 0cf9 46f7 949e de9e6f5bce27", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 673z" }, { "entityid" null, "operationuid" "b2defd99 0cf9 46f7 949e de9e6f5bce27", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 843z" } ] } ], "permissions" \[ { "entityid" null, "operationuid" "a9db6cdb 513b 4cca a0ce 35d571c56cd6", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 18z" }, { "entityid" null, "operationuid" "a9db6cdb 513b 4cca a0ce 35d571c56cd6", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 293z" }, { "entityid" null, "operationuid" "a9db6cdb 513b 4cca a0ce 35d571c56cd6", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 39z" }, { "entityid" null, "operationuid" "a9db6cdb 513b 4cca a0ce 35d571c56cd6", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 467z" }, { "entityid" null, "operationuid" "a9db6cdb 513b 4cca a0ce 35d571c56cd6", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 673z" }, { "entityid" null, "operationuid" "a9db6cdb 513b 4cca a0ce 35d571c56cd6", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 843z" } ] }, { "uid" "840fc61a 5b1c 4362 a8e8 70d99b6fb5a4", "singularname" "add content", "pluralname" "add content", "fullname" "presentation (full control) add content", "targetentity" "presentation", "appliance" "instance, collection", "parent" { "uid" "5e368789 94d8 423e bebb 2f5451398067", "singularname" "full control", "pluralname" "presentation (full control)", "fullname" "presentation (full control)", "targetentity" "presentation", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "840fc61a 5b1c 4362 a8e8 70d99b6fb5a4", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 18z" }, { "entityid" null, "operationuid" "840fc61a 5b1c 4362 a8e8 70d99b6fb5a4", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 293z" }, { "entityid" null, "operationuid" "840fc61a 5b1c 4362 a8e8 70d99b6fb5a4", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 39z" }, { "entityid" null, "operationuid" "840fc61a 5b1c 4362 a8e8 70d99b6fb5a4", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 467z" }, { "entityid" null, "operationuid" "840fc61a 5b1c 4362 a8e8 70d99b6fb5a4", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 673z" }, { "entityid" null, "operationuid" "840fc61a 5b1c 4362 a8e8 70d99b6fb5a4", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 843z" } ] }, { "uid" "07d6f70f daea 4baa 9fe9 522368120a1b", "singularname" "remove content", "pluralname" "remove content", "fullname" "presentation (full control) remove content", "targetentity" "presentation", "appliance" "instance, collection", "parent" { "uid" "5e368789 94d8 423e bebb 2f5451398067", "singularname" "full control", "pluralname" "presentation (full control)", "fullname" "presentation (full control)", "targetentity" "presentation", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "07d6f70f daea 4baa 9fe9 522368120a1b", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 18z" }, { "entityid" null, "operationuid" "07d6f70f daea 4baa 9fe9 522368120a1b", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 293z" }, { "entityid" null, "operationuid" "07d6f70f daea 4baa 9fe9 522368120a1b", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 39z" }, { "entityid" null, "operationuid" "07d6f70f daea 4baa 9fe9 522368120a1b", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 467z" }, { "entityid" null, "operationuid" "07d6f70f daea 4baa 9fe9 522368120a1b", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 673z" }, { "entityid" null, "operationuid" "07d6f70f daea 4baa 9fe9 522368120a1b", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 843z" } ] }, { "uid" "610d19d9 b047 bce4 7957 da89011aa3d9", "singularname" "assign presentation", "pluralname" "assign presentation", "fullname" "presentation (full control) assign presentation", "targetentity" "presentation", "appliance" "instance, collection", "parent" { "uid" "5e368789 94d8 423e bebb 2f5451398067", "singularname" "full control", "pluralname" "presentation (full control)", "fullname" "presentation (full control)", "targetentity" "presentation", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "610d19d9 b047 bce4 7957 da89011aa3d9", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" false, "isallowed" false, "creationdate" "2024 01 03t01 44 13 393z" }, { "entityid" null, "operationuid" "610d19d9 b047 bce4 7957 da89011aa3d9", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2024 01 03t01 44 13 483z" }, { "entityid" null, "operationuid" "610d19d9 b047 bce4 7957 da89011aa3d9", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 18z" }, { "entityid" null, "operationuid" "610d19d9 b047 bce4 7957 da89011aa3d9", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 293z" }, { "entityid" null, "operationuid" "610d19d9 b047 bce4 7957 da89011aa3d9", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 673z" }, { "entityid" null, "operationuid" "610d19d9 b047 bce4 7957 da89011aa3d9", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 843z" } ] }, { "uid" "9c0c314a b5e1 49c7 82b8 f27b748c1a37", "singularname" "unassign presentation", "pluralname" "unassign presentation", "fullname" "presentation (full control) unassign presentation", "targetentity" "presentation", "appliance" "instance, collection", "parent" { "uid" "5e368789 94d8 423e bebb 2f5451398067", "singularname" "full control", "pluralname" "presentation (full control)", "fullname" "presentation (full control)", "targetentity" "presentation", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "9c0c314a b5e1 49c7 82b8 f27b748c1a37", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" false, "isallowed" false, "creationdate" "2024 01 03t01 44 13 393z" }, { "entityid" null, "operationuid" "9c0c314a b5e1 49c7 82b8 f27b748c1a37", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2024 01 03t01 44 13 483z" }, { "entityid" null, "operationuid" "9c0c314a b5e1 49c7 82b8 f27b748c1a37", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 18z" }, { "entityid" null, "operationuid" "9c0c314a b5e1 49c7 82b8 f27b748c1a37", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 293z" }, { "entityid" null, "operationuid" "9c0c314a b5e1 49c7 82b8 f27b748c1a37", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 673z" }, { "entityid" null, "operationuid" "9c0c314a b5e1 49c7 82b8 f27b748c1a37", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 843z" } ] }, { "uid" "6304d004 450e c694 05e6 adc7adc3efc6", "singularname" "edit permissions", "pluralname" "edit permissions", "fullname" "presentation (full control) edit permissions", "targetentity" "presentation", "appliance" "collection", "parent" { "uid" "5e368789 94d8 423e bebb 2f5451398067", "singularname" "full control", "pluralname" "presentation (full control)", "fullname" "presentation (full control)", "targetentity" "presentation", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "6304d004 450e c694 05e6 adc7adc3efc6", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 18z" }, { "entityid" null, "operationuid" "6304d004 450e c694 05e6 adc7adc3efc6", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 293z" }, { "entityid" null, "operationuid" "6304d004 450e c694 05e6 adc7adc3efc6", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 39z" }, { "entityid" null, "operationuid" "6304d004 450e c694 05e6 adc7adc3efc6", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 467z" }, { "entityid" null, "operationuid" "6304d004 450e c694 05e6 adc7adc3efc6", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 673z" }, { "entityid" null, "operationuid" "6304d004 450e c694 05e6 adc7adc3efc6", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 843z" } ] }, { "uid" "87fd8615 7051 49c9 8ada 67b5f7fb31ae", "singularname" "delete presentation", "pluralname" "delete presentation", "fullname" "presentation (full control) delete presentation", "targetentity" "presentation", "appliance" "instance, collection", "parent" { "uid" "5e368789 94d8 423e bebb 2f5451398067", "singularname" "full control", "pluralname" "presentation (full control)", "fullname" "presentation (full control)", "targetentity" "presentation", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "87fd8615 7051 49c9 8ada 67b5f7fb31ae", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2024 01 03t01 44 13 673z" }, { "entityid" null, "operationuid" "87fd8615 7051 49c9 8ada 67b5f7fb31ae", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 18z" }, { "entityid" null, "operationuid" "87fd8615 7051 49c9 8ada 67b5f7fb31ae", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 293z" }, { "entityid" null, "operationuid" "87fd8615 7051 49c9 8ada 67b5f7fb31ae", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 39z" }, { "entityid" null, "operationuid" "87fd8615 7051 49c9 8ada 67b5f7fb31ae", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 467z" }, { "entityid" null, "operationuid" "87fd8615 7051 49c9 8ada 67b5f7fb31ae", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 843z" } ] } ], "permissions" \[ { "entityid" null, "operationuid" "5e368789 94d8 423e bebb 2f5451398067", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2024 01 03t01 44 13 18z" }, { "entityid" null, "operationuid" "5e368789 94d8 423e bebb 2f5451398067", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2024 01 03t01 44 13 293z" }, { "entityid" null, "operationuid" "5e368789 94d8 423e bebb 2f5451398067", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2024 01 03t01 44 13 39z" }, { "entityid" null, "operationuid" "5e368789 94d8 423e bebb 2f5451398067", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" false, "isallowed" false, "creationdate" "2024 01 03t01 44 13 467z" }, { "entityid" null, "operationuid" "5e368789 94d8 423e bebb 2f5451398067", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" false, "isallowed" false, "creationdate" "2024 01 03t01 44 13 673z" }, { "entityid" null, "operationuid" "5e368789 94d8 423e bebb 2f5451398067", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" false, "isallowed" false, "creationdate" "2024 01 03t01 44 13 843z" } ] } failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 500 500 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 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 200 returns an array of permission entity (2022/06) docid\ jwfymc42cdrg5jy2skysu 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 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error post /{id\ int}/permissions/ adds permissions for the specified presentation required scope token bsn api main presentations update segment id int int a unique identifier for the presentation request body an array of permission entity (2022/06) docid\ jwfymc42cdrg5jy2skysu 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 204 the permissions were successfully added to the specified presentation failure response 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 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 int a unique identifier for the presentation request body an array of permission entity (2022/06) docid\ jwfymc42cdrg5jy2skysu 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 204 the specified permissions were successfully deleted failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{name}/permissions/ includes object permissions for a given presentation required scope token bsn api main presentations retrieve segment name string 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 200 returns an array of permission entity (2022/06) docid\ jwfymc42cdrg5jy2skysu 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 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error post /{name}/permissions/ adds permissions for the specified presentation required scope token bsn api main presentations update segment name string string the name of the presentation request body an array of permission entity (2022/06) docid\ jwfymc42cdrg5jy2skysu 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 204 the permissions were successfully added to the specified presentation failure response 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 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 string the name of the presentation request body an array of permission entity (2022/06) docid\ jwfymc42cdrg5jy2skysu 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 204 the specified permissions were successfully deleted failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error