Feeds/Text Endpoints (2022/06)

use these endpoints to manage live text feeds on the network base url for these endpoints https //api bsn cloud/2022/06/rest/feeds/text get / returns a list of live text feeds on a network required scope token bsn api main feeds text 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 (see filtering and sorting expressions in the main api docid 3l0afyd3xooe ytvfk2vs for more information) 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 text feed instances 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 text feed instances 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 \[creationdate] is not in the range '2000 01 01' and '2022 01 01' sort is set to \[filesize] asc get /2022/06/rest/feeds/text/?marker=oduzldcymje4mti%3d\&pagesize=1\&filter=%5bcreationdate%5d%20is%20not%20in%20the%20range%20%272000 01 01%27%20and%20%272022 01 01%27\&sort=%5bfilesize%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 live text feed entity (2022/06) docid\ hhgjxstoeddczmqbyn014 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" 1234567, "name" "menu items", "physicalpath" "https //bsncloud s3 amazonaws com/contentcloud/feeds/3ddd24eaf9b2307852636dc45269f242", "filesize" 1086, "filehash" "sha1\ a578287bfbbd89c1663100042gf2c057c273f43f", "creationdate" "2023 03 09t16 30 26 383z", "lastmodifieddate" "2023 03 09t16 50 24 883z", "items" null, "presentations" \[ { "id" 12345, "name" "all set presentation", "type" "presentation", "link" null } ], "permissions" \[] } ], "totalitemcount" 2, "matchingitemcount" 2, "pagesize" 1, "nextmarker" "mta4niw3mjmwoty3", "prevmarker" "mta4niw3mjmwn1rt", "istruncated" false, "sortexpression" "\[filesize] asc", "filterexpression" "\[creationdate] is not in the range '2000 01 01t00 00 00 000z' and '2022 01 01t00 00 00 000z'" } 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 live text feed on a network required scope token bsn api main feeds text create request body the live text feed entity (2022/06) docid\ hhgjxstoeddczmqbyn014 request example the example request parameters and headers are set as follows post /2022/06/rest/feeds/text/ 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 389 this is the example request body { "id" 0, "name" "breakfast menu", "physicalpath" null, "filesize" 0, "filehash" null, "creationdate" "0001 01 01t00 00 00", "lastmodifieddate" "0001 01 01t00 00 00", "items" \[ { "title" "hamburger $9 99", "description" "ground chuck, onion, worcestershire sauce & seasonings ", "validitystartdate" "2023 11 01t00 00 00z", "validityenddate" "2023 12 01t00 00 00z" } ], "presentations" null, "permissions" \[] } success response body 201 201 returns the live text feed entity (2022/06) docid\ hhgjxstoeddczmqbyn014 created and referenced by the uri (given by the location header field) in the response example { "id" 2345678, "name" "price list", "physicalpath" "https //bsncloud s3 amazonaws com/janedoetesting/feeds/d1df209dfa240a5e5e74657c76f46cf3", "filesize" 159, "filehash" "sha1 5be7edb6a8fbhaa23894114c185cd8afd9a8e279", "creationdate" "2023 10 06t19 43 47 597z", "lastmodifieddate" "2023 10 06t19 43 47 597z", "items" \[ { "title" "hamburger $9 99", "description" "ground chuck, onion, worcestershire sauce & seasonings ", "validitystartdate" "2023 11 01t00 00 00z", "validityenddate" "2023 12 01t00 00 00z" } ], "presentations" \[], "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 live text feed instances, specified by a filter, from a network this allows multiple live text feed instances to be deleted at once required scope token bsn api main feeds text 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 \[name] is 'price list' delete /2022/06/rest/feeds/text/?filter=%5bname%5d%20is%20%27price list%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 live text feeds 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/ returns the number of live text feeds on the network that match the specified filter criteria if no filter is included, this call returns the total number of live text feeds on the network required scope token bsn api main feeds text 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 request example the example request parameters and headers are set as follows filter is set to \[name] contains 'test' get /2022/06/rest/feeds/text/count/?filter=%20%5bname%5d%20contains%20%27test%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 live text feeds 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 live text feeds instance required scope token bsn api main feeds text retrieve segment id int int a unique identifier for the live text feed instance request example the example request parameters and headers are set as follows id is set to 234567 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/feeds/text/234567/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} if modified since wed, 3 jan 2024 20 33 34 gmt accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response with body 200 200 returns the live text feed entity (2022/06) docid\ hhgjxstoeddczmqbyn014 example this is a 200 response example { "id" 234567, "name" "test2", "physicalpath" "https //bsncloud s3 amazonaws com/johndoetesting/feeds/f2a442416bd2c6876bf16a19f8d21457", "filesize" 161, "filehash" "sha1 85f4b1a9f50c55631e8398ea68467b34eff00e8c", "creationdate" "2023 10 24t17 50 40 237z", "lastmodifieddate" "2024 01 03t20 33 35 093z", "items" \[], "presentations" \[], "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 live text feed instance required scope token bsn api main feeds text update segment id int int a unique identifier for the live text feed instance request body the live text feed entity (2022/06) docid\ hhgjxstoeddczmqbyn014 request example the example request parameters and headers are set as follows id is set to 12345 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/feeds/text/12345/ 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, 3 jan 2024 20 33 34 gmt content type application/json content length 398 this is the example request body { "id" 0, "name" "breakfast menu", "physicalpath" null, "filesize" 0, "filehash" null, "creationdate" "0001 01 01t00 00 00", "lastmodifieddate" "0001 01 01t00 00 00", "items" \[ { "title" "hamburger $9 99", "description" "ground chuck, onion, worcestershire sauce & seasonings ", "validitystartdate" "2023 11 01t00 00 00z", "validityenddate" "2023 12 01t00 00 00z" } ], "presentations" null, "permissions" \[] } success response 204 204 the specified live text feed instance has been 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/live text feed instance 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 live text feed instance required scope token bsn api main feeds text delete segment id int int a unique identifier for the live text feed instance request example the example request parameters and headers are set as follows id is set to 12345 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/feeds/text/12345/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} if unmodified since wed, 3 jan 2024 20 33 34 gmt accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response 204 204 the specified live text feed has been 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) 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 live text feeds instance required scope token bsn api main feeds text retrieve segment name string string the name of the live text feed instance request example the example request parameters and headers are set as follows name is set to newsfeed 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/feeds/text/newsfeed/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} if modified since wed, 3 jan 2024 20 33 34 gmt accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response with body 200 200 returns the live text feed entity (2022/06) docid\ hhgjxstoeddczmqbyn014 example this is a 200 response example { "id" 12345, "name" "newsfeed", "physicalpath" "https //bsncloud s3 amazonaws com/johndoetesting/feeds/f8a442416bd2c6876bf16a19f8d21457", "filesize" 161, "filehash" "sha1 85f4b1a9f50c45631e8398ea68497b34e0f00e8c", "creationdate" "2023 10 24t17 50 40 237z", "lastmodifieddate" "2023 10 24t17 50 40 237z", "items" \[], "presentations" \[], "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 live text feed instance required scope token bsn api main feeds text update segment name string string the name of the live text feed instance request body the live text feed entity (2022/06) docid\ hhgjxstoeddczmqbyn014 request example the example request parameters and headers are set as follows name is set to newsfeed 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/feeds/text/newsfeed/ 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, 3 jan 2024 20 33 34 gmt content type application/json content length 398 this is the example request body { "id" 0, "name" "breakfast menu", "physicalpath" null, "filesize" 0, "filehash" null, "creationdate" "0001 01 01t00 00 00", "lastmodifieddate" "0001 01 01t00 00 00", "items" \[ { "title" "hamburger $9 99", "description" "ground chuck, onion, worcestershire sauce & seasonings ", "validitystartdate" "2023 11 01t00 00 00z", "validityenddate" "2023 12 01t00 00 00z" } ], "presentations" null, "permissions" \[] } success response 204 204 the specified live text feed instance has been 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/live text feed instance 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 live text feed instance required scope token bsn api main feeds text delete segment name string string the name of the live text feed instance request example the example request parameters and headers are set as follows name is set to newsfeed 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/feeds/text/newsfeed/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} if unmodified since wed, 3 jan 2024 20 33 34 gmt accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response 204 204 the specified live text feed has been 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) 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 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/feeds/text/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" "5ef4d2e0 3abc 4f3d aa8f d1bbddace601", "singularname" "full control", "pluralname" "livetext feed (full control)", "fullname" "livetext feed (full control)", "targetentity" "livetextfeed", "appliance" "instance, collection", "parent" null, "descendants" \[ { "uid" "cfbcdcf2 3de5 40c0 843f d003942910ef", "singularname" "view livetext feed", "pluralname" "view livetext feeds", "fullname" "livetext feed (full control) view livetext feeds", "targetentity" "livetextfeed", "appliance" "instance, collection", "parent" { "uid" "5ef4d2e0 3abc 4f3d aa8f d1bbddace601", "singularname" "full control", "pluralname" "livetext feed (full control)", "fullname" "livetext feed (full control)", "targetentity" "livetextfeed", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "cfbcdcf2 3de5 40c0 843f d003942910ef", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 08 17t20 49 47 293z" }, { "entityid" null, "operationuid" "cfbcdcf2 3de5 40c0 843f d003942910ef", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 08 17t20 49 47 75z" }, { "entityid" null, "operationuid" "cfbcdcf2 3de5 40c0 843f d003942910ef", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 45 877z" }, { "entityid" null, "operationuid" "cfbcdcf2 3de5 40c0 843f d003942910ef", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 46 17z" }, { "entityid" null, "operationuid" "cfbcdcf2 3de5 40c0 843f d003942910ef", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 46 437z" }, { "entityid" null, "operationuid" "cfbcdcf2 3de5 40c0 843f d003942910ef", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 46 737z" }, { "entityid" null, "operationuid" "cfbcdcf2 3de5 40c0 843f d003942910ef", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 10498 }, "isfixed" false, "isinherited" true, "isallowed" false, "creationdate" "2023 10 05t22 24 13 54z" } ] }, { "uid" "9317fb13 2e9d 4a67 a2b7 075b63dcaf80", "singularname" "view contents", "pluralname" "view contents", "fullname" "livetext feed (full control) view contents", "targetentity" "livetextfeed", "appliance" "instance, collection", "parent" { "uid" "5ef4d2e0 3abc 4f3d aa8f d1bbddace601", "singularname" "full control", "pluralname" "livetext feed (full control)", "fullname" "livetext feed (full control)", "targetentity" "livetextfeed", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "9317fb13 2e9d 4a67 a2b7 075b63dcaf80", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 08 17t20 49 47 76z" }, { "entityid" null, "operationuid" "9317fb13 2e9d 4a67 a2b7 075b63dcaf80", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 45 877z" }, { "entityid" null, "operationuid" "9317fb13 2e9d 4a67 a2b7 075b63dcaf80", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 46 17z" }, { "entityid" null, "operationuid" "9317fb13 2e9d 4a67 a2b7 075b63dcaf80", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 46 437z" }, { "entityid" null, "operationuid" "9317fb13 2e9d 4a67 a2b7 075b63dcaf80", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 46 737z" }, { "entityid" null, "operationuid" "9317fb13 2e9d 4a67 a2b7 075b63dcaf80", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 47 28z" }, { "entityid" null, "operationuid" "9317fb13 2e9d 4a67 a2b7 075b63dcaf80", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 10498 }, "isfixed" false, "isinherited" true, "isallowed" false, "creationdate" "2023 10 05t22 24 13 54z" } ] }, { "uid" "3f5bab69 4c56 4c63 8c56 679160296451", "singularname" "create livetext feed", "pluralname" "create livetext feed", "fullname" "livetext feed (full control) create livetext feed", "targetentity" "livetextfeed", "appliance" "collection", "parent" { "uid" "5ef4d2e0 3abc 4f3d aa8f d1bbddace601", "singularname" "full control", "pluralname" "livetext feed (full control)", "fullname" "livetext feed (full control)", "targetentity" "livetextfeed", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "3f5bab69 4c56 4c63 8c56 679160296451", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 45 877z" }, { "entityid" null, "operationuid" "3f5bab69 4c56 4c63 8c56 679160296451", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 46 17z" }, { "entityid" null, "operationuid" "3f5bab69 4c56 4c63 8c56 679160296451", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 46 437z" }, { "entityid" null, "operationuid" "3f5bab69 4c56 4c63 8c56 679160296451", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 46 737z" }, { "entityid" null, "operationuid" "3f5bab69 4c56 4c63 8c56 679160296451", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 47 28z" }, { "entityid" null, "operationuid" "3f5bab69 4c56 4c63 8c56 679160296451", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 47 737z" }, { "entityid" null, "operationuid" "3f5bab69 4c56 4c63 8c56 679160296451", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 10498 }, "isfixed" false, "isinherited" true, "isallowed" false, "creationdate" "2023 10 05t22 24 13 54z" } ] }, { "uid" "00886ffd 19f7 40dc 837e e8d06d8a2779", "singularname" "rename livetext feed", "pluralname" "rename livetext feed", "fullname" "livetext feed (full control) rename livetext feed", "targetentity" "livetextfeed", "appliance" "instance, collection", "parent" { "uid" "5ef4d2e0 3abc 4f3d aa8f d1bbddace601", "singularname" "full control", "pluralname" "livetext feed (full control)", "fullname" "livetext feed (full control)", "targetentity" "livetextfeed", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "00886ffd 19f7 40dc 837e e8d06d8a2779", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 45 877z" }, { "entityid" null, "operationuid" "00886ffd 19f7 40dc 837e e8d06d8a2779", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 46 17z" }, { "entityid" null, "operationuid" "00886ffd 19f7 40dc 837e e8d06d8a2779", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 46 437z" }, { "entityid" null, "operationuid" "00886ffd 19f7 40dc 837e e8d06d8a2779", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 46 737z" }, { "entityid" null, "operationuid" "00886ffd 19f7 40dc 837e e8d06d8a2779", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 47 28z" }, { "entityid" null, "operationuid" "00886ffd 19f7 40dc 837e e8d06d8a2779", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 47 737z" }, { "entityid" null, "operationuid" "00886ffd 19f7 40dc 837e e8d06d8a2779", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 10498 }, "isfixed" false, "isinherited" true, "isallowed" false, "creationdate" "2023 10 05t22 24 13 54z" } ] }, { "uid" "376563fa 72b4 471a 9d49 1f4de927dc20", "singularname" "update livetext feed", "pluralname" "update livetext feed", "fullname" "livetext feed (full control) update livetext feed", "targetentity" "livetextfeed", "appliance" "instance, collection", "parent" { "uid" "5ef4d2e0 3abc 4f3d aa8f d1bbddace601", "singularname" "full control", "pluralname" "livetext feed (full control)", "fullname" "livetext feed (full control)", "targetentity" "livetextfeed", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "376563fa 72b4 471a 9d49 1f4de927dc20", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 45 877z" }, { "entityid" null, "operationuid" "376563fa 72b4 471a 9d49 1f4de927dc20", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 46 17z" }, { "entityid" null, "operationuid" "376563fa 72b4 471a 9d49 1f4de927dc20", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 46 437z" }, { "entityid" null, "operationuid" "376563fa 72b4 471a 9d49 1f4de927dc20", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 46 737z" }, { "entityid" null, "operationuid" "376563fa 72b4 471a 9d49 1f4de927dc20", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 47 28z" }, { "entityid" null, "operationuid" "376563fa 72b4 471a 9d49 1f4de927dc20", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 47 737z" }, { "entityid" null, "operationuid" "376563fa 72b4 471a 9d49 1f4de927dc20", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 10498 }, "isfixed" false, "isinherited" true, "isallowed" false, "creationdate" "2023 10 05t22 24 13 54z" } ] }, { "uid" "6158bf49 cd2a 499c 8e9c 938953e4c3c6", "singularname" "assign livetext feed", "pluralname" "assign livetext feed", "fullname" "livetext feed (full control) assign livetext feed", "targetentity" "livetextfeed", "appliance" "instance, collection", "parent" { "uid" "5ef4d2e0 3abc 4f3d aa8f d1bbddace601", "singularname" "full control", "pluralname" "livetext feed (full control)", "fullname" "livetext feed (full control)", "targetentity" "livetextfeed", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "6158bf49 cd2a 499c 8e9c 938953e4c3c6", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 45 877z" }, { "entityid" null, "operationuid" "6158bf49 cd2a 499c 8e9c 938953e4c3c6", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 46 17z" }, { "entityid" null, "operationuid" "6158bf49 cd2a 499c 8e9c 938953e4c3c6", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 46 437z" }, { "entityid" null, "operationuid" "6158bf49 cd2a 499c 8e9c 938953e4c3c6", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 46 737z" }, { "entityid" null, "operationuid" "6158bf49 cd2a 499c 8e9c 938953e4c3c6", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 47 28z" }, { "entityid" null, "operationuid" "6158bf49 cd2a 499c 8e9c 938953e4c3c6", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 47 737z" }, { "entityid" null, "operationuid" "6158bf49 cd2a 499c 8e9c 938953e4c3c6", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 10498 }, "isfixed" false, "isinherited" true, "isallowed" false, "creationdate" "2023 10 05t22 24 13 54z" } ] }, { "uid" "39cfe670 819e 4d8a 8151 886ae675a6ac", "singularname" "unassign livetext feed", "pluralname" "unassign livetext feed", "fullname" "livetext feed (full control) unassign livetext feed", "targetentity" "livetextfeed", "appliance" "instance, collection", "parent" { "uid" "5ef4d2e0 3abc 4f3d aa8f d1bbddace601", "singularname" "full control", "pluralname" "livetext feed (full control)", "fullname" "livetext feed (full control)", "targetentity" "livetextfeed", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "39cfe670 819e 4d8a 8151 886ae675a6ac", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 45 877z" }, { "entityid" null, "operationuid" "39cfe670 819e 4d8a 8151 886ae675a6ac", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 46 17z" }, { "entityid" null, "operationuid" "39cfe670 819e 4d8a 8151 886ae675a6ac", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 46 437z" }, { "entityid" null, "operationuid" "39cfe670 819e 4d8a 8151 886ae675a6ac", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 46 737z" }, { "entityid" null, "operationuid" "39cfe670 819e 4d8a 8151 886ae675a6ac", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 47 28z" }, { "entityid" null, "operationuid" "39cfe670 819e 4d8a 8151 886ae675a6ac", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 47 737z" }, { "entityid" null, "operationuid" "39cfe670 819e 4d8a 8151 886ae675a6ac", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 10498 }, "isfixed" false, "isinherited" true, "isallowed" false, "creationdate" "2023 10 05t22 24 13 54z" } ] }, { "uid" "17feee4d fc87 443a aef9 e2aa297768f5", "singularname" "edit permissions", "pluralname" "edit permissions", "fullname" "livetext feed (full control) edit permissions", "targetentity" "livetextfeed", "appliance" "collection", "parent" { "uid" "5ef4d2e0 3abc 4f3d aa8f d1bbddace601", "singularname" "full control", "pluralname" "livetext feed (full control)", "fullname" "livetext feed (full control)", "targetentity" "livetextfeed", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "17feee4d fc87 443a aef9 e2aa297768f5", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 45 877z" }, { "entityid" null, "operationuid" "17feee4d fc87 443a aef9 e2aa297768f5", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 46 17z" }, { "entityid" null, "operationuid" "17feee4d fc87 443a aef9 e2aa297768f5", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 46 437z" }, { "entityid" null, "operationuid" "17feee4d fc87 443a aef9 e2aa297768f5", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 46 737z" }, { "entityid" null, "operationuid" "17feee4d fc87 443a aef9 e2aa297768f5", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 47 28z" }, { "entityid" null, "operationuid" "17feee4d fc87 443a aef9 e2aa297768f5", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 47 737z" }, { "entityid" null, "operationuid" "17feee4d fc87 443a aef9 e2aa297768f5", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 10498 }, "isfixed" false, "isinherited" true, "isallowed" false, "creationdate" "2023 10 05t22 24 13 54z" } ] }, { "uid" "760e3b98 1bad 476c 8989 b238ccd6472c", "singularname" "delete livetext feed", "pluralname" "delete livetext feed", "fullname" "livetext feed (full control) delete livetext feed", "targetentity" "livetextfeed", "appliance" "instance, collection", "parent" { "uid" "5ef4d2e0 3abc 4f3d aa8f d1bbddace601", "singularname" "full control", "pluralname" "livetext feed (full control)", "fullname" "livetext feed (full control)", "targetentity" "livetextfeed", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "760e3b98 1bad 476c 8989 b238ccd6472c", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 08 17t20 49 47 303z" }, { "entityid" null, "operationuid" "760e3b98 1bad 476c 8989 b238ccd6472c", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 45 877z" }, { "entityid" null, "operationuid" "760e3b98 1bad 476c 8989 b238ccd6472c", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 46 17z" }, { "entityid" null, "operationuid" "760e3b98 1bad 476c 8989 b238ccd6472c", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 08 17t20 49 46 437z" }, { "entityid" null, "operationuid" "760e3b98 1bad 476c 8989 b238ccd6472c", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 46 737z" }, { "entityid" null, "operationuid" "760e3b98 1bad 476c 8989 b238ccd6472c", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 08 17t20 49 47 737z" }, { "entityid" null, "operationuid" "760e3b98 1bad 476c 8989 b238ccd6472c", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 10498 }, "isfixed" false, "isinherited" true, "isallowed" false, "creationdate" "2023 10 05t22 24 13 54z" } ] } ], "permissions" \[ { "entityid" null, "operationuid" "5ef4d2e0 3abc 4f3d aa8f d1bbddace601", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 08 17t20 49 45 877z" }, { "entityid" null, "operationuid" "5ef4d2e0 3abc 4f3d aa8f d1bbddace601", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 08 17t20 49 46 17z" }, { "entityid" null, "operationuid" "5ef4d2e0 3abc 4f3d aa8f d1bbddace601", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 08 17t20 49 46 437z" }, { "entityid" null, "operationuid" "5ef4d2e0 3abc 4f3d aa8f d1bbddace601", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" false, "isallowed" false, "creationdate" "2020 08 17t20 49 46 737z" }, { "entityid" null, "operationuid" "5ef4d2e0 3abc 4f3d aa8f d1bbddace601", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" false, "isallowed" false, "creationdate" "2020 08 17t20 49 47 28z" }, { "entityid" null, "operationuid" "5ef4d2e0 3abc 4f3d aa8f d1bbddace601", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" false, "isallowed" false, "creationdate" "2020 08 17t20 49 47 737z" }, { "entityid" null, "operationuid" "5ef4d2e0 3abc 4f3d aa8f d1bbddace601", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 10498 }, "isfixed" false, "isinherited" false, "isallowed" false, "creationdate" "2023 10 05t22 24 13 54z" } ] } 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}/permissions/ includes object permissions for a given live text feed instance required scope token bsn api main feeds text retrieve segment id int int a unique identifier for the live text feed instance request example the example request parameters and headers are set as follows id is set to 4567890 get /2022/06/rest/feeds/text/4567890/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" 4567890, "operationuid" "5ef4d2e0 3abc 4f3d aa8f d1bbddace601", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 10498 }, "isfixed" false, "isinherited" false, "isallowed" false, "creationdate" "2023 10 27t18 48 11 05z" }, { "entityid" 4567890, "operationuid" "376563fa 72b4 471a 9d49 1f4de927dc20", "principal" { "login" "janedoe\@brightsign biz", "type" "user", "id" 10498 }, "isfixed" false, "isinherited" false, "isallowed" false, "creationdate" "2023 10 27t18 48 11 057z" } ] 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 to live text feeds instance(s) with the specified id required scope token bsn api main feeds text update segment id int int a unique identifier for the live text feed instance 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 set to 4567890 post /2022/06/rest/feeds/text/4567890/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 368 this is the example request body \[ { "entityid" 4567890, "operationuid" "376563fa 72b4 471a 9d49 1f4de927dc20", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 10498 }, "isfixed" false, "isinherited" false, "isallowed" false, "creationdate" "2023 10 27t18 48 11 057z" } ] success response 204 204 the specified permissions were successfully granted 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 from the specified live text feed instance required scope token bsn api main feeds text update segment id int int a unique identifier for the live text feed instance 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 set to 4567890 delete /2022/06/rest/feeds/text/4567890/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 328 this is the example request body \[ { "entityid" 4567890, "operationuid" "5ef4d2e0 3abc 4f3d aa8f d1bbddace601", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 10498 }, "isfixed" false, "isinherited" false, "isallowed" false, "creationdate" "2023 10 27t18 48 11 05z" }, { "entityid" 4567890, "operationuid" "376563fa 72b4 471a 9d49 1f4de927dc20", "principal" { "login" "janedoe\@brightsign biz", "type" "user", "id" 10498 }, "isfixed" false, "isinherited" false, "isallowed" false, "creationdate" "2023 10 27t18 48 11 057z" } ] 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 live text feed instance required scope token bsn api main feeds text retrieve segment name string string the name of the live text feed instance request example the example request parameters and headers are set as follows name is set to newsfeed get /2022/06/rest/feeds/text/newsfeed/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" 4567890, "operationuid" "5ef4d2e0 3abc 4f3d aa8f d1bbddace601", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 10498 }, "isfixed" false, "isinherited" false, "isallowed" false, "creationdate" "2023 10 27t18 48 11 05z" }, { "entityid" 4567890, "operationuid" "376563fa 72b4 471a 9d49 1f4de927dc20", "principal" { "login" "janedoe\@brightsign biz", "type" "user", "id" 10498 }, "isfixed" false, "isinherited" false, "isallowed" false, "creationdate" "2023 10 27t18 48 11 057z" } ] 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 to live text feeds instance(s) with the specified name required scope token bsn api main feeds text update segment name string string the name of the live text feed instance 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 newsfeed post /2022/06/rest/feeds/text/newsfeed/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 368 this is the example request body \[ { "entityid" 4567890, "operationuid" "376563fa 72b4 471a 9d49 1f4de927dc20", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 10498 }, "isfixed" false, "isinherited" false, "isallowed" false, "creationdate" "2023 10 27t18 48 11 057z" } ] success response 204 204 the specified permissions were successfully granted 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 specified representation of the permissions entity is invalid or not supported (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error delete /{name}/permissions/ removes permissions from the specified live text feed instance required scope token bsn api main feeds text update segment name string string the name of the live text feed instance 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 newsfeed delete /2022/06/rest/feeds/text/newsfeed/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 328 this is the example request body \[ { "entityid" 4567890, "operationuid" "5ef4d2e0 3abc 4f3d aa8f d1bbddace601", "principal" { "name" "custom", "iscustom" true, "type" "role", "id" 10498 }, "isfixed" false, "isinherited" false, "isallowed" false, "creationdate" "2023 10 27t18 48 11 05z" }, { "entityid" 4567890, "operationuid" "376563fa 72b4 471a 9d49 1f4de927dc20", "principal" { "login" "janedoe\@brightsign biz", "type" "user", "id" 10498 }, "isfixed" false, "isinherited" false, "isallowed" false, "creationdate" "2023 10 27t18 48 11 057z" } ] 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