Diferencias

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

Enlace a la vista de comparación

Ambos lados, revisión anteriorRevisión previa
Próxima revisión
Revisión previa
apiba360_12 [2025/03/05 17:54] – [Actualizar caso] aolanoapiba360_12 [2025/03/17 23:06] (actual) – [Consultar Catálogo de Documentos por ID] scantor
Línea 5109: Línea 5109:
     "code": 200,     "code": 200,
     "message": "Nota creada exitosamente.",     "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     "pagination": null
 } }
Línea 5526: 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>
 +
 +----
 +