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.
...
Modo | Endpoint | Descripción |
|---|---|---|
Documento | ||
POST |
| Crea un nuevo documento. |
GET |
| Obtiene un documento en formato JSON indicando su |
PUT |
| Modificación un documento indicando su |
DELETE |
| Elimina un documento indicando su |
GET |
| Descarga el contenido de un documento. |
POST |
| Ejecuta una transición sobre el ciclo de vida de un documento. |
Búsqueda | ||
POST |
| Busca documentos ejecutando una query ATQL y obteniendo los documentos como entidad. |
POST |
| Busca documentos ejecutando una query ATQL y obteniendo las columnas incluidas en la cláusula |
Usuario | ||
POST |
| Crea un nuevo usuario. |
GET |
| Obtiene un usuario en formato JSON indicando su |
PUT |
| Modifica un usuario existente. |
POST |
| Activa un usuario. |
POST |
| Desactiva un usuario. |
Grupo | ||
POST |
| Crea un nuevo grupo. |
GET |
| Obtiene un grupo en formato JSON indicando su |
...
La actualización del contenido de un documento, donde se le asociad asocia un archivo binario.
Nombre | Valores | Opcional |
|---|---|---|
Content-Type |
| False |
...
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 include 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.
...