ArchiveUnits

API qui définit les requêtes pour accéder aux Unités d'archives. La requête utilise le langage de requête DSL de Vitam en entrée et retourne une liste d'Unités d'archives selon le DSL Vitam en cas de succès.

get

Requête qui retourne des résultats contenant des Unités d'archives. La requête utilise le langage de requête DSL de type recherche multiple (SELECT MULTIPLE) de Vitam en entrée et retourne une liste d'Unités d'archives selon le DSL Vitam en cas de succès.

Permissions requises:

  • units:read
post

Requête qui déclanche la mise à jour de masse des métadonnées descriptives des unités archivistiques. Sans le Header, le point d'API est utilisé pour mettre à jour en masse les métadonnées descriptives des unités archivistiques. Possibilité de remplacer une chaîne de caractères par une autre vià l'opération $setregex.

Avec le Header, La requête utilise le langage de requête DSL de type recherche multiple (SELECT MULTIPLE) de Vitam en entrée et retourne une liste d'Unités d'archives selon le DSL Vitam en cas de succès. La requête utilise POST avec X-Http-Method-Override: GET Permissions requises:

  • units:update
get

Requête qui déclenche la récupération de toutes les unités d'archives dans un Json Stream.

Permissions requises:

  • units:stream
post

Requête qui déclenche la mise à jour de masse des métadonnées de gestion d'unités d'archives. La requête utilise un POJO spécifique pour effectuer la mise à jour des éléments de gestion.

Permissions requises:

  • units:rules:update

Request Calcule/Supprime les règles héritées pour les unités archivistiques répondant aux critères de la requête DSL.

post

Request that will launch the computation

Permissions requises:

  • computeInheritedRules:action
delete

Request that will delete the computation

Permissions requises:

  • computeInheritedRules:delete

API qui définit les requêtes pour accéder à une Unité d'archive. La requête utilise le langage de requête DSL de Vitam en entrée et retourne une liste d'Unités d'archives selon le DSL Vitam en cas de succès.

get

Requête qui retourne une Unité d'archive. La requête utilise le langage de requête DSL de type recherche unitaire (GET BY ID) de Vitam en entrée et retourne une liste d'Unités d'archives contenant 1 seul résultat selon le DSL Vitam en cas de succès.

Permissions requises :

  • units:id:read:json
put

[DEPRECATED] - Be careful, this endpoint is no longer acceptable for updating units. Use POST /units instead.

Requête qui modifie une Unité d'archive.
La requête utilise le langage de requête DSL de type modification unitaire (UPDATE BY ID) de Vitam en entrée et retourne le statut de la mise à jour en résultat selon le DSL Vitam en cas de succès.

Permissions requises:

  • units:id:update

API qui définit les requêtes pour accéder à l'Objet d'archives associé à l'Unité d'archives si elle existe. La requête utilise le langage de requête (DSL) de Vitam en entrée et retourne l'objet d'archives selon le DSL Vitam en cas de succès.

get

Requête qui retourne le résultat contenant un Object d'archives : ses métadonnées ou un de ses objets binaires. Dans le cas des métadonnées, la requête utilise le langage de requête DSL de type recherche unitaire (GET BY ID) de Vitam en entrée. 'Accept' header est 'application/octet-stream' (objet binaire) ou 'application/json' (métadonnées) Permissions requises:

  • units:id:objects:read:json

ou

  • units:id:objects:read:binary
post

Requête qui retourne le résultat contenant un Object d'archives : ses métadonnées ou un de ses objets binaires. Dans le cas des métadonnées, la requête utilise le langage de requête DSL de type recherche unitaire (GET BY ID) de Vitam en entrée. 'Accept' header est 'application/octet-stream' (objet binaire) ou 'application/json' (métadonnées) La requête utilise POST avec X-Http-Method-Override: GET.

Endpoint d'API pour la création de Demandes d'Accès depuis une offre froide à des Objets d'archives.

post

Création d'une demandes d'accès à un objet d'archives associé à une unité d'archives.

Si l'objet est persisté sur une offre de stockage « froide », une demandes d'accès est créée, et renvoyée.

Si l'objet est persisté sur une offre de stockage « chaude », aucune demandes d'accès n'est renvoyée.

La création d'une demandes d'accès, permet de pré-commander des données persistées sur une offre « froide », et de le mettre à disposition pour lecture.

L'appelant doit monitorer périodiquement le statut des demandes d'accès (typiquement toutes les quelques minutes ou heures).

Une fois une demandes d'accès est devient prête (READY), la disponibilité immédiate des données depuis l'offre « froide » est garantie.

La durée d'expiration d'une demandes d'accès, qui court à partir du moment où cette dernière devient prête, est paramétrée par l'administrateur de Vitam.

Au bout d'une durée configurée par l'administrateur, une demandes d'accès est purgée de l'offre (NOT_FOUND).

Une fois une demandes d'accès est expirée (EXPIRED) ou supprimée, la disponibilité des données n'est alors plus garantie.

IMPORTANT: Les demandes d'accès créées doivent être supprimées au plus vite, dès que la donnée a été récupérée. Un trop grand nombre et/ou volume de demandes d'accès non supprimées risque d'impacter les capacité de stockage du cache de l'offre « froide », ainsi que la stabilité de l'offre.

Permissions requises:

  • units:id:objects:accessrequests:create
post

Requête qui déclanche la mise à jour unitaire des métadonnées descriptives de plusieurs unités archivistiques. La requête utilise le langage de requête DSL de type mise à jour unitaire de masse (BULK UPDATE) de Vitam en entrée. Permissions requises:

  • units:bulk:update

ArchiveUnits with inherited rules

API qui définit les requêtes pour accéder aux Unités d'archives avec leurs règles de gestion héritées. La requête utilise le langage de requête DSL de Vitam en entrée et retourne une liste d'Unités d'archives avec leurs règles de gestion selon le DSL Vitam en cas de succès.

get

Requête qui retourne des résultats contenant des Unités d'archives ainsi que leurs règles de gestion héritées. La requête utilise le langage de requête DSL de type recherche multiple (SELECT MULTIPLE) de Vitam en entrée et retourne une liste d'Unités d'archives avec leurs règles de gestion selon le DSL Vitam en cas de succès.

Permissions requises:

  • unitsWithInheritedRules:read

Groupe d'objet

API qui définit l'ensemble des requêtes sur les groupes d'objets.

get

Requête qui retourne des résultats contenant des Groupes d'objets. La requête utilise le langage de requête DSL de type recherche multiple (SELECT MULTIPLE) de Vitam et peut utiliser l'opérateur $subobject (Voir documentation DSL) en entrée et retourne une liste d'Unités d'archives selon le DSL Vitam en cas de succès.

Permissions requises:

  • objects:read
post

Requête qui retourne des résultats contenant des Groupes d'objets en utilisant le verbe POST et le header X-Http-Method-Override: GET. La requête utilise le langage de requête DSL de type recherche multiple (SELECT MULTIPLE) de Vitam et peut utiliser l'opérateur $subobject (Voir documentation DSL) en entrée et retourne une liste d'Unités d'archives selon le DSL Vitam en cas de succès.

Restauration des métadonnées

API qui restaure les métadonnées essentielles

post

Requête qui permet la restauration des métadonnées essentielles des unités archivistiques.

Permissions requises:

  • units:update:revert

DIP Export

API qui définit les requêtes pour générer un DIP (Dissemination Information Package : ZIP contenant les métadonnées et les objets) pour une sélection d'Unités d'archives. La requête utilise le langage de requête (DSL) de Vitam en entrée et va lancer un processus générant le DIP selon le DSL passé. Une autre requête pourra être exécutée par la suite pour télécharger le fichier Zip généré.

post

response : JSON asynchronous state / HTTP CODE 202 or 500 for Internal Server Error La requête utilise le langage de requête DSL de type recherche multiple (SELECT MULTIPLE) de Vitam en entrée.

Permissions requises:

  • dipexport:create

Télécharger le DIP généré par l'opération passée en paramètre

get

Requête qui retourne les résultats composés des métadonnées et des objets binaires dans un fichier zip 'Accept' header est 'application/octet-stream'

Permissions requises:

  • dipexport:id:dip:read

DIP Export V2

API qui définit les requêtes pour générer un DIP (Dissemination Information Package : ZIP contenant les métadonnées et les objets) pour une sélection d'Unités d'archives. La requête est composée d'une dslRequest (DSL) et d'autres paramètres nécessaires pour le service. Un processus générant le DIP V2 selon le DSL passé sera lancé. Une autre requête pourra être exécutée par la suite pour télécharger le fichier Zip généré.

post

response : JSON asynchronous state / HTTP CODE 202 or 500 for internal error La requête utilise le langage de requête DSL de type recherche multiple (SELECT MULTIPLE) de Vitam en entrée.

Transfert d'archives

API qui définit les requêtes pour générer un transfert d'une sélection d'unités d'archives. La requête est composée d'une dslRequest (DSL) et d'autres paramètres nécessaires pour le service. Un processus générant le SIP selon le DSL passé sera lancé. Une autre requête pourra être exécutée par la suite pour télécharger le fichier Zip généré.

post

response : JSON asynchronous state / HTTP CODE (202, 200) or (412, 500 else) La requête utilise le langage de requête DSL de type recherche multiple (SELECT MULTIPLE) de Vitam en entrée.

Permissions requises:

  • transfers:create

Télécharger le SIP généré par l'opération passée en paramètre.

get

Requête qui retourne un SIP au format ZIP 'Accept' header est 'application/octet-stream'.

Permissions requises:

  • transfers:id:sip:read

Elimination

API qui définit les requêtes pour l'élimination des unités archivistiques.

Opération d'analyse des unités archivistiques éliminables.

post

Exécute une opération d'analyse d'élimination des unités archivistiques.

Permissions requises :

  • elimination:analysis

Opération d'élimination définitive des unités archivistiques éliminables.

post

Exécute une opération d'élimination définitive des unités archivistiques.

Permissions requises:

  • elimination:action

Journaux d'accès

API qui permet de lancer des actions relatives aux journaux d'accès aux objets binaires des unités archivistiques.

get

Lancer la récupération des journaux sous la forme d'un ZIP contenant des fichiers de log au format Json Lines. La requête prend en paramètre un objet Json pouvant contenir une date de début (StartDate) ou de fin (EndDate) pour filtrer les journaux.

Permissions requises:

  • storageaccesslog:read:binary

Préservation

Opération de préservation des unités archivistiques.

post

Exécute une opération de préservation sur (une ou) les unités archivistiques.

Permissions requises:

  • preservation:update

Transfer Reply

Démarage du traitement de l'ATR adressé par le SAE cible dans le cas d'un transfert

post

Démarage du traitement de l'ATR adressé par le SAE cible dans le cas d'un transfert.

Permissions requises:

  • transfers:reply

Mise à jour d'arborescence

API qui définit les requêtes liées à la mise à jour d'arborescence des unités archivistiques

post

Lancement d'une ou plusieurs modifications d'arborescence d'unité archivistiques

Endpoints

API qui liste les endpoints de la ressource /access-external/{version}.

options

Requête qui retourne la liste des endpoints

Status

get

Vérification de l'état de l'api

Suppression des versions des groupes d'objets

Opération de suppression des versions des groupes d'objets.

post

Exécute une opération de suppression des versions des groupes d'objets.

Permissions requises:

  • objects:deleteGotVersions

Gestion des demandes d'accès depuis offre froide.

APIs de gestion des demandes d'accès à des objets depuis une offre froide.

get

Vérification du statut d'un lot de demandes d'accès.

Pour chaque demande d'accès, un statut est renvoyé :

  • READY : La demande d'accès est prête.
  • NOT_READY : La demande d'accès est n'est pas encore prête.
  • EXPIRED : La demande d'accès a expiré.
  • NOT_FOUND : La demande d'accès n'est pas trouvée (supprimée, purgée au bout d'un délais après expiration, non existante ou non visible depuis le contexte du tenant d'appel...)

L'appelant doit monitorer périodiquement le statut des demandes d'accès (typiquement toutes les quelques minutes ou heures). Une fréquence d'appel trop rapide peut avoir un impact sur les performances de l'offres en particulier, et de Vitam en général.

Une demande d'accès est uniquement visible dans le contexte de son tenant, et sera donc perçue comme NOT_FOUND depuis tout autre tenant.

Permissions requises:

  • accessrequests:check
delete

Suppression d'une demande d'accès.

Une fois une demandes d'accès supprimée, la disponibilité des données n'est alors plus garantie.

La suppression d'une demande d'accès inexistante est sans effet (idempotence). De même, une demande d'accès est uniquement visible dans le contexte de son tenant.

IMPORTANT: Les demandes d'accès créées doivent être supprimées au plus vite, dès que la donnée a été récupérée. Un trop grand nombre et/ou volume de demandes d'accès non supprimées risque d'impacter les capacité de stockage du cache de l'offre « froide », et la stabilité de l'offre.

Permissions requises:

  • accessrequests:remove