Versions Compared

Version Old Version 78 New Version 79
Changes made by

Víctor Sánchez

Víctor Sánchez

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
stylenone

...

Modo

Endpoint

Descripción

Documento

POST

/api/v1/file/

Crea un nuevo documento.

GET

/api/v1/file/{uuid}/

Obtiene un documento en formato JSON indicando su uuid.

PUT

/api/v1/file/{uuid}/

Modifica un documento indicando su uuid.

DELETE

/api/v1/file/{uuid}/

Elimina un documento indicando su uuid.

GET

/api/v1/file/{uuid}/download/

Descarga el contenido de un documento.

POST

/api/v1/file/download/

Descarga el contenido de un listado de documentos.

POST

/api/v1/file/{uuid}/lifecycle/transition

Ejecuta una transición sobre el ciclo de vida de un documento.

Comentario

GET

/api/v1/file/{file_uuid}/comment/

Obtiene los comentarios de un documento indicando el file_uuid del documento.

POST

/api/v1/file/{file_uuid}/comment/

Crea un nuevo comentario sobre un documento.

GET

/api/v1/file/{file_uuid}/comment/{uuid}/

Obtiene un comentario de un documento indicando el uuid de ambos.

PUT

/api/v1/file/{file_uuid}/comment/{uuid}/

Modifica un comentario indicando su uuid y el file_uuid del documento.

DELETE

/api/v1/file/{file_uuid}/comment/{uuid}/

Borra un comentario indicando su uuid y el file_uuid del documento.

Búsqueda

POST

/api/v1/search/query

Busca documentos ejecutando una query ATQL y obteniendo los documentos como entidad.

POST

/api/v1/search/resultset

Busca documentos ejecutando una query ATQL y obteniendo las columnas incluidas en la cláusula SELECT.

Usuario

POST

/api/v1/user/

Crea un nuevo usuario.

GET

/api/v1/user/{username}/

Obtiene un usuario en formato JSON indicando su username.

PUT

/api/v1/user/{username}/

Modifica un usuario existente.

POST

/api/v1/user/{username}/activate

Activa un usuario.

POST

/api/v1/user/{username}/deactivate

Desactiva un usuario.

Grupo

POST

/api/v1/group/

Crea un nuevo grupo.

GET

/api/v1/group/{name}/

Obtiene un grupo en formato JSON indicando su name.

...

Campo

Descripción

uuid

Identificador del documento

filename ó title

Título del documento

author

Creador del documento

creation_date o created

Fecha de creación del documento

modified_date o modified

Fecha de modificación del documento

validation_date o validated

Fecha de validación del documento

space ó serie

Espacio donde se encuentra el documento

form ó doctype

Nombre del formulario

life_cycle_state

Ciclo de vida del documento

state

Estado del documento

size

Tamaño del documento

relations

Documentos relacionados

children

Documentos hijos

Ejemplos:

Code Block
languagesql
SELECT filename, form, space, state FROM my_form WHERE \
       ((filename = 'PDF-Athento-One.pdf') \
      AND space = 'Documentos_aeuxa') OR filename = 'PDF-Athento.pdf'
      
SELECT uuid, creation_date FROM my_form WHERE \
      (creation_date BETWEEN '2022-01-01' AND '2022-12-31' \
      OR modified_date > '2022-12-01') \
      AND NOT state = 'pending' ORDER BY creation_date
      
SELECT * FROM my_form WHERE life_cycle_state = 'Iniciado' ORDER BY uuid DESC

SELECT count(life_cycle_state) FROM my_form WHERE life_cycle_state != 'Iniciado' GROUP BY life_cycle_state

...