FileFormats

API qui définit les requêtes pour accéder au référentiel des Formats. La requête utilise le langage de requête (DSL) de Vitam en entrée et retourne une liste de formats selon le DSL Vitam en cas de succès.

get

Requête qui retourne des résultats contenant des Formats. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée et retourne une liste de Formats selon le DSL Vitam en cas de succès.

Permissions requises:

  • formats:read
post

Requête qui retourne des résultats contenant des Formats si la requête utilise POST avec X-Http-Method-Override: GET. Si il n'y a pas de X-Http-Method-Override, la requête importe un nouveau référentiel à partir d'un fichier PRONOM (see :term:TNA).

Permissions requises:

  • formats:create

API qui définit les requêtes pour accéder à un format dans le référentiel des Formats.

get

Retourne une liste de Formats contenant 1 seul résultat en cas de succès.

Permissions requises:

  • formats:id:read

FileFormats check

API qui permet de vérifier que le fichier est correct, et peut être importé.

post

Vérifie si un fichier source PRONOM (see :term:TNA) peut être importé comme nouveau Référentiel.

Permissions requises:

  • formatsfile:check

Rules

API qui définit les requêtes pour accéder au référentiel des Règles de gestion. La requête utilise le langage de requête (DSL) de Vitam en entrée et retourne une liste de règles selon le DSL Vitam en cas de succès.

get

Requête qui retourne des résultats contenant des Règles de gestion. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée et retourne une liste de Règles de gestion selon le DSL Vitam en cas de succès.

Permissions requises:

  • rules:read
post

Requête qui retourne des résultats contenant des Règles de gestion si la requête utilise POST avec X-Http-Method-Override: GET. Si il n'y a pas de X-Http-Method-Override, la requête importe à partir d'un fichier CSV contenant les définitions des Règles de gestion un nouveau référentiel.

Permissions requises:

  • rules:create

API qui définit les requêtes pour accéder à une Règle dans le référentiel des Règles de gestion.

get

Retourne une liste de Règles de gestion contenant 1 seul résultat en cas de succès.

Permissions requises:

  • rules:id:read

FileRules check

API qui permet de vérifier que le fichier est correct, et peut être importé.

post

Vérifie si un fichier source CSV contenant les définitions des Règles de gestion peut être importé comme nouveau Référentiel.

Permissions requises:

  • rulesfile:check

Rules report

Permet de télécharger un objet représentant le rapport d'import des règles en fonction de l'id de l'opération

get

Permet de télécharger un objet représentant le rapport d'import des règles en fonction de l'id de l'opération

Permissions requises:

  • rulesreport:id:read

AccessionRegisters

API qui définit les requêtes pour accéder au Registre des Fonds. La requête utilise le langage de requête (DSL) de Vitam en entrée et retourne une liste de registres selon le DSL Vitam en cas de succès.

get

Requête qui retourne des résultats contenant des Registres de Fonds. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée et retourne une liste de Registres de Fonds selon le DSL Vitam en cas de succès.

Permissions requises:

  • accessionregisters:read

API qui définit les requêtes pour accéder au détail d'un Fond dans le Registre des Fonds.

get

Retourne une liste de Détails d'un Registre de Fonds contenant 1 seul résultat en cas de succès. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée.

Permissions requises:

  • accessionregisters:id:accessionregisterdetails:read

Access contracts

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

get

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

Permissions requises:

  • accesscontracts:read
post

Requête qui retourne des résultats contenant des Contrats d'accès si la requête utilise POST avec X-Http-Method-Override: GET. Si il n'y a pas de X-Http-Method-Override, la requête importe un ensemble de contrats d'accès qui sont sauvegardés et indexés en cas de succès

Permissions requises:

  • accesscontracts:create:json

API qui permet de mettre à jour un contrat d'accès via une requête de mise à jour ou d'accéder à un contrat d'accès

get

Retourne une liste de Contrats d'accès contenant 1 seul résultat en cas de succès.

Permissions requises:

  • accesscontracts:id:read
put

Requête qui modifie un Contrat d'accès. 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:

  • accesscontracts:id:update

Ingest contracts

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

get

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

Permissions requises:

  • ingestcontracts:read
post

Requête qui retourne des résultats contenant des Contrats d'entrée si la requête utilise POST avec X-Http-Method-Override: GET. Si il n'y a pas de X-Http-Method-Override, la requête importe un ensemble de contrats d'entrée qui sont sauvegardés et indexés en cas de succès

Permissions requises:

  • ingestcontracts:create:json

API qui permet de mettre à jour un contrat d'entrée via une requête de mise à jour ou d'accéder à un contrat d'entrée

get

Retourne une liste de Contrats d'entrée contenant 1 seul résultat en cas de succès.

Permissions requises:

  • ingestcontracts:id:read
put

Requête qui modifie un Contrat d'entrée. 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:

  • ingestcontracts:id:update

Management contracts

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

get

Requête qui retourne des résultats contenant des Contrats de gestion. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée et retourne une liste de Contrats de gestion selon le DSL Vitam en cas de succès.

Permissions requises:

  • managementcontracts:read
post

Requête qui retourne des résultats contenant des Contrats de gestion si la requête utilise POST avec X-Http-Method-Override: GET. Si il n'y a pas de X-Http-Method-Override, la requête importe un ensemble de contrats de gestion qui sont sauvegardés et indexés en cas de succès

Permissions requises:

  • managementcontracts:create:json

API qui permet de mettre à jour un contrat de gestion via une requête de mise à jour ou d'accéder à un contrat de gestion

get

Retourne une liste de Contrats de gestion contenant 1 seul résultat en cas de succès.

Permissions requises:

  • managementcontracts:id:read
put

Requête qui modifie un Contrat de gestion. 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:

  • managementcontracts:id:update

Contexts

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

get

Requête qui retourne des résultats contenant des Contextes. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée et retourne une liste de Contextes selon le DSL Vitam en cas de succès.

Permissions requises:

  • contexts:read
post

Requête qui retourne des résultats contenant des Contextes si la requête utilise POST avec X-Http-Method-Override: GET. Si il n'y a pas de X-Http-Method-Override, la requête importe un ensemble de contextes qui sont sauvegardés et indexés en cas de succès

Permissions requises:

  • contexts:create:json

API qui permet de mettre à jour un contexte via une requête de mise à jour ou d'accéder à un contexte

get

Retourne une liste de Contexte contenant 1 seul résultat en cas de succès.

Permissions requises:

  • contexts:id:read
put

Requête qui modifie un Contexte. 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:

  • contexts:id:update

Profiles

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

get

Requête qui retourne des résultats contenant des Profils. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée et retourne une liste de Profils selon le DSL Vitam en cas de succès.

Permissions requises:

  • profiles:read
post

Requête qui retourne des résultats contenant des Profils si la requête utilise POST avec X-Http-Method-Override: GET. Dans ce cas la requête doit être au format DSL SELECT SINGLE (Voir DSL API documentation). Sinon, le Content-Type est requis et la requête attend un json en entrée et importe un ensemble de profils qui sont sauvegardés et indexés en cas de succès. L'exemple montre le format du JSON pour l'import de référentiels.

Permissions requises:

  • profiles:create:binary

ou

  • profiles:create:json

API qui permet de mettre à jour un profil via une requête de mise à jour ou d'accéder à un profil

get

Permet de faire une requête par identifiant sur un profile si la requête attend application/json. L'identifiant du profile est la chaîne "idp" dans l'URL. Si la requête attend application/octet-stream en réponse, VITAM renvoie alors le fichier XSD ou RNG lié au profile.

Permissions requises:

  • profiles:id:read:binary

oui

  • profiles:id:read:json
put

Requête qui modifie les métadonnées d'un profil si la requête envoie un json (Content-Type = application/json). Dans ce cas, 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. Sinon, la requête doit spécifier le Content-Type comme application/octet-stream. Dans ce cas, elle permet de mettre à jour le fichier RNG ou XSD lié.

Permissions requises:

  • profiles:id:update:binaire

ou

  • profiles:id:update:json

griffons

Téléverser le référentiel des griffon

get

Permet de télécharger le référentiel des griffons

Permissions requises:

  • griffins:read
post

Importer le référentiel des griffons ou annule et remplace le référentiel des griffons existant

Permissions requises:

  • griffins:create

API qui permet de télécharger un griffon via l'identifiant du document

get

Permet de faire une requête par identifiant sur un griffon. L'identifiant du griffon est la chaîne "id_document" dans l'URL. la requête renvoie alors le griffon au format json.

Permissions requises:

  • griffin:read

scénario de préservation

Télécharger le référentiel des scénario de préservation

get

Permet de télécharger le référentiel des scénario de préservation

Permissions requises:

  • preservationScenarios:read
post

Téléverse le référentiel des scénarios de préservation ou annule et remplace les référentiels existant

Permissions requises:

  • preservationScenarios:create

API qui permet de télécharger un scénario de préservation via l'identifiant du document

get

Permet de faire une requête par identifiant sur un scénario de préservation. L'identifiant du scénario de préservation est la chaîne "id_document" dans l'URL. la requête renvoie alors le scénario de préservation au format json.

Permissions requises:

  • preservationScenario:read

Document Types

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

get

Requête qui retourne des résultats contenant des Document types. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE - Voir DSL API Documentation) de Vitam en entrée et retourne une liste de Document types selon le DSL Vitam en cas de succès.

Permissions requises:

  • archiveunitprofiles:read
post

Requête qui retourne des résultats contenant des Document types si la requête utilise POST avec X-Http-Method-Override: GET. Dans ce cas la requête doit être au format DSL SELECT SINGLE (Voir DSL API documentation). Sinon, le Content-Type est requis et la requête attend un json en entrée et importe un ensemble de Document types qui sont sauvegardés et indexés en cas de succès. L'exemple montre le format du JSON pour l'import de référentiels.

Permissions requises:

  • archiveunitprofiles:create:binary

ou

  • archiveunitprofiles:create:json

API qui permet de mettre à jour un document type via une requête de mise à jour ou d'accéder à un document type

get

API qui définit les requêtes pour accéder à un document type via son ID

Permissions requises:

  • archiveunitprofiles:id:read:json
put

Requête qui modifie un Document type. 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:

  • archiveunitprofiles:id:update:json

Security Profiles

API qui définit les requêtes pour accéder aux Profils de Sécurité. La requête utilise le langage de requête (DSL) de Vitam en entrée et retourne une liste de profils de sécurité selon le DSL Vitam en cas de succès.

get

Requête qui retourne des résultats contenant des Profils de sécurité. La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée et retourne une liste de Profils de sécurité selon le DSL Vitam en cas de succès.

Permissions requises:

  • securityprofiles:read
post

Requête qui retourne des résultats contenant des Profils de sécurité si la requête utilise POST avec X-Http-Method-Override: GET. Si il n'y a pas de X-Http-Method-Override, la requête importe un nouveau Profil de sécurité.

Permissions requises:

  • securityprofiles:create:json

API qui permet de mettre à jour un profil de sécurité via une requête de mise à jour ou d'accéder à un profil de sécurité

get

Retourne une liste de Profils de sécurité contenant 1 seul résultat en cas de succès.

Permissions requises:

  • securityprofiles:id:read
put

Requête qui modifie un Profil de sécurité. 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:

  • securityprofiles:id:update

Agencies

API qui définit les requêtes pour accéder au référentiel des Agencies. La requête utilise le langage de requête (DSL) de Vitam en entrée et retourne une liste d'agencies selon le DSL Vitam en cas de succès.

get

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

Permissions requises:

  • agencies:id:read
post

Request that will return results composed of Agencies si la requête utilise POST avec X-Http-Method-Override: GET. Si il n'y a pas de X-Http-Method-Override, la requête importe un nouveau Référentiel d'Agencies.

Permissions requises:

  • agencies:create

API qui définit les requêtes pour accéder à un Agency dans le référentiel des Agencies.

get

Retourne une liste d'Agencies contenant 1 seul résultat en cas de succès.

FileAgencies check

API qui permet de vérifier que le fichier est correct, et peut être importé.

post

Vérifie si un fichier source Agencies peut être importé comme nouveau Référentiel.

Permissions requises:

  • agenciesfile:check

Operations

Administration des Workflows Asynchrones (opérations). Certaines opérations devraient être limitées aux seuls administrateurs car elles impactent le back-office.

get

Requête qui retourne des résultats contenant des opérations.

Permissions requises:

  • operations:read
get

Permet de récupérer le statut de l'opération dont l'identifiant est passée en paramètre Permissions requises:

  • operations:id:read
put

Permet de mettre à jour une opération lancée en précisant l'action à exécuter dans le header X-Action-Id; PAUSE pour la mettre en pause, NEXT pour exécuter l'étape suivante, RESUME pour continuer l'exécution de l'opération jusqu'au bout. Cette opération ne devrait être ouverte qu'aux administrateurs

Permissions requises:

  • operations:id:update
delete

Permet d'annuler un workflow lancé. Cette opération ne devrait être ouverte qu'aux administrateurs

Permissions requises:

  • operations:id:delete
head

Permet d'obtenir le statut d'une opération

Permissions requises:

  • operations:id:read:status

Workflows

Gestion des définitions des Workflows disponibles.

get

Requête qui retourne des résultats contenant des définitions de workflow.

Permissions requises:

  • workflows:read

Audits

API d'audits (Ingest). Ce point d'entrée permet de créer une opération d'audit. Une opération d'audit est volatile, c'est à dire qu'elle disparaîtra dès qu'elle sera terminée. Sa terminaison est liée à la production du rapport et sa récupération par le service ayant effectué l'opération.

post

response : JSON asynchronous state / HTTP CODE 200 or 500 for KO

Permissions requises:

  • audits:create

Traceability

API de sécurisation des journaux. Ce point d'entrée permet de vérifier et télécharger une opération de sécurisation des journaux

Permet de télécharger un objet représentant la sécurisation des journaux d'opérations

get

Permet de télécharger un objet représentant la sécurisation des journaux d'opérations en fonction de l'identificant de l'opération à l'origine.

Permissions requises:

  • traceability:id:read

Vérification de la sécurisation d'un journal

Permet de lancer un processus de vérification d'une opération de sécurisation

post

response : JSON asynchronous state / HTTP CODE 200 or 500 for KO La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée.

Permissions requises:

  • traceabilitychecks:create

Audit de vérification de la sécurisation des journaux

Permet de lancer un processus de vérification des opérations de sécurisations

post

response : JSON asynchronous state / HTTP CODE 200 or 500 for KO La requête utilise le langage de requête DSL de type recherche simple (SELECT SINGLE) de Vitam en entrée.

Permissions requises:

  • traceabilitylinkedchecks:create

Valeur Probante

API permettant d'exporter des relevé de valeur probante

post

Lancement d'un export du relevé de valeur probante

Permissions requises:

  • probativevalue:create

Audit rectificatif

API permettant de corriger les erreurs remontés lors de l'audit de cohérence

post

Lancement d'un correctif d'audit

Permissions requises:

  • rectificationaudit:check

Audit de cohérence

API qui définit les requêtes pour générer un audit de cohérence.

post

Lancement d'une opération d'audit de cohérence

Permissions requises:

  • evidenceaudit:check

Référentiel des rêgles de gestion

API qui permet de récupérer le fichier original des rêgles de gestion sous forme de csv

get

Récupére le fichier original des rêgles de gestion sous forme de csv à partir de l'id de l'opération

Permissions requises:

  • rulesreferential:id:read

Référentiel des services agents

API qui permet de récupérer le fichier original des services agents sous forme de csv

get

Récupére le fichier original des services agents sous forme de csv à partir de l'id de l'opération

Permissions requises:

  • agenciesreferential:id:read

Ontologies

API qui définit les requêtes pour accéder au référentiel des Ontologies. La requête utilise le langage de requête (DSL) de Vitam en entrée et retourne une liste d'ontologies selon le DSL Vitam en cas de succès.

get

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

Permissions requises:

  • ontologies:read
post

Requête qui retourne des résultats contenant des Ontologies si la requête utilise POST avec X-Http-Method-Override: GET. Si il n'y a pas de X-Http-Method-Override, la requête importe un nouveau Référentiel d'Ontologies.

Permissions requises:

  • ontologies:read

ou

  • ontologies:create:json

API qui définit les requêtes pour accéder à une ontologie dans le référentiel des Ontologies.

get

Retourne une liste d'Ontologies contenant 1 seul résultat en cas de succès.

Permissions requises:

  • ontologies:id:read:json

Alpha - Pause Process

Force new operations to pause. This is alpha endpoint

post

pause operations on a given tenant and/or type

Permissions requises:

  • forcepause:check

Alpha - Remove Pause on Precess

Remove the "Must pause" on operations. This is alpha endpoint

post

Remove "Must Pause" for operations on a given tenant and/or type

Permissions requises:

  • removeforcepause:check

Registres de fonds symboliques

API sur les registres de fonds symboliques.

get

Recherche sur les registres de fonds symboliques grâce à la requête donnée en entrée

Permissions requises:

  • accessionregisterssymbolic:read

Beta - Journalisation externe

API permettant d'intégrer des journaux d'opération externes.

post

Beta - Requête qui insère une opération externe dans le journal des opérations

Permissions requises:

  • logbookoperations:create

Endpoints

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

options

Request that will return list of endpoints

/batchreport/{ido}

Permet de télécharger le rapport pour un traitement de masse (Elimination, Preservation, Audit, Mise à jour)

get

Permet de télécharger le rapport pour un traitement de masse (Elimination, Preservation, Audit, Mise à jour)

Permissions requises:

  • batchreport:id:read