Parámetros de creación

<< Clic para mostrar Tabla de Contenidos >>

Navegación:  Automatización de Procesos con poco código > Studio Cloud -ambiente de autoría > Bizagi Studio > Bizagi desde aplicaciones externas > API de Bizagi para aplicaciones externas > Servicios RESTful OData > Ejemplos del API de Bizagi > Ejemplos de Servicios de Datos > Datos de entidades >

Parámetros de creación

Introducción

Bizagi expone un API de OData para habilitar invocaciones de servicios externas que retornar datos de negocio y del proyecto y hacen posible disparar actividades que de otra forma solo se podrían hacer desde el Portal de Trabajo.

Mediante dicho API, puede crear registros (valores) de entidades paramétricas, al proveer los parámetros esperados a la URL correspondiente. En este artículo se guía con un ejemplo simple el uso de esta funcionalidad.

 

Cuando haya localizado la entidad a la que le desea adicionar el valor y los valores que ya han sido agregados a esta, mediante las siguientes invocaciones de servicios:

 

https://[environment]-[project]-[company].bizagi.com/odata/data/entities  

https://[environment]-[project]-[company].bizagi.com/odata/data/entities([ID_entity])

https://[environment]-[project]-[company].bizagi.com/odata/data/entities([ID_entity])/values

https://[environment]-[project]-[company].bizagi.com/odata/data/entities([ID_entity])/values([ID_value])

 

Entonces podrá realizar un llamado a https://[environment]-[project]-[company].bizagi.com/odata/data/entities([ID_entity])/creationParameters para obtener los valores que pueden enviarse para obtener los parámetros requeridos para crear un registro de la entidad especificada. La siguiente imagen ilustra una invocación a dicho método.

 

OData_Entities06

 

Puede indagar mas sobre los valores obtenidos invocando los siguientes servicios:

 

https://[environment]-[project]-[company].bizagi.com/odata/data/entities([ID_entity])/creationParameters([ID_param]) para recibir información adicional del parámetro específico.

https://[environment]-[project]-[company].bizagi.com/odata/data/entities([ID_entity])/creationParameters([ID_param])/values para recibir los posibles valores que se pueden enviar para crear el registro, en caso de que el parámetro sea de tipo entidad.

 

Ejemplo

Se va a crear un registro en la entidad Ciudad proveyendo los parámetros mostrados anteriormente. Para hacerlo puede utilizar el método https://[environment]-[project]-[company].bizagi.com/odata/data/entities([ID_entity])/create.

 

Tenga en cuenta que:

Dicho método solo aplica para entidades Paramétricas y Persona.

Asegúrese de que los parámetros que se están enviado sean los presentes en la AddForm o la forma por defecto en caso de que la anterior no se haya configurado. Estos parámetros son los mismos que se obtienen al ejecutar el servicio .../creationParameters.

Puede activar / desactivar valores, tal y como lo puede hacer desde Studio o el Work Portal.

Para las Personas el cambio Usuarioasociado es obligatorio.

Al crear el registro, el valor que retorna la invocación del servicio es el GUID generado.

 

Como se desea crear un registro de Ciudad, se debe enviar en los parámetros de la petición los valores para Nombre, Código y Desactivado. La siguiente imagen muestra como hacerlo en el cuerpo de la petición.

 

OData_Entities07

 

En la parte de abajo de la imagen, se aprecia que el GUID de la ciudad creada (París con código 4) es provista en la respuesta de la invocación del servicio.

 

Para revisar que el registro haya sido añadido, se puede buscar el valor correspondiente a dicho ID en la entidad Ciudad.

 

OData_Entities08

 

Como la invocación del servicio fue exitosa y los valores obtenidos son los que fueron registrados previamente, se puede decir con confianza que la nueva tabla de la entidad fue creada.


Last Updated 12/12/2024 12:06:12 PM