Servicios OData

<< Clic para mostrar Tabla de Contenidos >>

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

Servicios OData

Introducción

Bizagi provee acceso programático a la información subyacente de negocio en su modelo de datos, al tener una API poderosa basada en servicios OData y REST.

Esta API le permite trabajar con la información de sus procesos desde aplicaciones externas, especialmente para las características de Diseño de experiencia como iniciar nuevos procesos relevantes, ejecutar búsquedas y disparar acciones, o buscar casos pendientes en otros portales o las herramientas de su elección.

 

logo-OData

 

Conceptos Básicos de OData

Bizagi es compatible con OData versión 4.0, al tener un grupo de posibilidades exhaustivo para trabajar con lo subyacente de los procesos empresariales.

Los servicios OData son construidos como servicios REST (incluyendo recursos, accesibles a través de URLs mientras se hace que cada recurso haga uso de un identificador único).

 

Como los servicios REST, estos se basan en un grupo fijo de métodos HTTP, mostrados en la tabla a continuación:

 

MÉTODO HTTP

DESCRIPCIÓN

GET

Es una operación de sólo lectura.

Es usada para consultar información específica en el servidor.

Es una operación es idempotente (no importa cuantas veces se aplique la operación, el resultado será siempre el mismo) y segura (invocar un GET no cambia el estado del servidor).

POST

La operación POST es la única que no es idempotente ni segura en HTTP (esto quiere decir que puede modificar el servicio en una manera única).

Se puede enviar o no, información con la solicitud.

Se puede recibir o no, información con la respuesta.

 

Para mayor información sobre las especificaciones de OData, refiérase a http://www.odata.org/.

 

Servicios del API de Bizagi

Bizagi ofrece dos servicios diferentes de OData services: uno para acceder a los datos de negocio (recursos clasificados como parte de los servicios de datos), y otro para acceder a la configuración de acuerdo con la definición de los Stakeholders (recursos clasificados como parte de los servicios de metadata).

A través de los servicios de datos, usted puede contar con lo siguiente en Bizagi:

Obtener las colecciones del Mis cosas de un Stakeholder.

Obtener y ejecutar las acciones disponibles de los elementos de una colección del Mis cosas de un Stakeholder.

Obtener y ejecutar las búsquedas disponibles de los elementos de una colección del Mis cosas de un Stakeholder.

Obtener y ejecutar las acciones disponibles de los elementos de un Stakeholder.

Obtener la lista de procesos disponibles o relevantes de un Stakeholder.

Crear un nuevo caso para un proceso relevante de un Stakeholder.

Crear un nuevo caso para un proceso dado para cualquier usuario (independiente de si es un Stakeholder o no).

Obtener la lista de casos pendientes con sus actividades pendientes (independiente de si es un Stakeholder o no).

Completar una actividad pendiente o un evento enviando la información relacionada a dicha actividad o evento de un usuario final (independiente de si es un Stakeholder o no).

Buscar casos específicos y obtener sus detalles, a través del identificador del caso.

 

Para iniciar y probar por su cuenta el uso de los servicios de OData, consulte la Guía de inicio.

 

A través de los servicios de metadata, usted puede obtener detalles enfocados a cómo invocar servicios de datos adicionales, como: Obtener la lista de Stakeholders en el proyecto, procesos, procesos relevantes o colecciones de Mis cosas que estén bajo el Diseño de experiencia.

 

For a full list on the resources of each service, refer to Services index.

Additionally, it is recommended that you review the information presented under the Basic Concepts of this API.