Servicios de Consulta

<< Clic para mostrar Tabla de Contenidos >>

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

Servicios de Consulta

Overview

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

Esta sección describe como hacer uso de los servicios OData que le permiten ejecutar consultas. Este servicio solo le permite hacer consultas en sus entidades maestras. A diferencia de la opción de consulta en los servicios de Datos, estos servicios no se deben asociar a una consulta de Bizagi.

 

URL base para los servicios de consulta

Para acceder a los Servicios de consulta, inicie por esta URL:

[your_bizagi_project_url]/odata/query

 

Donde:

[your_bizagi_project_url]: Corresponde a la URL del Portal de Trabajo al que acceden sus usuarios finales.

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

https://[your_server]/[your_project]/odata/query

Mientras que para proyectos <%BIZAGI_CLOUD%>, esta URL sería:

https://[project_environment]-[your_project]-[your_company].bizagi.com/odata/query

 

Recursos en los Servicios de Consulta

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

 

Recurso

Descripción

URL ejemplo

Entity

Retorna la lista de las entidades expuestas y sus posibles XPaths

[your_bizagi_project_url]/odata/query/entity

executeEntityQuery

Ejecuta una consulta sobre una entidad específica

[your_bizagi_project_url]/odata/query/executeEntityQuery

 

Ejemplos

En esta sección encontrará ejemplos de cada uno de estos servicios.

 

Entity

La siguiente imagen muestra cómo se puede enviar una solicitud HTTP GET para este recurso:

 

ODataQuery001

 

Este servicio retorna una lista de entidades dentro de la sección value. Cada una de estas entidades tiene la siguiente información:

@odata.id: La URL que identifica este elemento.

Id: Una cadena de caracteres tipo GUID que representa la URI del elemento.

Name: El nombre de la entidad como se definió en Bizagi Studio.

IsProcessEntity: Este elemento muestra si la entidad es una entidad de proceso o no.

ProcessesRelated: La lista de los procesos relacionados con esta entidad.

Los atributos disponibles para estos procesos son:

oId: Una cadena de caracteres tipo GUID del proceso.

odisplayName: Nombre del proceso.

Attribs: Un array que muestra los XPath o entidades que se pueden consultar desde esta entidad.

oId: Una cadena de caracteres tipo GUID que identifica el XPath o la entidad.

odisplayName: Nombre de la entidad o XPath.

oXPaths: Una lista de los posibles XPath.

 

La siguiente imagen muestra un ejemplo de cómo se ve la llave "attribs":

 

ODataQuery002

 

Si la entidad es una entidad de proceso, esta muestra unos atributos especiales relacionados con el proceso en la llave "attrib".

 

@ProcessId: Número de ID del proceso.

@CaseNumber: Número del caso.

@CreationDate: Fecha de creación del caso.

@EstimatedSolutionDate: Fecha estimada de solución del caso.

@SolutionDate: Fecha de solución del caso.

@Closed: Muestra si el caso está cerrado.

@WorkItems: Información sobre los workitems pendientes.

 

ODataQuery003

 

executeEntityQuery

Este servicio POST ejecuta una consulta sobre una entidad específica que se determina a través de un archivo JSON. Este JSON debe contener también la lista de XPaths que se desean recuperar. Estos XPaths deben coincidir con los valores retornados por el servicio de Entity.

Los elementos esperados del JSON son:

QueryParameter: Los parámetros de la consulta sobre la entidad

oEntity: El nombre de la entidad. No use el nombre para mostrar

oProcessId: Número de ID del proceso que se desea consultar a través de la entidad del proceso

oXPaths: Una lista de los XPaths que se desean ver en la consulta

 

Este servicio devuelve una lista de XPath para cada registro de su entidad junto con el número total de registros.

 

La siguiente imagen muestra un ejemplo del JSON que se debe enviar y de la respuesta retornada por el endpoint:

 

ODataQuery004

 

Consideraciones

Si no se entrega ningún XPath, el servicio solo retorna el campo BIzagiID

Para las Entidades de proceso, si no se provee un processId, la consulta usa el primer proceso asociado con el proceso

Para las entidades que no son de proceso, no se puede enviar un processId

El servicio de consultas solo puede acceder a dos capas de información

Las colecciones no se pueden consultar usando este servicio