[API Externes] 6 - Consultation et accès
Channel: Programme Vitam
Date: 2017-01-17

Le module de consultation permet de rechercher et de modifier les métadonnées des unités archivistiques, ainsi que de télécharger les objets associés à ces unités. 

Nous allons dans un premier temps rechercher la liste de toutes les archives dont la date de transaction est postérieure au 2 juin 2016.
À l’image de la recherche de formats ou de règle de gestion dans les référentiels. Il suffit de poster une requête DSL sur le endpoint /units. Les headers sont les mêmes : on envoie du JSON (corps) et on attend une réponse en JSON. La méthode GET est surchargée par la méthode POST. 

La réponse reçue est une collection Json des units avec quelques données supplémentaires comme le nombre de résultats ou encore l’offset (décalage) dans les résultats reçus (pour réaliser une pagination par exemple). Nous en profitons pour récupérer l’id d’une unité archivistique que nous allons pouvoir utiliser pour afficher son détail. Pour cela nous ajoutons l’id comme paramètre de la requête. Ce genre de requête complexe n’est pas encore disponible via l’IHM Demo Vitam, mais il est possible de faire des recherches beaucoup plus avancées via les API, par exemple une recherche par titre, par description ou une combinaison de critères différents : titre et description par exemple. 

Sur un modèle similaire, si l’on souhaite télécharger un objet stocké, nous faisons appel à l’API de téléchargement avec l’id d’un objet que nous avons récupéré lors de la recherche précédente. Ici, nous allons télécharger le fichier XXX.XXX du SIP dont nous avons fait l’entrée lors de la seconde vidéo. L’API ne fonctionnait pas au vendredi 13 janvier 2017, nous avons dû étudier pour en comprendre les raisons. 

L’API access propose également la modification des métadonnées d’une unité archivistique. Comme pour les autres requêtes, nous avons de l’id de cette unité.