...
Info |
---|
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
DocumentoConsulta
code
language
xml
theme
RDark Bloque de código
{
"documentoRef": "doc-001",
"nombre": "documento-001",
Nombre |
---|
Tipo |
---|
Descripción |
---|
documentoRef |
String |
{
"documentoRef": "doc-001",
"nombre": "documento-001",
"version": 1,
"archivo": "124532145345345" // documento binario hex
"fechaCreacion": "2020-10-01T00:00:00",
"tipo": "application/pdf",
"autorRef": "user-001"
}
language | xml |
---|---|
theme | RDark |
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) archivo :ficherobinario | DocumentoConsulta | Documento | Crea un Documento y almacena el fichero Crea Documento | |
GET | /documentos | q+s (query + sort) La query estará formada por:
| Lista[DocumentoConsultaDocumento] | Listado de Documento Ejemplo: nombre=ik=documento | ||
GET | /documentos/{id} | Documento (con archivo binario) | Detalle de Documento | |||
GET | /documentos/bydocumentorefs/{ids} | lista de identificadores separados por "," <documentoId>|<documentoId>|..... | Lista[DocumentoConsultaDocumento] | Listado de Documento | ||
GET | /documentos/{id}/archivo | fichero-Fichero binario | Archivo binario del documento |