Introducción
Bizagi ofrece un servicio OData que maneja aspectos de Asistente de Personas, como se explica en Servicios de datos.
Por medio de la URI de Búsquedas, puede manejar información relacionada la las búsquedas de las Personas, 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 Búsquedas.
|
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.
Para proyectos Automation Service, esta URL sería:
https://[ambiente_del_proyecto]-[su_proyecto]-[su_compañía].bizagi.com/odata/data/searches([ID_busqueda])/results([ID_resultado])/actions
Ejemplo
La siguiente imagen muestra como puede enviar una acción HTTP GET para este recurso:
Los resultados de esta petición son los siguientes (dentro del elemento valor):
•Nombre: El nombre único de la búsqueda para esa Persona.
•displayName: El nombre para mostrar por defecto de la búsqueda, como lo ve la Persona.
•@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.
•Parámetros: 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.
oNombre: El nombre para mostrar del atributo.
oXPath: El XPath completo para ese atributo (incluye su nombre).
oTipo: 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.
|
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)]
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": [
]
}
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 valor):
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):
Formatos específicos
Consulte los siguientes enlaces para casos de uso específicos:
•Para filtrar la búsqueda con parámetros, tenga en cuenta las anotaciones para los diferentes tipos de datos, como se describen en Tipos de datos en las respuestas OData de Bizagi.
•Para obtener de manera dinámica los valores de negocio que pueda necesitar como parámetros de entrada para iniciar un proceso nuevo o completar una actividad, consulte los Valores de entidades relacionadas.
•Para obtener de manera dinámica las columnas que necesita llenar cuando se envían registros nuevos en colecciones, consulte Columnas en colecciones.
•Para conocer cómo construir un formato compatible a lo que se espera cuando se envían fechas, imágenes o adjuntos, o campos Booleanos, consulte Enviar parámetros de entrada.
Last Updated 1/23/2023 12:10:05 PM