Punto final de operaciones (2022/06)

3 min

Este recurso representa el árbol de operaciones empresariales y los permisos de operaciones en una red determinada.

URL base para este endpoint: https://api.bsn.cloud/2022/06/REST/Operations

_________________________________________________________________________

GET /Root/{*path}/

Devuelve un subárbol de las operaciones empresariales disponibles junto con los permisos de rol otorgados.

Token de alcance requerido

bsn.api.main.operations.retrieve

______________________________________________________________

Segmento

ruta string opcional: Le permite solicitar un subconjunto en lugar de todo el árbol de operaciones empresariales. Se completa mediante nombres de operaciones basados en el árbol completo.

______________________________________________________________

Ejemplo de solicitud

Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:

ruta se establece en Usuario/ActualizarUsuario

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

______________________________________________________________

Cuerpo de la respuesta correcta

200: Devuelve la Entidad de operaciones empresariales que incluye permisos operativos

Ejemplo

{
   "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"
      }
   ]
}

Respuesta de error

300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)

400: La solicitud tiene un formato incorrecto y, por lo tanto, no es válida

401: El token de acceso no es válido o no se especificó

403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método

404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)

406: El servidor no puede devolver la representación de datos que usted solicitó (como se especifica en el encabezado "Accept")

5XX: Cualquier código 500 es un error interno del servidor