Listar Casos

Este método permite consultar los casos, ya sean que estén abiertos o cerrados. Sólo se puede consultar 200 casos por vez.

Endpoint (Método y URI)

POST https://api.blizwork.com/process/case-list/<token>

Llamado

{
  "userId": "<Id. del usuario autorizado>",
  "processId": "<Id. del proceso>,
  "filter": <Objeto con criterios de selección>
}

Parámetro	Explicación
<Id. del usuario autorizado>	Identificación (email) de un usuario autorizado a ejecutar esta consulta. Ejemplo: “usuario@organizacion.com”.
<Id. del proceso>	Identificación del proceso que se va a consultar. Este método solo lista los casos de un proceso en particular. Ejempo: “proceso-venta”.
<Objeto con criterios de selección>	La condición que deben cumplir los casos que se seleccionen. Debe cumplir con la sintaxis de selección de Mongo DB. Se puede incluir operadores lógicos como $and y $or. Ejemplo: { “status”: “open” } La consulta entregará un máximo de 200 casos. Si se requiere examinar más de 200 casos, se debe definir criterios de selección que permitan recuperar los casos parcialmente.

Respuesta

{
   "resultCode": 0,
   "resultMessage": "<Mensaje>",
   "payload": [
      {
         "processTitle": "Venta por BlizWork",
         "caseNumber": 123,
         "processVersion": 2,
         "initiatedOn": "2022-11-11T15:06:00.972Z",
         "initiatedBy": {
           "userName": "jperez@empresa.com",
           "firstName": "Juan",
           "lastName": "Pérez",
           "company": "Acme S. A."
         }
         "updatedOn": "2022-11-12T13:17:00.623Z",
         "updatedBy":  {
           "userName": "dpaez@miempresa.com",
           "firstName": "Daniela",
           "lastName": "Páez",
           "company": "Importadora San Juan Ltda."
         }
         "currentActivity": {
           "formId": "logistica",
           "formTitle": "Picking Mercancías"
         },
         "nextActivity": {
           "formId": "despacho",
           "formTitle": "Despacho Mercancías"
         }
         "status": "open",
      },
      ...
   ]
}

resultCode

• 0: Operación realizada exitosamente.
• 1: Token inválido o expirado.

Notas

• En payload se entregará la lista de casos que cumplen con la condición de selección especificada.
• Los casos estarán ordenados por número de caso (caseNumber).
• La consulta entregará un máximo de 200 casos. Si se requiere examinar más de 200 casos, se debe definir criterios de selección que permitan recuperar los casos parcialmente
• Si no se especifica una condición de selección, se recibirán todos los registros de la tabla con un tope de 200 casos. Se debe considerar el volumen de estos datos.
• Si ningún registro cumple con la condición indicada o si no hay casos, se entregará una lista vacía: [].

Límites

Este método tiene los siguientes límites de consumo:

Plan	Máximo de transacciones por segundo
Free	1
Básico	2
Medio	5
Avanzado	10
Empresa	25
Corporativo	Máxima capacidad