Visión general

La API v1 RESTful es la vía de comunicación de Athento para conectar con toda la funcionalidad del sistema. Provee un modelo unificado de llamadas para cualquier tipo de operación sobre el modelo documental ofreciendo flexibilidad y seguridad.

Cómo usar la API v1

La API v1 de Athento es una RESTful Web API que permite acceder a todas las funcionalidades del modelo documental de Athento.

Uso rápido

A continuación se listan los endpoints actuales de la API v1.

Modo	Endpoint	Descripción

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}/`	Modificación 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/{uuid}/lifecycle/transition`	Ejecuta una transición sobre el ciclo de vida de un 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`.

Acceda a Athento Explorer

Use Athento Explorer para poder gestionar las llamadas a los endpoints de la API v1 en la ruta /api/v1/explorer de su instancia. Por ejemplo en https://demo.athento.com/api/v1/explorer.

Para usar Athento Explorer debe iniciar sesión.

Athento Explorer

Especificaciones generales

Formatos

Cabeceras

Nombre	Valores	Opcional

Nombre

Valores

Opcional

Content-Type

application/json

multipart/form-data

False

Fetch-Mode

default

extended

full

True

Descripción

Content-Type: es el tipo de contenido que se usará en las llamadas a la API v1.
Fetch-Mode: es el tipo modo de obtención de la entidad que se pretende consultar donde:
- default: es la obtención por defecto, con la información mínima suficiente.
- extended: obtención extendida de la entidad y sus relaciones, donde se informa de atributos más destacados de la misma.
- full: obtención completa de la entidad y sus relaciones.

Petición

{
   "<KEY>": "<VALUE>",
   "<OBJECT>": {
       "<KEY>": "<VALUE>",       ...
   }
}

Respuesta

El formato de respuesta de la API v1 tendrá siempre un formato estándar representado con tipo de contenido JSON y con la siguiente estructura:

{
   "request-id": "<UUID>",
   "response": {
       "message": "<EXECUTION MESSAGE>",
       "code": <EXECUTION CODE>
   },
   "result": {
      "entity": "<ENTITY>",
       <REST OF JSON RESPONSE>
   }
}

Documento — Document Entity

El documento es la pieza fundamental de almacenamiento en Athento. La API v1 ofrece la posibilidad de operar con ellos para crear, modificar, eliminar y consultarlos.

A continuación se muestra la representación de un documento por defecto.

{
    "entity": "Document",
    "uuid": "a8b16f41-65a0-481c-bb1a-e094011fee14",
    "filename": "PDF-Athento.pdf",
    "creation_date": "2022-12-07T16:45:03.302424+01:00",
    "modified_date": "2022-12-07T16:45:06.048175+01:00",
    "state": "pending",
    "version": "0.0",
    "author": "benchmark",
    "serie": "my_space",
    "doctype": "my_form",
    "container": false,
    "file": {
        "url": "uploads/.../2d/9c/2d9c09cdb21fd0a56eefd627240d554f.pdf",
        "extension": ".pdf",
        "hash": "2d9c09cdb21fd0a56eefd627240d554f",
        "size": 34073,
        "content_type": "application/pdf"
    },
    "life_cycle_state": "started"
}

Cuando un documento tiene contenido binario, el atributo file aparece en la representación de la entidad. Otros elementos como el life_cycle_state, etc. se comportan del mismo modo.

Crear un documento

Llamada genérica de creación:

Crear documento

Un documento en Athento es una entidad de un cierto tipo documental, o también llamado formulario, que se aloja en un Espacio —también llamado Serie documental— concreto. Dicho documento, puede tener o no un contenido principal —archivo binario— asociado. En este caso, comenzamos con la creación de un documento de Athento, donde no se especifica un binario asociado.

Content-Type: application/json

Petición:

Respuesta:

Crear documento con contenido

A continuación el servicio de creación de nuevo documento con un binario asociado.

Content-Type: multipart/form-data

Petición:

Respuesta:

Crear documento a partir de plantilla

Creación de un documento a partir de una plantilla. En primer (por defecto) o segundo plano.

Content-Type: multipart/form-data

Nombre	Valores	Opcional

Nombre	Valores	Opcional
template	Nombre o UUID de la plantilla	True
background	Realizar la generación del binario en segundo plano `true\|false`	True

Petición:

Respuesta:

Actualizar un documento

Llamada genérica de actualización:

Actualizar documento

Para actualizar un documento, se hace uso del identificador del mismo y los atributos o metadatos asociados que pretenden actualizarse.

Content-Type: application/json

Petición:

Respuesta:

Actualizar contenido

La actualización del contenido de un documento, donde se le asocia un archivo binario.

Nombre	Valores	Opcional

Nombre	Valores	Opcional
Content-Type	`multipart/form-data`	False

Content-Type: multipart/form-data

Nombre	Valores	Opcional

Nombre	Valores	Opcional
file-uuid	Identificador del documento a modificar.	False

Petición:

Respuesta:

Eliminar un documento

Llamada genérica de eliminación:

Eliminar documento

La eliminación de un documento siempre se hace de forma lógica, manteniendo la posibilidad de localizar, y/o recuperar su información. En la respuesta se obtiene el atributo removed con valor true.

Respuesta:

Descargar el contenido de un documento

Llamada genérica de descarga:

Descarga del contenido

Ejecutar transición de estado para un documento

Llamada genérica de transición:

Ejecución de la transición

Un documento puede tener un ciclo de vida asociado y, desde este servicio, es posible ejecutar una transición desde el estado donde se encuentre. Para ello, basta con informar del nombre de la transición que se quiere ejecutar (o el propio uuid).

Además, si el documento incluye varios ciclos de vida asociados (parallel lifecycles) es posible indicar sobre qué ciclo de vida será ejecutada la transición, informando del nombre (o del uuid) y del parámetro parallel con valor true.

Content-Type: application/json

Petición:

Respuesta:

Usuarios — User Entity

Athento permite la gestión de usuarios desde la API v1 para crear nuevos, consultar, editar y operaciones asociadas.

A continuación se muestra la representación de un usuario.

Crear un usuario

Llamada genérica de creación:

Crear usuario

Content-Type: application/json

Nombre	Valores	Opcional

Nombre	Valores	Opcional
`username`	Nombre del usuario	False
`email`	Email del usuario	False
`first_name`	Nombre de la persona	True
`last_name`	Apellidos de la persona	True
`job_title`	Puesto	True
`custom_fields`	JSON con los atributos custom de la persona.	True
`teams`	Listado de Equipos a los que pertenecerá el usuario.	True
`groups`	Listado de Groups a los que pertenecerá la persona.	True

Petición:

Respuesta:

Modificar usuario

Content-Type: application/json

Petición:

Respuesta:

Activar usuario

Content-Type: application/json

Nombre	Valores	Opcional

Nombre	Valores	Opcional
`username`	Nombre del usuario a activar.	False

Respuesta:

El campo is_active se encuentra actualizado a true.

Desactivar usuario

Content-Type: application/json

Nombre	Valores	Opcional

Nombre	Valores	Opcional
`username`	Nombre del usuario a activar.	False

Respuesta:

Grupos — Group Entity

Athento permite la gestión de grupos desde la API v1 para crear nuevos grupos y consultarlos.

A continuación se muestra la representación de un usuario.

Crear un grupo

Llamada genérica de creación:

Crear grupo

Content-Type: application/json

Nombre	Valores	Opcional

Nombre	Valores	Opcional
`name`	Nombre del grupo	False
`teams`	Listado de Equipos a los que pertenecerá el grupo.	True

Petición:

Petición (con Teams):

Respuesta:

Búsqueda de documentos — Query & ResultSet Entities

Para realizar búsquedas de documentos sobre Athento es necesario usar servicios de query para la obtención de columnas específicas en modo resultset, o para obtener las entidades de documento completas. Éstos dos tipos de consulta son: resultset y query respectivamente.

Llamada genérica de consulta:

Nombre	Valores	Opcional

Nombre	Valores	Opcional
query-type	`resultset, query`	False
rest-query	`page, page_size`	True

page: es la página de documentos que se quiere obtener, por defecto, el valor de page es 1.
page_size: es el tamaño de página de la ventana de documentos que se pretende obtener. Por defecto, el valor de page_size es 20.

ResultSet

El servicio de resultset devuelve el listado de columnas indicadas en la cláusula SELECT de la consulta realizada. Las columnas obtenidas pueden ser atributos del documento o metadatos del formulario asociado.

Petición

Respuesta:

Use la cláusula GROUP BY en el servicio de ResultSet para obtener datos agrupados mediante funciones de agregación.

Petición

Respuesta:

Query

El servicio de query devuelve el listado de entidades de documento completas para la consulta realizada.

Petición:

Respuesta:

Consultas sobre documentos eliminados

Para consultar documentos eliminados debe indicarse el parámetro "removed": true en tanto en resultset como en query del siguiente modo. Por defecto, las búsquedas se realizan sobre documentos que no están eliminados, pero con esta opción se ofrece la posibilidad de consultar sobre la papelera.

ATQL

ATQL (Athento Query Language) es un lenguaje definido por Athento para realizar consultas simples o complejas basadas en su modelo documental, de manera que se pueda establecer una consulta que formalice qué campos del formulario se desean obtener, sobre qué tipos de formularios concretos y haciendo sobre qué condiciones establecidas sobre los propios campos —metadatos— incluidos en dichos formularios.

El formato ATQL es similar a SQL en cuanto a su estructura y cuenta con la capacidad de realizar datos resumidos mediante la cláusula GROUP BY.

Ejemplos de consultas ATQL.

Sintaxis

La consulta ATQL es una expresión basada en cláusulas para la consulta de campos de un documento o entidades completas.

La sintaxis general de la consulta es:

La cláusula SELECT es una lista de campos fijos y metadatos separados por coma, o el asterisco (SELECT * FROM ...) para devolver la entidad documento completa.

La cláusula del FROM es una lista de nombres de formularios separada por coma sobre el que se quiere consultar. Puede usarse el valor Document para realizar la consulta sobre todos los tipos de formulario disponibles.

La cláusula WHERE es en general un predicado que contiene una lista de condiciones por las que se filtrarán los documentos. Dichas condiciones pueden ser anidadas en forma de expresión usando operadores lógicos AND, OR o NOT.

La cláusula ORDER BY permite realizar ordenaciones para campos del documento o metadatos.

La cláusula GROUP BY permite también realizar agrupaciones y recuentos de documentos por campos o metadatos, además de aplicar funciones de agregación. Utilice la cláusula GROUP BY en el servicio de ResultSet para indicar la función de agregación.

Ejemplos de condiciones en forma de expresión:

expression
NOT expression
expression <operator> expression

Un operador puede ser:

AND
OR
=
!=
<
<=
>
>=
IN
BETWEEN
LIKE
ILIKE
IS (el operador IS es similar al operador =, salvo que puede usarse para localizar documentos con el valor del metadato a null)

Campos fijos de consulta vs metadatos

En ATQL puede hacerse uso de campos nominales fijos que ayudan a obtener información del documento. Por ejemplo, la consulta sobre el título (title ó filename) o el identificador interno (uuid).

Campo	Descripción

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

Ejemplos:

Búsqueda por metadatos

Para la búsqueda de documentos usando metadatos del formulario, es necesario aplicar las condiciones con el nombre del metadatos. Ejemplos:

Ordenación

Para ordenar las búsquedas se deben hacer uso de la directiva ORDER BY, con el listado de campos fijos, o metadatos por los que queramos ordenar. Además, podemos establecer el tipo de ordenación, ascendente o descendente con ASC o DESC respectivamente.

Ejemplos:

Funciones

ATQL permite el uso de funciones dinámicas para filtrar. A continuación se muestran las funciones disponibles.

Función	Parámetros	Descripción

Función	Parámetros	Descripción
`NOW`	Sí	Obtiene la fecha actual en formato `yyyy-MM-dd hh:mm:ss` con la posibilidad de incrementar (ó decrementar) con el parámetro según el formato `wdhms` para semanas, días, horas, minutos y segundos respectivamente. Ejemplo: `1w2d` para incrementar en 1 semana y 2 días, ó -3h4m para restar 3 horas y 4 minutos.
`TODAY`	No	Obtiene la fecha del día actual en formato `yyyy-MM-dd`
`YESTERDAY`	No	Obtiene la fecha del día anterior a hoy en formato `yyyy-MM-dd`
`TOMORROW`	No	Obtiene la fecha del día siguiente a hoy en formato `yyyy-MM-dd`
`CURRENT_USER`	No	Obtiene el nombre de usuario actual.

Ejemplos:

Obtener los documentos creados en la última semana:

Obtener los documentos creados hoy:

Obtener los documentos creados desde ayer:

Obtener documentos creados por el usuario actual:

Obtener documentos creados entre hace una semana y mañana:

Datos resumidos y funciones de agregación

ATQL permite el uso de GROUP BY para realizar agregaciones sobre campos del documento. Recuerde incluir la función de agregación y la definición de la propiedad del documento en al propia cláusula GROUP BY.

Por defecto, el número de resultados obtenidos para la agrupación de datos es 20. Puede usar el parámetro page_size para establecer un número mayor de resultados.

Las funciones de agregación disponibles son:

Función	Descripción

Función	Descripción
`count`	Cuenta el número de documentos distribuido por el valor.
`sum`	Sumatorio de los valores del metadato sobre el resultado de la consulta.
`max`	Valor máximo del metadato sobre el resultado de la consulta.
`min`	Valor mínimo del metadato sobre el resultado de la consulta.
`avg`	Media ponderada del metadato sobre el resultado de la consulta.
`max_min`	Valor máximo y valor mínimo del metadato obtenidos al tiempo sobre el resultado de la consulta.

Ejemplos:

Obtener el total de documentos agrupados por autor y serie.