Introducción
Bizagi brinda acceso programático a la información empresarial subyacente en su modelo de datos, a través de una poderosa API basada en servicios RESTful y OData.
Esta API le permite trabajar con los datos de sus procesos desde aplicaciones externas, como información relacionada con procesos, casos o características centradas en la experiencia.
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/.
Iniciando
1.Autenticación: aprenda acerca del mecanismo de autenticación de Bizagi API.
2.Guía de inicio rápida: vea una guía rápida para la invocación de un método OData.
3.Información expuesta en OData: defina la información de negocio que puede exponer a través de servicios OData.
4.Índice del API: vea la lista completa de endpoints del API de Bizagi.
Consideraciones
Al usar métodos HTTP de OData con caracteres especiales en los campos de parámetro, usted debe tener en cuenta algunos casos especiales en los que estos caracteres deben ser remplazados por su valor hexadecimal. Para más información visite Consideraciones de caracteres especiales en OData.
Ejemplos
Puede ver una lista completa de ejemplos de invocación de Bizagi API.
Ejemplos de servicios de datos
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.
•Obtenga la información de las entidades.
•Obtenga la lista de casos pendientes con sus actividades pendientes (sea o no una Persona).
•Complete una actividad o evento pendiente enviando información aplicable a esa actividad o evento de un usuario final (sea o no una Persona).
•Busque un caso específico proporcionando su identificador de caso y obtenga sus detalles.
•Obtener información relacionada con Personas, por ejemplo, Mis cosas o Mis búsquedas, y ejecutar acciones en el Asistente de Personas.
Ejemplos de servicios de metadatos
A través de los servicios de metadatos puedes obtener detalles enfocados a cómo invocar más servicios de datos, tales como: Obtener la lista de procesos, Personas en el proyecto, o qué Búsquedas, Procesos, Procesos relevantes o colecciones de Mis cosas tienen bajo el Asistente de Personas.
Ejemplos de servicios de consulta
Los servicios de consulta exponen métodos para recuperar información de entidades y procesos de entidades. Estos servicios son útiles si está buscando generar informes de procesos usando la API de Bizagi, por ejemplo, un informe de un proceso usando información de negocio.
Vea cómo puede crear un código en C # para invocar métodos OData.
Servicios de búsqueda
Bizagi OData expone algunos endpoints útiles que ayudan a comprender la estructura de entidades, colecciones o cómo buscar metadatos, que necesita comprender antes de invocar otros servicios. Ver servicios de búsqueda.
Last Updated 2/26/2024 2:56:09 PM