Ejemplos de Servicios de Datos

<< Clic para mostrar Tabla de Contenidos >>

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

Ejemplos de Servicios de Datos

Introducción

Este tipo de servicios se pueden utilizar para acceder a datos de negocio (recursos clasificados como parte de los servicios de datos). A través de los servicios de datos puede hacer lo siguiente en Bizagi:

Cree un nuevo caso para procesos.

Obtén la información de las entidades.

Obtenga la lista de casos pendientes con sus actividades pendientes (sea o no un Interesado).

Complete una actividad o evento pendiente enviando información aplicable a esa actividad o evento de un usuario final (sea o no una parte interesada).

Busque un caso específico proporcionando su identificador de caso y obtenga sus detalles.

Obtener información relacionada con Stakeholders, por ejemplo, mis cosas o búsquedas, y ejecutar acciones de elementos de experiencia.

 

Importante

Los servicios de datos en Bizagi toman en cuenta el contexto y la información relevante para un usuario utilizado para la invocación.

El usuario utilizado para la invocación es el vinculado a la aplicación OAuth registrada cuyas claves de acceso se utilizan en la solicitud de autenticación. Al usar el token de autenticación, Bizagi puede controlar los datos a los que se accede a través de los servicios: solo se proporcionará la información a la que un usuario tiene acceso como resultado de la invocación de un servicio.

 

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 Automation Service, esta URL sería:

https://[ambiente_del_proyecto]-[su_proyecto]-[su_compañía].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

Cosas

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

Buscadas

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

Relevantes

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

Procesos

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

casos

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

IMPORTANTE: Aplica para todos los usuarios sin importar que sean o no Stakeholders. Es similar al recurso casesWithWorkItems pero se recomienda utilizar este si únicamente necesita consultar los casos sin las actividades pendientes.

 

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

casosConArtílculosdetrabajo

Retorna una lista de todos los casos pendientes que se encuentran en la Bandeja de entrada (para el usuario autenticado), con sus actividades pendientes correspondientes.

IMPORTANTE: Aplica para todos los usuarios sin importar que sean o no Stakeholders. Es similar al recurso cases pero se recomienda utilizar este si necesita consultar las actividades además de los casos pendientes (bajo un mejor desempeño).

 

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

[url_del_proyecto_bizagi]/odata/data/casesWithWorkitems

queries

Retorna una lista de todas las consultas en el proyecto. Es importante notas que todas las restricción de autorización que aplican en el Portal de Trabajo se mantienen para la invocación de servicios de este recurso.  Esto significa que solo las consultas que un usuario tiene disponibles saldrán en los resultados de las peticiones que involucran consultas.

 

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

[url_del_proyecto_bizagi]/[proyecto]/odata/data/queries

entities

Retorna una lista de todas las entidades administrables (como entidades paramétricas) en el proyecto. También, permite obtener más detalles de dichas entidades y navegar sus valores. Note que todas las restricciones de autorización del Portal de Trabajo también apliquen para estos recursos.

 

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

[url_del_proyecto_bizagi]/[proyecto]/odata/data/entities

 

 

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"

   },

   {

     "name": "casesWithWorkitems",

     "kind": "EntitySet",

     "url": "casesWithWorkitems"

   },

   {

     "name": "queries",

     "kind": "EntitySet",

     "url": "queries"

   },

   {

     "name": "entities",

     "kind": "EntitySet",

     "url": "entities"

   }

 ]

}