Diferencias

Muestra las diferencias entre dos versiones de la página.

--- apiba360_105 [2025/07/10 21:35] – [Actualizar caso] scantor
+++ apiba360_105 [2025/12/24 17:49] (actual) – [Paso 3. Obtenga el token (GetToken)] aolano
@@ Línea 93: / Línea 93: @@
 ^ Recursos ^ Descripción ^ Método ^ URL Recurso ^
 | [[apiba360_105#Crear una actividad programada|Crear una actividad programada]] | Hace la creación de un caso en Be Aware 360. | POST | %%https://api.beaware360.com/ba360/apir/v10_5/fsactividad/add%% |
+==== Gestión del Checklist ====
+^ Recursos ^ Descripción ^ Método ^ URL Recurso ^
+| [[apiba360_105#Consultar lista de tareas de un caso|Consultar lista de tareas del caso]] | Consultar las tareas de un caso específico. | GET | %%https://api.beaware360.com/ba360/apir/v10_5/checklist/tareas/get?idcaso=<id_caso>%% |
+| [[apiba360_105#Hacer check en tarea de un caso|Hacer check en tarea de un caso]] | Hacer check a una tarea de un caso. | POST | %%https://api.beaware360.com/ba360/apir/v10_5/caso/done%% |
+| [[apiba360_105#Hacer uncheck en tarea de un caso|Hacer uncheck en tarea de un caso]] | Hacer uncheck a una tarea de un caso. | POST | %%https://api.beaware360.com/ba360/apir/v10_5/caso/undone%% |
 ===== Primeros pasos =====
@@ Línea 216: / Línea 224: @@
 Una vez haya obtenido el token, podrá consumir los recursos de la API REST de Be Aware 360.
+** Importante **
+Control de Acceso por Intentos Fallidos (En Desarrollo) : El sistema realiza un bloqueo automático del proceso de autenticación de un usuario, cuando este realiza varios intentos fallidos de forma consecutiva
+      - El máximo de intentos antes de que la cuenta sea bloqueada es de 5
+      - El tiempo de bloqueo establecido es de 5 minutos
+      - Pasados los 5 minutos el usuario podrá intentar de nuevo la autenticación
+      - Cuando una cuenta esté bloqueada, el servicio API retornará el código 401
+      - **Importante:** Este bloqueo se aplica para los intentos de login a través del FRONT (Consola) y de la API REST de Be Aware 360 (para más información sobre la autenticación en Consola de Be Aware  haga clic [[gestiondeusuarios#autenticacion_en_be_aware_360_en_desarrollo|aquí]].)
 ===== Recursos para Contactos =====
@@ Línea 7149: / Línea 7166: @@
 ----
 ==== Consultar Catálogo de Documentos por ID ====
@@ Línea 7213: / Línea 7232: @@
             "id": 2
         }
+}
+</code>
+----
+===== Gestión del Checklist =====
+==== Consultar lista de tareas de un caso ====
+----
+=== Método ===
+''**GET**''
+----
+=== URL Recurso ===
+**%%https://api.beaware360.com/ba360/apir/v10_5/checklist/tareas/get?idcaso=<id_caso>%%**
+----
+=== Request: ===
+**Parámetros:**
+id_caso -> Corresponde al id del caso.
+**Autenticación:**
+^ Tipo de autenticación ^ Usuario ^ Contraseña ^
+| Basic Auth | //compañia/usuario//. Por ejemplo ba360review/aatencion | El Token obtenido en [[apiba360_105#Paso 3. Obtenga el token (GetToken)|GetToken]]. |
+**Campos:**
+No requiere enviar campos.
+**Ejemplo:**
+%%https://api.beaware360.com/ba360/apir/v10_5/checklist/tareas/get?idcaso=129%%
+----
+=== Response ===
+El sistema retorna las tareas asociadas al paso del caso específico.
+**Ejemplo:**
+<code java>
+{
+    "data": [
+        {
+            "tipo": 0,
+            "valor": 0,
+            "descripcion": "Acordar con el cliente la fecha y hora de la sesión",
+            "activo": 1,
+            "expiracion": 0,
+            "fhsubmit": null,
+            "totalchecklisttareas": null,
+            "idtipo": 0,
+            "idusuariomodificacion": null,
+            "estadoaprobacion": null,
+            "comentario": null,
+            "status": 0,
+            "idencuesta": null,
+            "idchecklist": 15,
+            "orden": 1,
+            "idurl": null,
+            "idhtml": null,
+            "idscript": null,
+            "idaprobacion": null,
+            "script": null,
+            "estadocaso": 0,
+            "obligatorio": 1,
+            "fhmodificacion": null,
+            "estadoactividad": 0,
+            "idchecklistdesc": "SPA - Contactar al cliente",
+            "urlexpiracion": -1,
+            "autosave": 0,
+            "id": 370,
+            "eid": null,
+            "uuid": null
+        },
+        {
+            "tipo": 5,
+            "valor": 0,
+            "descripcion": "Encuesta de prueba",
+            "activo": 1,
+            "expiracion": 0,
+            "fhsubmit": null,
+            "totalchecklisttareas": null,
+            "idtipo": 1,
+            "idusuariomodificacion": null,
+            "estadoaprobacion": null,
+            "comentario": null,
+            "status": 0,
+            "idencuesta": null,
+            "idchecklist": 15,
+            "orden": 4,
+            "idurl": null,
+            "idhtml": null,
+            "idscript": null,
+            "idaprobacion": null,
+            "script": null,
+            "estadocaso": 0,
+            "obligatorio": 1,
+            "fhmodificacion": null,
+            "estadoactividad": 0,
+            "idchecklistdesc": "SPA - Contactar al cliente",
+            "urlexpiracion": -1,
+            "autosave": 0,
+            "id": 333,
+            "eid": null,
+            "uuid": null
+        }
+    ],
+    "code": 200,
+    "message": null,
+    "pagination": null
+}</code>
+----
+==== Hacer check en tarea de un caso ====
+----
+=== Método ===
+''**POST**''
+----
+=== URL Recurso ===
+**%%https://api.beaware360.com/ba360/apir/v10_5/caso/done%%**.
+----
+=== Request: ===
+**Parámetros:**
+  Este recurso no recibe parámetros
+**Autenticación:**
+^ Tipo de autenticación ^ Usuario ^ Contraseña ^
+| Basic Auth | //compañia/usuario//. Por ejemplo ba360review/aatencion | El Token obtenido en [[apiba360_105#Paso 3. Obtenga el token (GetToken)|GetToken]]. |
+**Campos:**
+^ Campo API ^ Descripción ^ Tipo de dato ^ Requerido ^ Comentario ^ Ejemplo ^
+| idcaso | Id del caso al que pertenece la tarea | Integer | Sí |  | 28 |
+| idtarea | Id de la tarea que se quiere checkear | Integer | Sí |  | 100 |
+| origin | Ambiente desde el que se genera el chequeo | String | Sí |  | “ba360review.deskbeaware.com” |
+**Ejemplo:**
+<code java>
+{
+	"idcaso": 39206,
+	"idtarea": 323,
+	"origin": "ba360review.deskbeaware.com"
+}
+</code>
+----
+=== Response ===
+El sistema hace check a la tarea en el caso.
+**Ejemplo:**
+<code java>
+{
+    "data": {
+        "checklist": {
+            "idactividad": null,
+            "idusuario": 8,
+            "fhsubmit": null,
+            "idcaso": 39026,
+            "idusuariomodificacion": 8,
+            "idtarea": 323,
+            "estadoaprobacion": null,
+            "comentario": null,
+            "status": 1,
+            "origin": "ba360review.deskbeaware.com",
+            "idtareadesc": null,
+            "idusuariodesc": null,
+            "fhmodificacion": null,
+            "id": 2012,
+            "eid": null,
+            "uuid": null
+        }
+    },
+    "code": 200,
+    "message": null,
+    "pagination": null
+}</code>
+----
+==== Hacer uncheck en tarea de un caso ====
+----
+=== Método ===
+''**POST**''
+----
+=== URL Recurso ===
+**%%https://api.beaware360.com/ba360/apir/v10_5/caso/undone%%**.
+----
+=== Request: ===
+**Parámetros:**
+  Este recurso no recibe parámetros
+**Autenticación:**
+^ Tipo de autenticación ^ Usuario ^ Contraseña ^
+| Basic Auth | //compañia/usuario//. Por ejemplo ba360review/aatencion | El Token obtenido en [[apiba360_105#Paso 3. Obtenga el token (GetToken)|GetToken]]. |
+**Campos:**
+^ Campo API ^ Descripción ^ Tipo de dato ^ Requerido ^ Comentario ^ Ejemplo ^
+| idcaso | Id del caso al que pertenece la tarea | Integer | Sí |  | 28 |
+| idtarea | Id de la tarea que se quiere checkear | Integer | Sí |  | 100 |
+| origin | Ambiente desde el que se genera el chequeo | String | Sí |  | “ba360review.deskbeaware.com” |
+**Ejemplo:**
+<code java>
+{
+	"idcaso": 39206,
+	"idtarea": 323,
+	"origin": "ba360review.deskbeaware.com"
+}
+</code>
+----
+=== Response ===
+El sistema hace uncheck a la tarea en el caso.
+**Ejemplo:**
+<code java>
+{
+    "data": {
+        "idactividad": null,
+        "idusuario": 8,
+        "fhsubmit": null,
+        "idcaso": 39026,
+        "idusuariomodificacion": 8,
+        "idtarea": 323,
+        "estadoaprobacion": null,
+        "comentario": null,
+        "status": 0,
+        "origin": "ba360review.deskbeaware.com",
+        "idtareadesc": null,
+        "idusuariodesc": null,
+        "fhmodificacion": null,
+        "id": 2012,
+        "eid": null,
+        "uuid": null
+    },
+    "code": 200,
+    "message": null,
+    "pagination": null
 }
 </code>