Enviar parámetros de entrada

<< Clic para mostrar Tabla de Contenidos >>

Navegación:  Bizagi Studio > Bizagi desde aplicaciones externas > API de Bizagi para aplicaciones externas > Servicios OData > Conceptos básicos >

Enviar parámetros de entrada

Introducción

Bizagi provee servicios OData, que manejan un amplio conjunto de recursos relacionados al Diseño de Experiencia, como se describe en API de Bizagi.

Para ciertos casos, especialmente cuando se necesita invocar un servicio por medio de HTTP POST, podrá necesitar enviar información específica mientras se asegura de que el formato y estructura que utiliza cumple con lo que espera Bizagi.

Nótese que el tipo de dato más común es texto (Text), el cuál no necesita de un manejo o formato especial (aparte de la definción obvia de incluir los valores dentro de comillas).

 

Esta sección describe como enviar información respecto a fechas (p.ej. en los datos de tipo Fecha - Hora), archivos en general (sean datos de tipo Imagen o Archivo) u otros más comunes y simples como Booleanos o Numérico.

 

Valores y formato para tipos de datos comunes

Cuando envíe valores para tipos de datos comunes, tenga en cuenta:

Para parámetros de tipo Booleano, use los valores "true" o "false".

Para parámetros de tipo Numérico, ingrese los números sin separador de miles y use el punto (.) como separador de decimales.

 

Valores y formato para fechas

Para los parámetros del tipo de dato Fecha-Hora, especifique las fechas usando el formato estándar para interoperabilidad, en cualquiera de estas dos formas:

Para enviar una fecha sin hora específica, use YYYY-MM-DD (año, mes, día).

 

OData_SendDate2

 

Para enviar una fecha que contenga hora exacta, utilice YYYY-MM-DDThh:mm:ss, agregando el Designador de Zona Horaria.

El Designador de Zona Horaria recibe hasta 6 caracteres y empieza con el símbolo + o - indicando la zona horaria UTC. Por ejemplo: +00:00 para horas en Londres (Reino Unido), +05:30 para horas en Delhi (India) o -07:00 para horas en San Francisto (Estados Unidos).

 

OData_SendDate1

Tenga en cuenta:

oYYYY-MM-DD implica año, mes y día como se menciona anteriormente.

oT representa el componente de tiempo como se usa en el estándar ISO 8601 (https://www.w3.org/TR/NOTE-datetime.html).

Como se muestra en el ejemplo del vínculo, 1994-11-05T08:15:30-05:00 correspondería a la fecha 5 de noviembre de 1994, zona horaria en Colombia UTC -5.

 

Valores y formato para imágenes y archivos

Para parámetros del tipo Imagen o Archivo, se hace uso del mismo formato que utiliza bytes cifrados en base 64.

La diferencia entre el manejo de Imágenes y el de los Archivos, además del hecho que una imagen (*.png, *.jpg, etc) es un subconjuto de un archivo cargado (cualquier archivo con cualquier extensión), es simplemente que los atributos tipo Imagen en Bizagi pueden contener máximo un archivo, mientras que el atributo Archivo puede contener un número ilimitado de archivos.

 

OData_Files

 

Eso quiere decir que el ejemplo anterior aplica para datos del tipo Archivo exclusivamente, en donde se envían los valores en de acuerdo a este formato:

{

 "startParameters": [

         {

                   "XPath": "ContractManagement.Attachments",

         "files": [

                             {

                                 "fileName": "MyFile.jpg",

                                 "data": "/9j/4Q3BRXhpt3jj5Sv...........p9U039vxSXlaSSn/9k="

                             },

                       {

                                 "fileName": "MyDocument.doc",

                                 "data": "/9j/4Q3BRXhpt3jj5Sv...........p9U039vxSXlaSSy/6k="

                       }

                 ]

           }

 ]

}

 

Un ejemplo similar, pero que concuerda con el tipo de dato Imagen, sería:

{

 "startParameters": [

         {

                   "XPath": "PolicyUnderwriting.Customer.Photo",

         "files": [

                             {

                                 "fileName": "MyPhoto.png",

                                 "data": "/9j/52Hy6Xhpt3jj5Sv...........p9U039vxSXlaSSn/9k="

                             }

                 ]

           }

 ]

}

 

Tenga en cuenta:

fileName: Debe especificar el nombre del archivo o la imagen, incluyendo su extensión.

data: Debe tener el valor de los bytes del archivo o imagen cifrado en base 64.

 

Valores y formatos para entidades y colecciones

Cuando se envían valores que son referencias a entidades en Bizagi (p. ej. el tipo de dato Entidad) o al tipo de dato Colección, tenga en cuenta:

Las entidades simplemente reciben el valor o GUID que deberían tomar, cómo se consultó anteriormente o cómo se describe en Valores de entidades relacionadas.

Las colecciones pueden recibir varios registros, mientras que se asegura que los valores para cada una de las columnas está explícitamente definido, como se consultó o se describe en Columnas en colecciones.