Servicios de Datos

<< Clic para mostrar Tabla de Contenidos >>

Navegación:  Bizagi Studio > Bizagi desde aplicaciones externas > API de Bizagi para aplicaciones externas > Servicios OData >

Servicios de Datos

Introducción

Bizagi ofrece servicios OData para que aplicaciones externas puedan trabajar con la información que tiene Bizagi.

Hay dos tipos diferentes de servicios OData: uno maneja las definiciones del usuario (datos) y el otro maneja las definiciones almacenadas en las entidades de sistema y paramétricas (metadata), como se describe en API de Bizagi.

Esta sección describe como hacer uso de los servicios OData que manejan datos (referido de ahora en adelante como Servicios de datos).

 

Importante

Los Servicios de datos en Bizagi tienen en cuenda el contexto y la información relevante a un usuario en específico (Stakeholder), aunque hayan algunos que apliquen a todos los usuarios sin necesidad de que sean Stakeholders.

El usuario que se considera es el que está asociado a la aplicación registrada OAuth, cuyas claves de acceso son usadas en la solicitud de autenticación.

 

URL base para Servicios de datos

Para acceder los Servicios de Datos, necesitará una fracción de la siguiente URL base:

[url_del_proyecto_bizagi]/odata/data

 

Siendo:

[url_del_proyecto_bizagi]: Corresponde a la URL donde los usuarios finales acceden al Portal de trabajo de Bizagi.

Por ejemplo, para proyectos de Bizagi en sus instalaciones, esta URL sería:

https://[su_servidor]/[su_proyecto]/oauth2/server/token

Mientras que para proyectos Bizagi Cloud, esta URL sería:

https://[ambiente_del_proyecto]-[su_proyecto]-[su_compañia].bizagi.com/oauth2/server/token

 

Recursos en Servicios de datos

La siguiente tabla muestra información sobre los recursos manejados por Servicios de datos:

 

Recurso

Descripción

URL de ejemplo

Stuff

Entrega una lista de todas las colecciones que se encuentran en la sección Mis Cosas (para el Stakeholder autenticado).

Para mayor información sobre este recurso y sus opciones de consulta, refiérase a Datos de Mis Cosas.

[url_del_proyecto_bizagi]/odata/data/stuff

Searches

Entrega una lista de las búsquedas definidas, proveyendo su metadata (para el Stakeholder autenticado).

Para mayor información sobre este recurso y sus opciones de consulta, refiérase a Datos de Búsqueda.

[url_del_proyecto_bizagi]/odata/data/searches

Relevants

Entrega una lista de todos los casos destacados que se encuentran en la sección Destacado para mí, proveyendo su metadata  (para el Stakeholder autenticado).

Para mayor información sobre este recurso y sus opciones de consulta, refiérase a Datos de Destacado para mí.

[url_del_proyecto_bizagi]/odata/data/relevants

Stakeholders

Entrega una lista con todos los Stakeholders que aplican (para el Stakeholder autenticado),

Para mayor información sobre este recurso y sus opciones de consulta, refiérase a Datos de Stakeholders.

[url_del_proyecto_bizagi]/odata/data/stakeholders

userProfile

Retorna los detalles de una usuario autenticado.

Aplica para todos los usuarios sin importar que sean o no Stakeholders.

Para mayor información sobre este recurso y sus opciones de consulta, refiérase a Datos de Perfil de Usuario.

[url_del_proyecto_bizagi]/odata/data/userProfile

Processes

Retorna una lista de todos los procesos, entregando su metadata (para el usuario autenticado).

Aplica para todos los usuarios sin importar que sean o no Stakeholders.

Para mayor información sobre este recurso y sus opciones de consulta, refiérase a Datos de Proceso.

[url_del_proyecto_bizagi]/odata/data/processes

Cases

Retorna una lista de todos los casos pendientes que se encuentran en el Inbox (para el usuario autenticado).

Aplica para todos los usuarios sin importar que sean o no Stakeholders.

Para mayor información sobre este recurso y sus opciones de consulta, refiérase a Casos del Portal de Trabajo.

[url_del_proyecto_bizagi]/odata/data/cases

 

 

Tenga en cuenta que la definición de estos recursos está dada por una acción HTTP GET con la URL base ([url_del_proyecto_bizagi]/odata/data):

 

{

 "@odata.context": "[url_del_proyecto_bizagi]/odata/data/$metadata",

 "value": [

   {

     "name": "stuff",

     "kind": "EntitySet",

     "url": "stuff"

   },

   {

     "name": "searches",

     "kind": "EntitySet",

     "url": "searches"

   },

   {

     "name": "relevants",

     "kind": "EntitySet",

     "url": "relevants"

   },

   {

     "name": "stakeholders",

     "kind": "EntitySet",

     "url": "stakeholders"

   },

   {

     "name": "userProfile",

     "kind": "Singleton",

     "url": "userProfile"

   },

   {

     "name": "processes",

     "kind": "EntitySet",

     "url": "processes"

   },

   {

         "name": "cases",

     "kind": "EntitySet",

     "url": "cases"

   }

 ]

}