Diferencias

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

--- apiba360_12 [2025/02/05 21:10] – [Actualizar cuenta] scantor
+++ apiba360_12 [2025/03/17 23:06] (actual) – [Consultar Catálogo de Documentos por ID] scantor
@@ Línea 135: / Línea 135: @@
 <code java>
-X-BA360-Company: {company}
+X-BA360-Company
 </code>
-Se debe agregar en este parámetro el valor del **company** de la instancia de Be Aware 360.
+Se debe agregar en este parámetro el valor del **company** de la instancia de Be Aware 360, el cual corresponde al nombre de la instancia de Be Aware 360.
 **Campos:**
@@ Línea 1433: / Línea 1433: @@
 === Request: ===
+**Autenticación:**
+Este recurso requiere que se envíe en los Headers los parámetros relacionados en [[apiba360_12#Configuración Headers para todos los recursos de la API de Be Aware 360|Configuración Headers para todos los recursos de la API de Be Aware 360]].
 **Parámetros:**
@@ Línea 1441: / Línea 1445: @@
   No requiere enviar campos.
-**Autenticación:**
-Este recurso requiere que se envíe en los Headers los parámetros relacionados en [[apiba360_12#Configuración Headers para todos los recursos de la API de Be Aware 360|Configuración Headers para todos los recursos de la API de Be Aware 360]].
 **Ejemplo:**
@@ Línea 3732: / Línea 3732: @@
 === Request: ===
+**Autenticación:**
+Este recurso requiere que se envíe en los Headers los parámetros relacionados en [[apiba360_12#Configuración Headers para todos los recursos de la API de Be Aware 360|Configuración Headers para todos los recursos de la API de Be Aware 360]].
 **Parámetros:**
@@ Línea 3911: / Línea 3915: @@
 === Request: ===
+**Autenticación:**
+Este recurso requiere que se envíe en los Headers los parámetros relacionados en [[apiba360_12#Configuración Headers para todos los recursos de la API de Be Aware 360|Configuración Headers para todos los recursos de la API de Be Aware 360]].
 **Parámetros:**
@@ Línea 3933: / Línea 3941: @@
 | idusuarioasignado | Id del usuario asignado al caso | Integer | No | Esta es la lógica que emplea Be Aware 360 cuando se actualiza el asignado de un caso: \\ \\  * Si se envía ID asignado válido, lo asigna al caso. \\  * Si se envía ID asignado inválido, deja Caso sin asignado. \\  * Si no se envía parámetro de asignado, deja Caso sin asignado. \\  * Si se envía ID asignado NULL, deja al Caso sin asignado. \\  * Si se envía un ID asignado de un usuario que está //Inactivo//, lo asigna al Caso. | 3 |
 | cf | Campos personalizados del caso | Lista (depende del tipo de campo) | Depende de la configuración del campo personalizado si fue marcado como obligatorio. | Lista de campos personalizados con su valor correspondiente, separados por comas y entre corchetes {}. **Nota:** Los campos de tipo fecha deben ir especificados con la zona horaria, de lo contrario tomará 00:00 UTC-0 | {"guia": "2345", "fecha guía": "2020-01-06T05:00:00.000Z"} |
+| finalizado| Indica si el caso está finalizado. 0 indica que el caso no está finalizado y 1 indica que sí está finalizado el caso. | Integer | Sí |  | 0 |
 | id | Id del caso que se va a actualizar | Integer | Sí |  | 8 |
@@ Línea 3955: / Línea 3964: @@
 		"guia": "0987655",
 		"fecha_compra": "2020-07-02T05:00:00.000Z",
-		"nombre": "Cambio de nombre"},
+		"nombre": "Cambio de nombre"
+         },
+        "finalizado": 0,
 	"id": 183
 }
@@ Línea 4070: / Línea 4081: @@
 === Request: ===
+**Autenticación:**
+Este recurso requiere que se envíe en los Headers los parámetros relacionados en [[apiba360_12#Configuración Headers para todos los recursos de la API de Be Aware 360|Configuración Headers para todos los recursos de la API de Be Aware 360]].
 **Parámetros:**
@@ Línea 4077: / Línea 4092: @@
 **Campos:**
   No requiere enviar campos.
-**Autenticación:**
-Este recurso requiere que se envíe en los Headers los parámetros relacionados en [[apiba360_12#Configuración Headers para todos los recursos de la API de Be Aware 360|Configuración Headers para todos los recursos de la API de Be Aware 360]].
 **Ejemplo:**
@@ Línea 4648: / Línea 4659: @@
 === Request: ===
+**Autenticación:**
+Este recurso requiere que se envíe en los Headers los parámetros relacionados en [[apiba360_12#Configuración Headers para todos los recursos de la API de Be Aware 360|Configuración Headers para todos los recursos de la API de Be Aware 360]].
 **Parámetros:**
@@ Línea 4673: / Línea 4688: @@
 }
 </code>
-**Autenticación:**
-Este recurso requiere que se envíe en los Headers los parámetros relacionados en [[apiba360_12#Configuración Headers para todos los recursos de la API de Be Aware 360|Configuración Headers para todos los recursos de la API de Be Aware 360]].
 ----
@@ Línea 4734: / Línea 4745: @@
 === Request: ===
+**Autenticación:**
+Este recurso requiere que se envíe en los Headers los parámetros relacionados en [[apiba360_12#Configuración Headers para todos los recursos de la API de Be Aware 360|Configuración Headers para todos los recursos de la API de Be Aware 360]].
 **Parámetros:**
@@ Línea 5094: / Línea 5109: @@
     "code": 200,
     "message": "Nota creada exitosamente.",
+    "pagination": null
+}
+</code>
+----
+==== Consultar archivos adjuntos del caso ====
+----
+=== Método ===
+''**GET**''
+----
+=== URL Recurso ===
+**%%https://api.beaware360.com/ba360/apir/v12/archivos/get?idobjeto=<id_caso>&tipoobjeto=casos%%**.
+----
+=== Request: ===
+**Parámetros:**
+  idobjeto -> Corresponde al id del caso.
+  tipoobjeto -> Corresponde al tipo de objeto del cual se están consultando las notas. En este caso el valor corresponde a //caso//.
+**Autenticación:**
+Este recurso requiere que se envíe en los Headers los parámetros relacionados en [[apiba360_12#Configuración Headers para todos los recursos de la API de Be Aware 360|Configuración Headers para todos los recursos de la API de Be Aware 360]].
+**Campos:**
+No requiere enviar campos.
+**Ejemplo:**
+%%https://api.beaware360.com/ba360/apir/v12/archivos/get?idobjeto=442&tipoobjeto=casos%%
+----
+=== Response ===
+El sistema retorna los archivos adjuntos del caso consultado.
+**Ejemplo:**
+<code java>
+{
+    "data": [
+        {
+            "idrol": 6,
+            "nombre": "Archivo de prueba.pdf",
+            "idstage": 47,
+            "metadatos": [
+                {
+                    "clave": "GRUPO_DOCUMENTO",
+                    "valor": "43"
+                },
+                {
+                    "clave": " TIPO_DOCUMENTO",
+                    "valor": "752"
+                }
+            ],
+            "idusuario": 29,
+            "idobjeto": 442,
+            "tipoobjeto": "casos",
+            "fechacreacion": "2025-03-17 21:38:07",
+            "file": null,
+            "idtipodocumento": 1,
+            "seen": 0,
+            "tipodocumento": "Acta de nacimiento",
+            "tag": "Archivo de prueba.pdf",
+            "filesize": 15895,
+            "clasificacion": null,
+            "idusuariodesc": "Juan Pérez",
+            "idroldesc": "Ejecutivo de atención",
+            "idstagedesc": "Registro información",
+            "eid": null,
+            "uuid": null,
+            "id": 255
+        },
+        {
+            "idrol": 6,
+            "nombre": "Documento de reembolso.pdf",
+            "idstage": 47,
+            "metadatos": [
+                {
+                    "clave": "GRUPO_DOCUMENTO",
+                    "valor": "5050010005"
+                },
+                {
+                    "clave": "TIPO_DOCUMENTO",
+                    "valor": "5050010005009"
+                }
+            ],
+            "idusuario": 29,
+            "idobjeto": 442,
+            "tipoobjeto": "casos",
+            "fechacreacion": "2025-03-17 21:38:32",
+            "file": null,
+            "idtipodocumento": 5,
+            "seen": 0,
+            "tipodocumento": "Reembolso de pago",
+            "tag": "Documento de reembolso.pdf",
+            "filesize": 15804,
+            "clasificacion": null,
+            "idusuariodesc": "Juan Pérez",
+            "idroldesc": "Ejecutivo de atención",
+            "idstagedesc": "Análisis de Información",
+            "eid": null,
+            "uuid": null,
+            "id": 256
+        }
+    ],
+    "code": 200,
+    "message": null,
     "pagination": null
 }
@@ Línea 5111: / Línea 5244: @@
 === URL Recurso ===
-**%%https://api.beaware360.com/ba360/uploadfile%%**.
+**%%https://api.beaware360.com/ba360/v12/uploadfile%%**.
 ----
@@ Línea 5166: / Línea 5299: @@
 === URL Recurso ===
-**%%https://api.beaware360.com/ba360/downloadfile%%**.
+**%%https://api.beaware360.com/ba360/v12/downloadfile%%**.
 ----
@@ Línea 5217: / Línea 5350: @@
 === Request: ===
+**Autenticación:**
+Este recurso requiere que se envíe en los Headers los parámetros relacionados en [[apiba360_12#Configuración Headers para todos los recursos de la API de Be Aware 360|Configuración Headers para todos los recursos de la API de Be Aware 360]].
 **Parámetros:**
@@ Línea 5507: / Línea 5644: @@
 ----
+===== Recursos para Catálogo de Documentos =====
+==== Consultar Catálogo de Documentos ====
+----
+=== Método ===
+''**GET**''
+----
+=== URL Recurso ===
+https://api.beaware360.com/ba360/apir/v12/catalogodocumentos/get
+----
+=== Request: ===
+**Autenticación:**
+Este recurso requiere que se envíe en los Headers los parámetros relacionados en [[apiba360_12#Configuración Headers para todos los recursos de la API de Be Aware 360|Configuración Headers para todos los recursos de la API de Be Aware 360]].
+----
+=== Response ===
+Retorna la lista de los catálogos de documentos.
+**Ejemplo:**
+<code java>
+{
+    "data": [
+        {
+            "idusuariocreacion": 3,
+            "idusuariomodificacion": 0,
+            "metadatos": [],
+            "fechacreacion": "2025-02-27 05:08:26",
+            "tipodocumento": "Cédula de ciudadanía",
+            "idusuariomodificaciondesc": null,
+            "idusuariocreaciondesc": "scantor",
+            "extensionespermitidas": "pdf, jpg, jpeg, png",
+            "eid": null,
+            "uuid": null,
+            "id": 1
+        },
+        {
+            "idusuariocreacion": 3,
+            "idusuariomodificacion": 0,
+            "metadatos": [],
+            "fechacreacion": "2025-02-28 20:30:31",
+            "tipodocumento": "Certificado de libertad y tradición del inmueble",
+            "idusuariomodificaciondesc": null,
+            "idusuariocreaciondesc": "scantor",
+            "extensionespermitidas": "zip, rar, docx, pdf",
+            "eid": null,
+            "uuid": null,
+            "id": 2
+        }
+}
+</code>
+----
+==== Consultar Catálogo de Documentos por ID ====
+----
+=== Método ===
+''**GET**''
+----
+=== URL Recurso ===
+**%%https://api.beaware360.com/ba360/apir/v12/catalogodocumentos/getby?id=<id_catálogodocumento>%%**.
+----
+=== Request: ===
+**Parámetros:**
+  id -> Recibe el id del catálogo de documentos en Be Aware 360.
+**Campos:**
+  No requiere enviar campos.
+**Autenticación:**
+Este recurso requiere que se envíe en los Headers los parámetros relacionados en [[apiba360_12#Configuración Headers para todos los recursos de la API de Be Aware 360|Configuración Headers para todos los recursos de la API de Be Aware 360]].
+**Ejemplo:**
+<code java>
+https://api.beaware360.com/ba360/apir/v12/catalogodocumentos/getby?id=3
+</code>
+----
+=== Response ===
+Retorna la información de un catálogo de documentos en específico, según su Id en Be Aware 360.
+**Ejemplo:**
+<code java>
+{
+    "data": [
+        {
+            "idusuariocreacion": 3,
+            "idusuariomodificacion": 0,
+            "metadatos": [],
+            "fechacreacion": "2025-02-28 20:30:31",
+            "tipodocumento": "Certificado de libertad y tradición del inmueble",
+            "idusuariomodificaciondesc": null,
+            "idusuariocreaciondesc": "scantor",
+            "extensionespermitidas": "zip, rar, docx, pdf",
+            "eid": null,
+            "uuid": null,
+            "id": 2
+        }
+}
+</code>
+----