Operations Endpoint (2022/06)
3 min
this resource represents the business operations tree and operations permissions in a given network base url for this endpoint https //api bsn cloud/2022/06/rest/operations get /root/{ path}/ returns a sub tree of the available business operations along with granted role permissions required scope token bsn api main operations retrieve segment path \<font color="#704ae0">string\</font> \<font color="#01a0af">optional \</font> allows you to request a subset rather than the entire business operations tree it is populated by operation names based on the complete tree request example the example request parameters and headers are set as follows path is set to user/updateuser get /2022/06/rest/operations/root/user%2fupdateuser 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 \<font color="#089a4d">200\</font> returns the business operations entity docid\ ei98k7oul6z5i 5b d6js which includes operational permissions example { "uid" "526a9b95 cce5 422a 99f8 9f02d63af74f", "singularname" "update user", "pluralname" "update user", "fullname" "user (full control) update user", "targetentity" "user", "appliance" "instance, collection", "parent" { "uid" "b41ac545 d505 7014 edde 51bc4c0d21a0", "singularname" "full control", "pluralname" "user (full control)", "fullname" "user (full control)", "targetentity" "user", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "526a9b95 cce5 422a 99f8 9f02d63af74f", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2020 03 05t16 59 04 973z" }, { "entityid" null, "operationuid" "526a9b95 cce5 422a 99f8 9f02d63af74f", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 05 217z" }, { "entityid" null, "operationuid" "526a9b95 cce5 422a 99f8 9f02d63af74f", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 05 473z" }, { "entityid" null, "operationuid" "526a9b95 cce5 422a 99f8 9f02d63af74f", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 05 783z" }, { "entityid" null, "operationuid" "526a9b95 cce5 422a 99f8 9f02d63af74f", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 06 237z" }, { "entityid" null, "operationuid" "526a9b95 cce5 422a 99f8 9f02d63af74f", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2020 03 05t16 59 06 807z" } ] } failure response \<font color="#9a0808">300\</font> the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \<font color="#9a0808">400\</font> the request is malformed and therefore invalid \<font color="#9a0808">401\</font> the access token is invalid or not specified \<font color="#9a0808">403\</font> the supplied access token, though valid, doesn't provide access to this method \<font color="#9a0808">404\</font> the server cannot find the requested resource (the path does not exist) \<font color="#9a0808">406\</font> the server cannot return the data representation that you requested (as specified in the "accept" header) \<font color="#9a0808">5xx\</font> any 500 code is an internal server error