Este método permite iniciar un caso 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. Al iniciarse un caso, queda listo para ejecutar sus actividades (formularios) en el orden determinado en su definición.
Endpoint (Método y URI)
POST https://api.blizwork.com/init/<token>Llamado
{
"companyId": "<Id. de la Organización>",
"userId": "<Id. del usuario autorizado>",
"workflowId": "<Identificador del proceso>",
"execUserId": "<Id. del usuario que inicia el caso>"
}| 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 que será el que figure como iniciador del caso. Ejemplo: “usuario@organizacion.com”. |
| <Identificador del proceso> | Identificación del proceso para el que se desea abrir un caso. El proceso debe estar definido. Ejemplo: “proceso-atencion”. |
| <Id. del usuario que inicia el caso> | Opcional. Si el caso debe aparecer como ejecutado por un usuario de otra organización, se puede especificar en este parámetro. |
Respuesta
{
"resultCode": 0,
"resultMessage": "<Mensaje>",
"caseNumber": 123
}- 0: Operación realizada exitosamente.
Propiedad caseNumber
Contiene el número de caso iniciado. Es válida solo cuando el caso se ha iniciado exitosamente, es decir, la propiedad resultCode tiene el valor 0.
Notas
- El identificador de la Organización se obtiene en la página “Mi Cuenta” de la aplicación web. Si se desea iniciar un caso en una organización distinta de la propia, esa organización debe proporcionar este identificador. De otra forma, no será posible iniciar el caso.
- El usuario especificado debe tener acceso al proceso. Es decir, debe estar en alguna de las siguientes condiciones:
- 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.
- Si el proceso es público y está activo.
- Si el usuario que inicia el caso es distinto del usuario que hace la llamada (y que tiene autorización para utilizar un token de API), se debe utilizar el parámetro execUserId. Este caso de uso aplica cuando se debe iniciar un caso a nombre de un Cliente: el usuario del Cliente no tiene acceso al token de seguridad para llamar la API, por eso se debe hacer el llamado con un Id de usuario autorizado, pero el caso debe quedar a nombre del usuario del Cliente.
- 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.
- Los identificadores son sensibles a mayúsculas, minúsculas y espacios.
- El identificador del flujo de trabajo debe corresponder a un proceso activo, ya sea público o privado.
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 |