Versions Compared

Version Old Version 79 New Version 80
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.

...

Nombre

Valores

Opcional

Content-Type

application/json

multipart/form-data

False

X-Fetch-Mode

default

extended

full

True

...

  • 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.

      • Incluye las entidades de los documentos relacionados al propio documento.

    • full: obtención completa de la entidad y sus relaciones.

    • NOTA

Info

El modo de obtención de la entidad también puede establecerse desde el parámetro de request fetch_mode.

Petición

Code Block
languagejson
{
   "<KEY>": "<VALUE>",
   "<OBJECT>": {
       "<KEY>": "<VALUE>",       ...
   }
}

...