Les annexes
Les annexes sont des entités indépendantes, permettant à l'utilisateur de déposer des documents et d'en gérer la diffusion via son état de publication et son chemin d'accès. Une annexe correspond à un fichier, accompagnés d'informations comme des étiquettes, sa taille ou son type.
D'un point de vue modèle, un annexe appartient à un datastore.
Téléverser une nouvelle annexe
Créer une nouvelle annexe se fait via l'appel à POST /datastores/{id}/annexes, en mettant dans le corps de la requête le fichier à téléverser, et en précisant en paramètres un chemin (unique au sein de l'entrepôt et utilisé lors de la diffusion), des étiquettes et un état de publication. Cela a pour effet de créer une entité annexe.
Le type de fichier et sa taille seront déduit du fichier téléversé.
Téléversement d'une annexe existante
Il est possible de modifier le fichier correspondant à l'annexe, via l'API PUT /datastores/{id}/annexes/{id}. Le fichier téléversé va alors écraser l'ancien, taille et type seront mis à jour. Il est impossible de modifier le chemin de diffusion via cette API.
Modification des informations de l'annexe
Les étiquettes, le chemin et l'état de publication d'une annexe peuvent être modifiés via l'API PATCH /datastores/{id}/annexes/{id}.
Publication ou dépublication massive
Il est possible de modifier l'état de publication de plusieurs annexes en un seul appel, en filtrant sur les étiquettes :
POST /datastores/{id}/annexes/publication: Publie toutes les annexes contenant au moins les étiquettes fournies dans le corps de la requêtePOST /datastores/{id}/annexes/unpublication: Dépublie toutes les annexes contenant au moins les étiquettes fournies dans le corps de la requête
Publier revenant à passer l'état de publication à true, déublier revenant à passer l'état de publication à false.
Suppression d'une annexe
Une annexe peut à tout moment être supprimée via l'API DELETE /datastores/{id}/annexes/{id}. Cela supprime l'entité annexe et supprime le fichier correspondant sur le stockage.
Parcours des annexes
Récupérer une liste d'annexes
L'API GET /datastores/{id}/annexes permet de récupérer l'ensemble des annexes (avec pagination) disponibles dans l'entrepôt. Pour cibler plus précisément les annexes voulues, plusieurs filtres, qui se cumulent, sont possibles :
mime_type=string: type des fichierspath=string: chemin de publication de l'annexetags=tableau de string: étiquettes des annexes voulues. L'ordre n'importe pas et toutes les annexes contenant au moins ces étiquettes seront retournées.
Voir les informations d'une annexe
Pour obtenir toutes les informations disponibles sur une annexe, on utilise l'API GET /datastores/{id}/annexes/{id}. Il faut que l'entrepôt soit le propriétaire de l'annexe.