Columnas en colecciones

<< 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 > Servicios de consulta >

Columnas en colecciones

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:

 

OData_CollectionDataType

 

Los resultados entregados contienen varios valores dentro de el XPath del tipo colección (Collection), uno para cada una de las columnas incluidas en esa forma (típicamente un control tabla).

Dentro del elemento columns (columna), encontrará:

Name: 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.

Type: 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: Nombre (FullName) e Ingreso (Income).

La imagen a continuación muestra un ejemplo y la respuesta que recibirá cuando cree un nuevo caso para un proceso dado:

 

OData_SendCollection

 

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.