Obtiene la lista de documentos existentes en el sistema ISOLUCIÓN.
HTTP GET: https://[service_address]/api/listadomaestro/[plantilla]
[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.
[plantilla]: Nombre de la plantilla (Ver PlantillaDocumental).
Header | Ejemplo | Descripción |
---|---|---|
Authorization | Basic Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ== |
Para la autorización sobre el API es necesario un usuario y contraseña, este usuario debe ser creado en el modulo de Usuarios de Isolucion, se recomienda crear un usuario único para la integración. Una vez creado el usuario se debe cifrar en base64 de la siguiente manera NombreUsuario:Contraseña el resultado debe ser algo parecido a Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ== Cuando se tenga este dato se debe enviar en el encabezado de la petición de la siguiente manera Basic Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ==
Referencias |
apiKey | YWJjZDEyMzQYWJjZDEyMzQYWJjZDEyMzQ-localhost | Llave otorgada para el uso del API. |
Content-Type | application/json | Tipo de contenido enviado en la solicitud. |
Respuesta en Formato JSON a la solicitud de obtener los datos registrados en el sistema.
Campo | Ejemplo | Descripción |
---|---|---|
StatusCode | "StatusCode":200 | Códigos HTTP de respuesta indicando si fue exitoso o no el request realizado. [200,500] Exito,Error. |
Message | "Message":"Lista de documentos obtenida exitosamente." | Descripción de la respuesta exitosa o mensaje de error enviado por el servidor. |
Entity | "Entity": [[{data1},{data2}...],null] | Formato JSON con el listado de documentos por plantilla registrados en el sistema. En el caso de respuesta no exitosa el valor es nulo. |
Sample Ok Response:
{ "StatusCode": 200, "Message": "Lista de plantillas obtenida exitosamente.", "Entity": [{\"Id_ListadoMaestroDocumentos\":3644,\"CodArticulo\":170,\"TituloDocumento\":\"715f4039-0969-48a8-80cf-d60e10a609da\",\"Fecha\":\"2020-04-01T00:00:00\",\"Url\":\"/BancoConocimientoQA/0/0b4d63c5f71b496f8ab0d7ee8c4fa307/0b4d63c5f71b496f8ab0d7ee8c4fa307.asp\",\"Plantilla\":\"Formato\",\"Codigo\":\"COD R.COD R-010\",\"Proceso\":\"Aseguramiento de calidad\",\"Autor\":\"Oscar R\",\"Version\":\"0\",\"FechaDeActualizacion\":\"2022-10-31T10:45:00\",\"Revisa\":\"\",\"Aprueba\":\"\",\"FechaAprobacion\":\"1900-01-01T00:00:00\"},{\"Id_ListadoMaestroDocumentos\":4023,\"CodArticulo\":3620,\"TituloDocumento\":\"Archivo 6 XLSX Aprobado\",\"Fecha\":\"2023-12-24T00:00:00\",\"Url\":\"/BancoConocimientoQA/a/a7ea3257fd1c4d51b7359b2c613e4df1/a7ea3257fd1c4d51b7359b2c613e4df1.asp\",\"Plantilla\":\"Formato\",\"Codigo\":\"ABC-XYZ-004\",\"Proceso\":\"Proceso SC2\",\"Autor\":\"Croft\",\"Version\":\"6\",\"FechaDeActualizacion\":\"2023-12-27T19:51:00\",\"Revisa\":\"ABC USUARIO 1 CARGUE MASIVO,Jhonny Gonzalez, Pruebas\",\"Aprueba\":\"Jhonny Gonzalez, Pruebas,ABC PROENFAR 31\",\"FechaAprobacion\":\"2023-12-26T00:00:00\"}] }
Sample ERROR Response:
{ "StatusCode": 401, "Message": "Unauthorized : *DESCRIPCION ERROR NO AUTORIZADO*.", "Entity": null }
{ "StatusCode": 500, "Message": "InternalServerError : La solicitud no fue procesada.", "Entity": null }