Datos de Búsqueda

<< 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

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 a las búsquedas de los Stakeholders.

 

URL del Recurso

Empecemos con la siguiente URL:

[url_del_proyecto_bizagi]/odata/data/searches

 

Donde:

[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

 

Ejemplo

La siguiente imagen ilustra como se puede enviar una petición HTTP GET para este recurso:

 

OData_DSearches1

 

 

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

Name: El nombre único de la búsqueda para ese Stakeholder.

DisplayName: El nombre para mostrar por defecto de la búsqueda, como lo ve el Stakeholder.

@odata.id: La URL única para acceder a esa búsqueda en específico.

Id: Una cadena de texto con el GUID que representa la URI para esa búsqueda en específico.

Parameters: La lista de datos (atributos) que esa búsqueda necesita para realizar una nueva.

Estos parámetros incluyen para cada atributo:

oId: El GUID del atributo en una cadena de texto.

oName: El nombre para mostrar del atributo.

oXpath: El Xpath completo para ese atributo (incluye su nombre).

oType: El tipo de dato de ese atributo. Para una lista de los posibles valores de tipos de dato en Bizagi, refiérase a Tipos de datos.

Actions: La lista de las acciones disponibles para esa colección de Mis Cosas.

Estos parámetros incluyen para cada acción:

oId: El GUID de la acción en una cadena de texto.

oName: El nombre único de la acción.

oDisplayName: El nombre para mostrar de la acción.

oParameters: La lista de los parámetros necesarios para ejecutar esta acción, que especifica ID, nombre, Xpath y tipo de dato del parámetro (de acuerdo a Tipos de datos).

Template: La lista de datos (atributos) que esta búsqueda usa cuando muestra los registros que coinciden.

Este template incluye conjuntos de información, que tienen:

oName: El nombre del atributo.

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

oType:  El tipo de dato de ese atributo. Para una lista de los posibles valores de tipos de dato en Bizagi, refiérase a Tipos de datos.

 

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 únicamente el detalle de un registro en específico en vez de una lista.

Por ejemplo usando

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

 

OData_DSearches2

 

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

Para mayor información sobre cómo continuar para ejecutar búsquedas y navegar sus resultados, refiérase a Resultados y datos para ejecución de búsquedas.

 

Personalizar los atributos retornados

En caso de que desee filtrar o cambiar por completo los atributos que han sido entregados con esta invocación, refiérase a Configurar qué información de negocio se retorna.