Este método permite ejecutar una actividad (formulario) tal como lo haría un usuario a través de la interfaz web o móvil, pero a través de una llamada a la API.
Endpoint (Método y URI)
POST https://api.blizwork.com/exec/<token>Llamado
{
"companyId": "<Id. de la Organización>",
"userId": "<Id. del usuario autorizado>",
"workflowId": "<Identificador del proceso>",
"execUserId": "<Id. de usuario que ejecuta el formulario>",
"caseNumber": <Número de caso>,
"formId": "<Identificación del formulario>",
"nextFormId": "<Id. formulario seleccionado>",
"formData": {
"fieldId1": "fieldValue1",
"fieldId2": 0,
"fieldIdn": "fieldValuen",
"attachment_field": {
"fileName": "The File Name.pdf",
"fileUrl": "https://path.to.file.com/folder/..."
}
}
}| Parámetro | Explicación |
|---|---|
| <Id. de la Organización> | El identificador único que tiene cada organización en BlizWork a la que pertenece el proceso. Disponible en la sección “Mi Cuenta” de la aplicación web. Ejemplo: “5fe4a1f0f5d18203afbd6af2”. |
| <Id. del usuario autorizado> | Identificación (email) de un usuario autorizado a ejecutar esta actividad (formulario). Ejemplo: “usuario@organizacion.com”. |
| <Identificador del proceso> | Identificación del proceso. El proceso debe estar definido. Ejemplo: “proceso-atencion”. |
| <Id. de usuario que ejecuta la actividad> | Usuario que ejecuta la actividad, en caso de que sea distinto del usuario autorizado. |
| <Número de caso> | Identificación del caso cuya actividad se ejecutará. El caso debe estar abierto (iniciado y no cerrado). Nótese que se espera un número entero, no una cadena. Ejemplo: 4. |
| <Identificación del formulario> | Identificación de la actividad o formulario específico que se ejecutará. Esta identificación debe ser válida. Ejemplo: “ingreso-datos”. |
| <Id. formulario seleccionado> | Identificación del formulario correspondiente a la acción a ejecutar. Esta acción debe ser alguna de las definidas en el flujo de trabajo. Ejemplo “validar-datos”. |
| formData | Arreglo con los pares campo-valor que se almacenarán como parte de la ejecución de la actividad. |
| fieldId1, 2, n | Identificador del dato a almacenar como parte de la ejecución del formulario. El dato debe corresponder a alguno de los campos definidos para el formulario. Ejemplo “edad”. |
| fieldValue1, 2, n | Valor para campo identificado por fieldId. Puede ser una cadena, entero o decimal, dependiendo de la validación del formulario. Ejemplos: 2, “Infante”, 1.5. |
| attachment_field | Identificador de campo de archivo adjunto. Esto permite que se pueda enlazar un archivo subido anteriormente (en ese u otro caso). |
| fileName | Nombre del adjunto que se está enlazando. |
| fileUrl | Dirección pública del adjunto. |
Respuesta
{
"resultCode": 0,
"resultMessage": "<Mensaje>"
}- 0: Operación realizada exitósamente.
- 1: Token inválido o expirado.
- 2: Usuario no autorizado.
- 3: Flujo de trabajo inexistente, desactivado o privado.
- 4: Número de caso no existe.
- 5: Número de caso cerrado.
- 6: Formulario no existente o ya ejecutado.
- 7: Acción inexistente. El Id del próximo formulario no es válido.
- 8: El formulario especificado no se puede ejecutar.
- 9: El formulario siguiente (acción) especificado no existe.
- 10: El dato de formulario especificado no existe.
- 11: Usuario no registrado.
- 100: Requerimiento mal formado.
- 101: Error inesperado.
- 200: Límite de transacciones excedido.
Notas
- El identificador de la Organización se obtiene en la página “Mi Cuenta” de la aplicación web. Si se desea ejecutar un caso en una organización distinta de la propia, esa organización debe proporcionar este identificador. De otra forma, no será posible ejecutar la actividad.
- La actividad a ejecutar debe ser parte de un caso abierto y en que la actividad esté pendiente de ejecutarse. Tratar de ejecutar una actividad que aún no corresponde ejecutar o que ya fue ejecutada, resultará en un error. Nótese que una actividad puede ejecutarse automáticamente por la definición de un plazo de ejecución y, por lo tanto, no quedar disponible para ejecutarse por este método.
- El caso debe estar abierto (iniciado y no cerrado).
- El usuario especificado debe tener acceso a la actividad. Es decir, debe estar en alguna de las siguientes condiciones:
- Actividad para el rol “Cliente”: Si el proceso es un flujo de trabajo privado, es decir, sólo accesible a los usuario de la organización a la que pertenece el flujo, el usuario sólo podrá ejecutar la actividad si también pertenece a la organización. Si el proceso no es privado, el usuario sí podrá ejecutar la actividad, ya que cualquier usuario puede actuar como cliente de una organización.
- Actividad para rol interno: Si el usuario está incluido en el rol definido para la actividad, se podrá ejecutar la actividad correctamente. En caso contrario, se producirá un error.
- El usuario debe estar activo y validado en la plataforma. Una cuenta de usuario en la que no se ha verificado el correo electrónico, no puede ejecutar actividades de ningún tipo.
- Si el formulario debe ser ejecutado por un usuario ajeno a la organización, y que por lo tanto no tiene acceso al token de seguridad, esta identificación de usuario se debe especificar en el parámetro execUserId.
- Este método no permite iniciar un caso, pero sí permitirá cerrarlo si la próxima actividad es el cierre del caso.
- Los identificadores son sensibles a mayúsculas, minúsculas y espacios.
- Adjuntos:
- Si el adjunto especificado (attachment_field) no es un elemento adjunto, se retornará un error.
- La dirección del archivo (fileUrl) debe ser válida y existir. No se puede enlazar un adjunto que se haya eliminado o que no se haya subido previamente.
- Se pueden especificar tantos adjuntos como se requiera y hayan sido definidos en el formulario.
- En caso que se especifique varias veces el mismo adjunto, el valor que quedará almacenado será el último.
Límites
Este método tiene los siguientes límites de consumo:
| Plan | Máximo de transacciones por segundo |
|---|---|
| Free | 0 |
| Básico | 0,5 |
| Medio | 1 |
| Avanzado | 5 |
| Empresa | 50 |
| Corporativo | Máxima capacidad |
Nótese que la ejecución de actividades está, además, limitada por el plan de la empresa a la que el usuario está adscrito. Por ejemplo, si la empresa del usuario tiene el plan Free, que tiene un límite de atención de 10 casos, la API fallará al tratar de ejecutar una actividad del caso número 11 en adelante.