Resultados y datos para ejecución de búsquedas

<< Clic para mostrar Tabla de Contenidos >>

Navegación:  Bizagi Studio > Bizagi desde aplicaciones externas > API de Bizagi para aplicaciones externas > Servicios OData > Servicios de Datos > Datos de Búsqueda >

Resultados y datos para ejecución de búsquedas

Introducción

Bizagi ofrece un servicio OData que maneja aspectos de Diseño de Experiencia, como se explica en Servicios de datos.

Por medio de la URI de Searches, puede manejar información relacionada la las búsquedas de los Stakeholders.

Esta sección describe como usar y ejecutar una búsqueda y explorar sus resultados.

 

URL del Recurso

Empiece con la siguiente URL:

[url_del_proyecto_bizagi]/odata/data/searches([ID_busqueda]):

 

Donde:

[ID_busqueda]: El ID de una búsqueda en específico, como se obtiene con Datos de búsqueda.

[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 Bizagi Cloud, esta URL sería:

https://[ambiente_del_proyecto]-[su_proyecto]-[su_compañia].bizagi.com/oauth2/server/token

 

Posibilidades con una búsqueda dada

Las siguientes opciones están disponibles una vez esté trabajando con una búsqueda en específico:

 

1.Ejecutarla al enviar filtros (parámetros).

La invocación para estos resultados es una acción HTTP POST dado que necesite enviar parámetros como se muestra en Ejecutar una búsqueda con parámetros.

 

2.Ejecutarla y obtener resultados por defecto sin filtros (parámetros).

La invocación para estos resultados es una acción HTTP GET dado que no necesita enviar parámetros, como se muestra en Ejecutar una búsqueda sin especificar parámetros.

 

Ejemplos

Para los dos escenarios descritos anteriormente, tenemos estos ejemplos.

 

1. Ejecutar una búsqueda con parámetros

Considere la siguiente URL:

[url_del_proyecto_bizagi]/odata/data/searches([ID_busqueda])/performSearch

 

Incluya la siguiente estructura JSON para enviar los parámetros:

{

      "startParameters": [

       {

           "xpath": "[nombre_xpath]",

           "searchType": "[tipoBusqueda]",

           "value": "[valor_para_xpath]"

       }

   ]

}

 

Donde:

[nombre_xpath]: El nombre del Xpath como se espera de los parámetros de esa búsqueda.

 

OData_DSearches3

 

[tipoBusqueda]: Ya sea approx (para un valor aproximado basado en el texto), o exact (para un valor preciso).

[valor_para_xpath]: El valor que desee usar como filtro para el parámetro Xpath.

 

Si tiene más de un parámetro, usaría:

{

      "startParameters": [

       {

           "xpath": "[nombre_xpath1]",

           "searchType": "[tipoBusqueda]",

           "value": "[valor_para_xpath1]"

       },

       {

           "xpath": "[nombre_xpath2]",

           "searchType": "[tipoBusqueda]",

           "value": "[valor_para_xpath2]"

       }

   ]

}

 

Para filtrar la búsqueda con parámetros, tenga en cuenta las notas para los diferentes tipos de datos, como se describe en Valores y formatos para los tipos de datos.

 

La siguiente imagen muestra la información que se puede enviar en la acción HTTP POST y el resultado de la invocación:

 

OData_DSearches5

 

 

Los resultados de esta petición son los siguientes (dentro del elemento value):

@odata.id: La URL única para acceder ese registro en específico.

Id: Una cadena de texto con el GUID que representa la URI para ese registro en específico.

Parameters: La lista de los parámetros asociados a la información de ese registro.

Estos parámetros incluyen conjuntos de información con:

oXpath: El Xpath a ese atributo partiendo de la entidad de proceso.

oValue: El valor para ese Xpath del registro.

 

note_pin

Adicionalmente, para cada conjunto de resultados entregados por los servicios OData, la respuesta exitosa incluye un grupo de propiedades estándar que son precedidas por el símbolo @. Estas propiedades se describen en Propiedades y opciones de consulta.

 

Para una búsqueda dada, puede ejecutarla y explorar resultados (por ejemplo, para realizar acciones disponibles para un resultado).

Para mayor información sobre como ejecutar acciones en sus resultados, refiérase a Datos de acciones de resultados de búsquedas.

 

2. Ejecutar una búsqueda sin especificar parámetros

Considere la siguiente URL:

[url_del_proyecto_bizagi]/odata/data/searches([ID_busqueda])/results

 

La siguiente imagen muestra como puede usar una acción HTTP GET para este recurso.

 

OData_DSearches7

 

Los resultados de esta petición son los siguientes (dentro del elemento value):

@odata.id: La URL única para acceder ese registro en específico.

Id: Una cadena de texto con el GUID que representa la URI para ese registro en específico.

Parameters: La lista de los parámetros asociados a la información de ese registro.

Estos parámetros incluyen conjuntos de información con:

oXpath: El Xpath a ese atributo partiendo de la entidad de proceso.

oValue: El valor para ese Xpath del registro.

 

note_pin

Adicionalmente, para cada conjunto de resultados entregados por los servicios OData, la respuesta exitosa incluye un grupo de propiedades estándar que son precedidas por el símbolo @. Estas propiedades se describen en Propiedades y opciones de consulta.

 

Note como por medio de la propiedad @odata.id puede obtener el detalle de un registro en específico, en vez de una lista.

Por ejemplo, al usar:

[url_del_proyecto_bizagi]/odata/data/searches([ID_busqueda])/results(ID_resultado)

 

OData_DSearches6

 

 

Para una búsqueda dada, puede ejecutarla y explorar resultados (por ejemplo, para realizar acciones disponibles para un resultado).

Para mayor información sobre como ejecutar acciones en sus resultados, refiérase a Datos de acciones de resultados de búsquedas.