Besoin d'aide ?
Introduction
Cet article décrit toutes les méthodes Web Services disponibles au niveau de Damaris Vault.
Les différents fonctions de Damaris Vault
- Vault définitif
- Vault temporaire
- Archivage
- Récupération
La méthode /archiveDocumentRestTmp
Cette méthode archive un nouveau fichier dans le coffre-fort temporaire de Damaris Vault.
- Informations en entrée :
- Le fichier à archiver
- Format : Multipart form data
- Paramètres :
- USERID : Identification utilisateur
- FILE_LENGTH : Taille du fichier (En octets)
- Le fichier à archiver
- Réponse :
- Format : String
- RESULT_CODE;RESULT_MESSAGE;MetadataID;FILECODE;CHECKSUM;IS_TSA_USED
La méthode /archiveDocumentRest
Cette méthode archive un nouveau fichier dans le coffre-fort Damaris Vault.
- Informations en entrée :
- Le fichier à archiver
- Format : Multipart form data
- Paramètres :
- USERID : Identification utilisateur
- FILE_LENGTH : Taille du fichier (En octets)
- Le fichier à archiver
- Réponse :
- Format : String
- RESULT_CODE;RESULT_MESSAGE;MetadataID;FILECODE;CHECKSUM;IS_TSA_USED
La méthode /getVaultStateRest
Vérifie si le service est disponible et si Damaris Vault a bien accès à la base de données.
- Informations en entrée :
- Paramètre :
- USERID : Identification utilisateur
- Paramètre :
- Réponse :
- Format : String
- OK ou KO
La méthode /dVMakeInventoryLightRest
Vérifie la disponibilité des métadonnées dans le coffre-fort et tente de les corriger.
Cette méthode ne s’occupe que des métadonnées.
- Informations en entrée :
- Paramètres : La liste des BoxCode et FileCode à tester (Format JSON)
[ BOXCODE1 : [ FILECODE1 : 0, FILECODE2 : 0, ],
BOXCODE2 : [ FILECODE3 : 0, FILECODE4 : 0, ], ]
- Réponse :
[ BOXCODE1 : [ FILECODE1 : 0, // file is not available
FILECODE2 : 1, //file is available ],
BOXCODE2 : [ FILECODE3 : 0, FILECODE4 : 0, ], ]
La méthode /dVMakeInventoryDepthRest
Vérifie la disponibilité des métadonnées et des fichiers dans le coffre-fort et tente de les corriger.
Cette méthode ne s’occupe les métadonnées et les fichiers.
- Informations en entrée :
- Paramètres : La liste des BoxCode et FileCode à tester (Format JSON)
[ BOXCODE1 : [ FILECODE1 : 0, FILECODE2 : 0, ],
BOXCODE2 : [ FILECODE3 : 0, FILECODE4 : 0, ], ]
- Réponse :
[ BOXCODE1 : [ FILECODE1 : 0, // file is not available
FILECODE2 : 1, //file is available ],
BOXCODE2 : [ FILECODE3 : 0, FILECODE4 : 0, ], ]
La méthode /dVGetCopyRest
Extrait un fichier demandé et le restitue à l’appelant.
- Informations en entrée :
- Paramètres :
- metadataId: Identifiant de la métadonnée liée au fichier à extraire (Numérique)
- fileCode: (Numérique)
- userId: Identifiant utilisateur (Numérique)
- tsaOrChecksum: SHA256 du fichier à extraire (Chaîne de caractères)
- publicKey: Clé publique de décryptage si coffre-fort crypté
- Paramètres :
- Réponse :
- Fichier binaire
La méthode /dVGetCopyRestCompressed
Extrait un fichier demandé, le compresse et le restitue à l’appelant.
- Informations en entrée :
- Paramètres :
- metadataId: Identifiant de la métadonnée liée au fichier à extraire (Numérique)
- fileCode: (Numérique)
- userId: Identifiant utilisateur (Numérique)
- tsaOrChecksum: SHA256 du fichier à extraire (Chaîne de caractères)
- compressionRatio: Ratio de compression (Numérique)
- publicKey: Clé publique de décryptage si coffre-fort crypté
- Paramètres :
- Réponse :
- Fichier binaire
La méthode /dVGetPDFCopyRest
Extrait un fichier demandé, le transforme en PDF et le restitue à l’appelant.
- Informations en entrée :
- Paramètres :
- metadataId: Identifiant de la métadonnée liée au fichier à extraire (Numérique)
- fileCode: (Numérique)
- userId: Identifiant utilisateur (Numérique)
- tsaOrChecksum: SHA256 du fichier à extraire (Chaîne de caractères)
- publicKey: Clé publique de décryptage si coffre-fort crypté
- Paramètres :
- Réponse :
- Fichier binaire du PDF
La méthode /dVGetPDFCopyRestCompressed
Extrait un fichier demandé, le transforme en PDF, le compresse et le restitue à l’appelant.
- Informations en entrée :
- Paramètres :
- metadataId: Identifiant de la métadonnée liée au fichier à extraire (Numérique)
- fileCode: (Numérique)
- userId: Identifiant utilisateur (Numérique)
- tsaOrChecksum: SHA256 du fichier à extraire (Chaîne de caractères)
- compressionRatio: Ratio de compression (Numérique)
- publicKey: Clé publique de décryptage si coffre-fort crypté
- Paramètres :
- Réponse :
- Fichier binaire du PDF
La méthode /dvDeleteFile
Supprime le fichier dans le coffre principal ou temporaire.
- Informations en entrée :
- Paramètres :
- metadataId: Identifiant de la métadonnée liée au fichier à extraire (Numérique)
- fileCode: (Numérique)
- userId: Identifiant utilisateur (Numérique)
- isTmp: 0 ou 1 (Numérique)
- Paramètres :
- Réponse :
- Statut de retour: OK ou KO avec un code erreur
La méthode /vaultValidationRest
Vérifie l’état de Damaris Vault.
- Informations en entrée :
- Paramètres :
- userId: Identifiant utilisateur (Numérique)
- Paramètres :
- Réponse :
- Au format suivant : « 1;0;0;1 » – « isTableMetadataExist;isTableLogExist;isMetadataFileStrctureCorrect;isRootPathCorrect »
La méthode /cleanupVaultRest
Nettoie les données de Damaris Vault
- Informations en entrée :
- Paramètres :
- userId: Identifiant utilisateur (Numérique)
- Paramètres :
- Réponse :
- 0: Exécution terminée avec succès
- -1: Echec de l’exécution
La méthode /dVGetCopyRestPreview
Extrait un fichier demandé.
Pour les fichiers PDF, extrait uniquement la première page, la compresse et la restitue
Pour les fichiers image, compresse et restitue.
- Informations en entrée :
- Paramètres :
- metadataId: Identifiant de la métadonnée liée au fichier à extraire (Numérique)
- fileCode: (Numérique)
- userId: Identifiant utilisateur (Numérique)
- tsaOrChecksum: SHA256 du fichier à extraire (Chaîne de caractères)
- compressionRatio: Ratio de compression (Numérique)
- publicKey: Clé publique de décryptage si coffre-fort crypté
- Paramètres :
- Réponse :
- Fichier binaire
La méthode dVGetPDFCopyRestPreview
Extrait un fichier demandé, le convertit d’abord en PDF. Ensuite, extrait uniquement la première page, la compresse et la restitue
- Informations en entrée :
- Paramètres :
- metadataId: Identifiant de la métadonnée liée au fichier à extraire (Numérique)
- fileCode: (Numérique)
- userId: Identifiant utilisateur (Numérique)
- tsaOrChecksum: SHA256 du fichier à extraire (Chaîne de caractères)
- compressionRatio: Ratio de compression (Numérique)
- publicKey: Clé publique de décryptage si coffre-fort crypté
- Paramètres :
- Réponse :
- Fichier binaire
La méthode /getVaultVersion
Renvoie la version du module Damaris Vault.
- Informations en entrée :
- Paramètres : Aucun
- Réponse :
- La version de Damaris Vault (Chaîne de caractères)
La méthode /analyzeMetadataFiles
Analyse les métadonnées stockées dans Damaris Vault.
- Informations en entrée :
- Paramètres : Aucun
- Réponse :
- Liste des métadonnées corrompues (Chaîne de caractères encodée Base64)
La méthode /restoreMetadataFile
Tente de restaurer une métadonnée corrompue.
- Informations en entrée :
- Paramètres :
- metadataId: Identifiant de la métadonnée liée au fichier à extraire (Numérique)
- Paramètres :
- Réponse :
- 1 : OK, -1 : Internal Error, -2 : Incorrect Metadata ID, -3 : Incorrect Counts(Chaîne de caractères)
La méthode /exportMetadata
Retourne les métadonnées sous la forme d’un fichier XML.
- Informations en entrée :
- Paramètres : Aucun
- Réponse :
- Fichier XML des métadonnées (Chaîne de caractères encodée Base64)
La méthode /importMetadata
Importe un fichier XML contenant les métadonnées Damaris Vault.
- Informations en entrée :
- Paramètres :
- MetadataFile (XML encodé en Base64)
- Paramètres :
- Réponse : (JSON)
- { « resultCode » : « 1 », « resultMessage »: « Successfully imported metadata. » }
La méthode /importLogs
Importe un fichier XML contenant les logs de Damaris Vault.
- Informations en entrée :
- Paramètres :
- logFile (XML encodé en Base64)
- Paramètres :
- Réponse : (JSON)
- { « resultCode » : « 1 », « resultMessage »: « Successfully imported metadata. » }