Datos para el inicio de procesos

<< Clic para mostrar Tabla de Contenidos >>

Navegación:  Bizagi Studio > Bizagi desde aplicaciones externas > API de Bizagi para aplicaciones externas > Servicios OData > Índice de servicios > Servicios de Datos > Datos de Proceso >

Datos para el inicio de procesos

Introducción

Bizagi ofrece un servicio OData que maneja aspectos de Diseño de Experiencia, como se explica en Servicios de datos.

Por medio de la URI de Processes, puede manejar información relacionada los Procesos de un usuario (no necesariamente stakeholder), como se describe en Datos de proceso.

Esta sección describe cómo iniciar casos para un proceso dado.

 

Resource URL

Empecemos con la siguiente URL:

[your_bizagi_project_url]/odata/data/processes([ID_proceso])/start

 

Donde:

[ID_proceso]: El GUID de un proceso en específico como es retornado al invocar Datos de proceso.

[url_del_proyecto_bizagi]: Corresponde a la URL donde los usuarios finales acceden al Portal de trabajo de Bizagi.

Por ejemplo, para proyectos de Bizagi en sus instalaciones, esta URL sería:

https://[su_servidor]/[su_proyecto]/odata/data/processes([ID_proceso])/start

Mientras que para proyectos Bizagi PaaS, esta URL sería:

https://[ambiente_del_proyecto]-[su_proyecto]-[su_compañia].bizagi.com/odata/data/processes([ID_proceso])/start

 

 

Ejemplo

Para iniciar un nuevo caso, la URL descrita anteriormente es invocada por medio de un HTTP POST.

Incluya la siguiente estructura JSON para enviar los 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 value):

 

OData_ProcessesStart_user

 

Esta otra imagen muestra una invocación previa con los parámetros que el proceso espera (como se necesita enviar el tipo exacto de dato y la información del XPath que corresponde):

 

OData_ProcessesStart1_user

 

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 envian registros nuevos en colecciones, consulte Columnas en colecciones.

Para conocer cómo construir un formato compatible a lo que se espera cuando se envian fechas, imágenes o adjuntos, o campos booleanos, consulte Enviar parámetros de entrada.