Árbol de páginas

Versiones comparadas

Clave

  • Se ha añadido esta línea.
  • Se ha eliminado esta línea.
  • El formato se ha cambiado.

...

Info

Pendiente de revisar / retocar este diseño, alinear última versión de EAP y enlazar con REQ-INT

Entidades

EntidadDescripción
Documento
Documento con archivoDocumentoConsultaDocumento sin archivo
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

Nombre

code

Tipo

language

Descripción

xml
documentoRef
theme
String
RDark
    {
        "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"
    }
Bloque de código
languagexml
themeRDark
{ "documentoRef": "doc-001", "nombre": "documento-001",
Identificador del documento
nombreStringNombre del documento
versionStringVersión del documento
fechaCreacionDateFecha de creación del documento
tipoStringTipo de archivo
autorRefStringIdentificador del autor del documento.
Bloque de código
languagejs
themeMidnight
titleDocumento
collapsetrue
{
	"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

DocumentoConsultaDocumento
Crea un Documento y almacena el fichero Crea Documento
GET/documentos

q+s (query + sort)

La query estará formada por:

  • documentoRef
  • nombre
  • version
  • fechaCreacion
  • tipo
  • autorRef
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