...
Sistema de Gestión Documental
...
Pendiente de revisar / retocar este diseño, alinear última versión de EAP y enlazar con REQ-INT
Entidades
| Entidad | Descripción |
|---|---|
| Documento | Datos del documento |
Modelo lógico
API
Características generales que todas las API REST deben de cumplir:
Definición de los objetos
Documento
Nombre | Tipo | Descripción |
|---|---|---|
| documentoRef | String | Identificador del documento |
| nombre | String | Nombre del documento |
| version | String | Versión del documento |
| fechaCreacion | Date | Fecha de creación del documento |
| tipo | String | Tipo de archivo |
| autorRef | String | Identificador del autor del documento. |
| Bloque de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"documentoRef": "6712829d-ea85-4b10-be25-5130dbb264fa",
"nombre": "archivo.pdf",
"version": 1,
"fechaCreacion": "2022-03-07T10:15:52.527",
"tipo": "application/pdf",
"autorRef": "anonymous"
} |
Servicios
Método | URL | Parámetros | Respuesta | Permisos | Descripción |
|---|---|---|---|---|---|
| POST | /documentos | archivo: fichero binario (multipart/form-data) | Documento | Crea un Documento y almacena el fichero | |
| GET | /documentos | q+s (query + sort) La query estará formada por:
| Lista[Documento] | Listado de Documento Ejemplo: nombre=ik=documento | |
| GET | /documentos/{id} | Documento | Detalle de Documento | ||
| GET | /documentos/bydocumentorefs/{ids} | lista de identificadores separados por "," | Lista[Documento] | Listado de Documento | |
| GET | /documentos/{id}/archivo | Fichero binario | Archivo binario del documento |