Entrega todos los datos de un caso como se encuentran al momento de realizar la consulta. Según el nivel de información solicitado se entregará solo datos del caso o los datos del caso más datos del historial del caso, de los usuarios involucrados, del proceso y de la organizaciones involucradas.
Endpoint (Método y URI)
POST https://api.blizwork.com/process/case/<token>Llamado
{
"userId": "<Id. del usuario autorizado>",
"processId": "<Id. del proceso>,
"caseNumber": <Número del caso>,
"include": <Datos adicionales a incluir",
"environment": "<Ambiente del caso>"
}| 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”. |
| <Número del caso> | Número de caso a consultar. Ejemplo: 173 Debe ser mayor que 0. |
| <Datos adicionales a incluir> | Opcional. Número que indica qué información adicional se debe incluir, según los siguientes valores: 0: No incluir información adicional, solo el caso. 1: Incluir 0 + datos de los usuarios involucrados. 2: Incluir 1 + historial del caso. 3: Incluir 2 + definición del proceso. 4: Incluir 3 + datos de las empresas involucradas. |
| <Ambiente del caso> | Opcional. Dónde se debe buscar el número de caso indicado, según los siguientes valores: “draft”: Buscar en casos de prueba. “production”: Buscar en casos de producción. |
Respuesta
{
"resultCode": 0,
"resultMessage": "",
"payload": {
"createAudit": {
"timeStamp": "2020-07-15T20:03:54.788Z"
},
"modifyAudit": {},
"assignedTo": "",
"planAssigned": false,
"status": "closed",
"fieldValues": [
{
"option": {},
"hideInOverview": false,
"name": "Datos Personales",
"columns": [],
"slug": "s1-datos-personales",
"defaultValue": "<h3>Reporte del problema </h3>",
"type": "markdown"
},
{
"option": {
"key": "2",
"value": "BlizWork (esta plataforma)"
},
"hideInOverview": false,
"name": "Sistema",
"columns": [],
"slug": "s1-sistema",
"defaultValue": "2",
"type": "select"
},
{
"option": {
"key": "2",
"value": "Medio"
},
"hideInOverview": false,
"name": "Impacto",
"columns": [],
"slug": "s1-impacto",
"defaultValue": "2",
"type": "select"
},
{
"option": {},
"hideInOverview": true,
"name": "Descripción Impacto",
"columns": [],
"slug": "s1-impacto-desc",
"defaultValue": "<h5>Bajo: La falla o problema no impide ni dificulta el uso del sistema.</h5><h5>Medio: La falla o problema dificulta el uso del sistema.</h5><h5>Crítico: La falla o problema impide totalmente el uso del sistema.</h5>",
"type": "markdown"
},
{
"option": {},
"hideInOverview": false,
"name": "Ingrese el problema",
"columns": [],
"slug": "s1-problema",
"defaultValue": "Esto es una prueba.",
"type": "textarea"
},
{
"option": {},
"hideInOverview": false,
"name": "Adjuntar captura de pantalla u otra evidencia",
"columns": [],
"slug": "s1-archivo-adjunto",
"defaultValue": "",
"fileUrl": "",
"type": "attachment"
},
{
"option": {},
"hideInOverview": false,
"name": "Resolucion",
"columns": [],
"slug": "s2-resolucion-mark",
"defaultValue": "<h3>Resolución del problema </h3>",
"type": "markdown"
},
{
"option": {},
"hideInOverview": false,
"name": "Ingrese la resolución del problema",
"columns": [],
"slug": "s2-resolucion",
"defaultValue": "Está solucionado. PRUEBA.",
"type": "textarea"
},
{
"option": {},
"hideInOverview": false,
"name": "Adjuntar captura de pantalla u otra evidencia",
"columns": [],
"slug": "s2-archivo-adjunto",
"defaultValue": "",
"fileUrl": "",
"type": "attachment"
},
{
"option": {},
"hideInOverview": false,
"name": "Resolucion Técnica",
"columns": [],
"slug": "s3-resolucion-mark",
"defaultValue": "<h3>Resolución técnica del problema </h3>",
"type": "markdown"
},
{
"option": {},
"hideInOverview": false,
"name": "Ingrese la resolución técnica del problema",
"columns": [],
"slug": "s3-resolucion-tecnica",
"defaultValue": "",
"type": "textarea"
},
{
"option": {},
"hideInOverview": false,
"name": "Adjuntar captura de pantalla u otra evidencia",
"columns": [],
"slug": "s3-archivo-adjunto",
"defaultValue": "",
"fileUrl": "",
"type": "attachment"
}
],
"caseNumber": 120,
"__v": 0,
"processVersion": 1,
"fields": {
"s1-datos-personales": "<h3>Reporte del problema </h3>",
"s1-sistema": "2",
"s1-impacto": "2",
"s1-impacto-desc": "<h5>Bajo: La falla o problema no impide ni dificulta el uso del sistema.</h5><h5>Medio: La falla o problema dificulta el uso del sistema.</h5><h5>Crítico: La falla o problema impide totalmente el uso del sistema.</h5>",
"s1-problema": "Esto es una prueba.",
"s1-archivo-adjunto": "",
"s2-resolucion-mark": "<h3>Resolución del problema </h3>",
"s2-resolucion": "Está solucionado. PRUEBA.",
"s2-archivo-adjunto": "",
"s3-resolucion-mark": "<h3>Resolución técnica del problema </h3>",
"s3-resolucion-tecnica": "",
"s3-archivo-adjunto": ""
},
"processSlug": "mesa-ayuda"
}
}resultCode
- 0: Operación realizada exitosamente.
- 1: Token inválido o expirado.
Notas
- En payload se entregará los datos del caso.
- El esquema presentado arriba no incluye información adicional, es decir, cuando se invoca con el parámetro “include” en 0 o se omite..
- Si no se encuentra el caso buscado, la propiedad “payload” de la respuesta estará vacío. El desarrollador deberá verificar que la prpiedad exista antes de utilizar sus datos.
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 |