Árbol de páginas

Estás viendo una versión antigua de esta página. Ve a la versión actual.

Comparar con el actual Ver el historial de la página

« Anterior Versión 17 Actual »



Sistema de Gestión Documental

Entidades

EntidadDescripción
DocumentoDatos 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

documentoRefStringIdentificador del documento
nombreStringNombre del documento
versionStringVersión del documento
fechaCreacionDateFecha de creación del documento
tipoStringTipo de archivo
autorRefStringIdentificador del autor del documento.
hashStringHash del documento. SHA-256
Documento
{
	"documentoRef": "6712829d-ea85-4b10-be25-5130dbb264fa",
	"nombre": "archivo.pdf",
	"version": 1,
	"fechaCreacion": "2022-03-07T10:15:52.527",
	"tipo": "application/pdf",
	"autorRef": "anonymous",
    "hash":"sdfsdfsdfsdfsdfs"
}


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:

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