Introducción
Bizagi provee servicios OData, que manejan un amplio conjunto de recursos, alguno de ellos le permiten usar un servicio HTTP POST para iniciar un nuevo caso, completar una actividad o evento (workitem) pendiente o disparar una acción.
Para usar estos servicios basados en HTTP POST usted necesitará revisar ciertas estructuras de datos y parámetros de entrada necesarios para una colección.
La siguiente sección describe como interpretar las columnas de una forma usando una colección, para que pueda enviar los valores adecuados cuando inicie un nuevo proceso, complete un workitem o lance una acción, si alguno requiere que la información en la colección se diligencie.
Alcance del recurso
La información sobre las columnas en una colección es obtenida por defecto cuando se consulta un proceso (aquellos atributos de tipo entidad, Entity en inglés), usados ya sea en una forma de inicio (para crear un caso nuevo), en una forma de actividad (completar un workitem) o como entrada de una acción (lanzar una de estas).
URL del recurso
La posibilidad de consultar valores para entidades relacionadas es soportada por todos estos recursos, cuando alguno de ellos entrega información sobre un XPath que es explícitamente una Colección (Collection):
•[url_del_proyecto_bizagi]/odata/data/processes([ID_proceso])
•[url_del_proyecto_bizagi]/odata/data/processes([ID_proceso])/cases([ID_caso])/workitems([ID_workitem])
•[url_del_proyecto_bizagi]/odata/data/cases([ID_caso])/workitems([ID_workitem])
•[url_del_proyecto_bizagi]/odata/data/stuff([ID_mis_cosas])/values([ID_valor])/actions([ID_acción])
•[url_del_proyecto_bizagi]/odata/data/searches([ID_búsqueda])/actions([ID_acción])
•[url_del_proyecto_bizagi]/odata/data/searches([ID_búsqueda])/results([ID_result])/actions([ID_acción])
•[url_del_proyecto_bizagi]/odata/data/relevants([ID_relevantes])
•[url_del_proyecto_bizagi]/odata/data/relevants([ID_relevantes])/actions([ID_acción])
Ejemplo
La siguiente imagen ilustra como enviar in HTTP GET para este recurso, usando como ejemplo lo siguiente:
Los resultados entregados contienen varios valores dentro de el XPath del tipo colección (Colección), uno para cada una de las columnas incluidas en esa forma (típicamente un control tabla).
Dentro del elemento columnas (columna), encontrará:
•Nombre: El nombre único del atributo como una columna.
•Id: Una cadena para el GUID que representa la URI para la referencia en específico.
•XPath: El XPath a ese atributo, partiendo desde la entidad de la colección.
•Tipo: El tipo de dato de este atributo. Para una lista de los posibles valores de tipos de datos en Bizagi, refiérase a Tipos de datos.
Basados en la información de las columnas y para poder enviar los parámetros de entrada para una colección, asegúrese de construir la siguiente estructura para este XPath en específico:
{
"startParameters": [
{
"XPath": "MyProcessEntity.MyCollection",
"type": "collection",
"rows": [
{
"columns": [
{
"XPath": "FullName",
"value": "Juliette Leroy"
},
{
"XPath": "Income",
"value": "300000"
}
]
},
{
"columns": [
{
"XPath": "FullName",
"value": "Piotr Blanter"
},
{
"XPath": "Income",
"value": "300000"
}
]
}
]
}
]
}
Note que el ejemplo envía dos filas para la colección MyCollection, mientras diligencia dos columnas: FullName e Income.
La imagen a continuación muestra un ejemplo y la respuesta que recibirá cuando cree un nuevo caso para un proceso dado:
Editar registros de una colección
Para editar un registro en su colección, debe implementar una llave de negocio en su entidad. Posteriormente, si envía una llave existente dentro de la sección "columnas", junto con los atributos que desea editar, el registro actual actualiza su información.
Por ejemplo, supongamos que, en el caso que se mostró anteriormente, establece FullName como la llave de negocio.
Si envía el siguiente JSON startParameter:
{
"startParameters": [
{
"xpath": "MyProcessEntity.MyCollection",
"type": "collection",
"rows": [
{
"columns": [
{
"xpath": "FullName",
"value": "Juliette Leroy"
},
{
"xpath": "Income",
"value": "400000"
}
]
}
]
}
]
}
Bizagi no crea un nuevo registro pero actualiza el existente, aumentando el salario de Juliette Leroy a 400000.
|
Cuando agrega una llave de negocio a una entidad, debe tener en cuenta las siguientes consideraciones: •Algunas reglas o políticas pueden verse afectadas por el uso de una llave de negocio. •Una vez que agrega una llave de negocio, no puede volver a no tener una llave de negocio. •La capa de OData debe exponer su llave de negocio, por lo que no utilice información confidencial como llave. •Para usar la virtualización y la capa OData, debe tener permisos para crear nuevos registros en la base de datos. •Cuando agrega una llave de negocio a su ambiente de producción, si la llave de negocio no está bien definida, pueden surgir algunas colisiones en la implementación. |
Restricciones
Tenga en cuenta lo siguiente:
•Colecciones anidadas (colecciones dentro de colecciones) no están soportadas por estos servicios.
Esto significa que necesita llenar directamente la colección con valores, pero no puede llenar una colección dentro de otra.
•No se pueden editar o eliminar filas que ya fueron creadas en dicha colección.
Last Updated 2/1/2022 3:05:09 PM