Sistema de Gestión Documental
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. |
hash | String | Hash del documento |
Servicios
Para componer la URL llamada completa, se debe anteponer a lo indicado en la columna URL lo siguiente: {HOST}/api/sgdoc, donde {HOST} de deberá sustituir el dominio correspondiente al entorno al que se está accediendo y dicho acceso será por http o https según el caso.
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 |