Ejecutar consultas

<< 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 Datos > Datos de consultas >

Ejecutar consultas

Introducción

Bizagi expone una API de OData para habilitar invocaciones remotas de servicios que retornan datos del proyecto y del negocio, y permite disparar acciones que de otra manera solo podría hacerse desde el Portal de Trabajo.

Mediante dicha API, puede ejecutar consultas, al proveer los parámetros esperados a la URL correspondiente. En este artículo se guía con un ejemplo simple el funcionamiento de este recurso.

 

Cuando haya localizado la consulta que desea realizar y los parámetros que espera, mediante las siguientes invocaciones:

 

https://[servidor]/[proyecto]/odata/data/queries

https://[servidor]/[proyecto]/odata/data/queries([ID_query])

https://[servidor]/[proyecto]/odata/data/queries([ID_query])/parameters

 

Entonces podrá realizar un llamado a https://[servidor]/[proyecto]/odata/data/queries([ID_query])/executeQuery enviando en el cuerpo de la petición los parámetros de la consulta que desea realizar. La petición debe ser ejecutada como se muestra en la siguiente imagen.

 

OData_Queries04

 

La consulta anterior, recibe como entrada un CandidateName que pertenece a la Entidad de proceso HireCandidate, por lo que el Xpath es especificado en la sintaxis que se muestra. En el parámetro "value", puede enviar cualquier valor que desee consultar. Bizagi realizará la consulta como si se estuviese haciendo desde el Portal de Trabajo, y responderá con los resultados de la consulta como se muestra en la siguiente imagen.

 

OData_Queries05

 

Como se puede ver, la respuesta incluye el número total de registros bajo el campo "@odata.totalCount". Después de la información general, bajo el objeto "values", se puede ver el detalle de los resultados de la consulta. En esta oportunidad muestra el caso #101, el cual satisface la condición dada: su CandidateName es Jorge, como se muestra en la imagen.

 

OData_Queries06

 

Consideraciones importantes

Puede haber situaciones en las que necesite usar el mismo control dos veces en una misma consulta. Por ejemplo, desea encontrar los casos creados entre dos fechas (CreationDate). En esos casos, para mejorar su entendimiento de la petición y para ayudarle a Bizagi a identificar a cual de los parámetros se refere, debe usar el atributo searchType. Puede obtener dicho parámetro haciendo una invocación previa al servicio https://[servidor]/[proyecto]/odata/data/queries([ID_query])/parameters.