Datos de acciones de resultados 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 >

Datos de acciones de resultados 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, como se describe en Resultados y datos para ejecución de búsquedas.

Esta sección describe cómo obtener acciones de los registros (y ejecutadas eventualmente), como se entregan por Searches.

 

note_pin

Las acciones consideradas por este servicio son sólo aquellas que disparan nuevos procesos.

Las acciones que ejecutan reglar o lanzan formas no son soportadas.

 

URL del Recurso

Empiece con la siguiente URL:

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

 

Donde:

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

[ID_resultado]: EL ID de un registro en específico, como se obtiene con Resultados y datos para ejecución de búsquedas.

[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 muestra como puede enviar una acción HTTP GET para este recurso:

 

OData_SSearches3

 

 

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.

 

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])/actions[(ID_accion)]

 

OData_SSearches4

 

Para una acción dada, puede enviar parámetros y ejecutarla para empezar un caso.

Para ejecutar la acción que empieza un nuevo caso, la URL a continuación es invocada por medio de una petición HTTP POST:

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

 

Incluya la siguiente estructura JSON para enviar parámetros:

{

      "startParameters": [

       {

           "xpath": "[nombre_xpath]",

           "type": "[tipodato_xpath]",

           "value": "[valor_para_xpath]"

       }

   ]

}

 

Donde:

[nombre_xpath]: El Xpath exacto como se espera por los parámetros de la acción que inicia el proceso.

[tipodato_xpath]: El tipo de dato para ese Xpath, como se espera para cada parámetro.

[valor_para_xpath]: El valor que le quiere asignar a ese parámetro..

 

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

{

      "startParameters": [

       {

           "xpath": "[nombre_xpath1]",

           "type": "[tipodato_xpath1]",

           "value": "[valor_para_xpath1]"

       },

       {

           "xpath": "[nombre_xpath2]",

           "type": "[tipodato_xpath2]",

           "value": "[valor_para_xpath2]"

       }

   ]

}

 

De la misma manera, si no se esperan parámetros, usaría:

{

 "startParameters": [

 ]

}

 

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 ilustra la información que puede enviar en una acción HTTP POST y  la respuesta que obtendría indicando el número del caso para el caso creado (dentro de value):

 

OData_ActionsExec3

 

Esta otra imagen muestra una invocación previa con los parámetros que la acción espera (como se necesita enviar el tipo exacto de dato y la información del Xpath que corresponde):

 

OData_ActionsExec2