Damaris RM Web service V2

La recherche de documents électroniques

Voici la séquence d’appels pour déclencher une recherche de documents dans Damaris RM :

• /rest/services/auth/login
  • Soumettre le login et le mot de passe crypté
  • Récupérer uniqueKey
• /rest/services/search/searchArchivesAdvanced
  • Soumettre uniqueKey, l’ID typologie document et les critères de recherches
    • ATTENTION : La variable JSON « indexes » attend une chaîne de caractères au format Base64 créée à partir de la chaîne composée des critères. Par exemple, vous allez composer un JSON de type {« 123″: »ABCDEF »} pour rechercher la valeur ABCDEF dans le critère 123. Convertissez cette chaîne qui va donner en Base 64 « eyIxMjMiOiJBQkNERUYifQ== »
    • Les valeurs vides doivent être représentées comme suit {« 123″: » »}
  • Récupérer les résultats dont ArchivedID
• /rest/services/archiving/getElectronicDocument
  • Soumettre uniqueKet et l’ID du document
  • Récupérer le fichier numérique
• /rest/services/auth/logout
  • Soumettre uniqueKey

Vous disposez également de la méthode /rest/services/archiving/getDocumentTypeIndexes qui vous délivre la liste des critères d’indexation pour une typologie donnée.

Les éléments retournés comprennent entre-autres le type d’index.

Voici le tableau qui indique le code retourné par rapport au type d’index configuré dans Damaris RM :

Pour effectuer une recherche bornée pour les champs de type Date, monétaire et numérique, vous pouvez utiliser la syntaxe suivante dans le JSON du champ « indexes ». Pour rappel, ce champ devra ensuite être codé en Base64 avant son intégration dans le JSON global de l’appel.

• La recherche commence par : {« IdxID »: »Valeur »}
• La recherche pour une valeur exacte : {« IdxID »: »Valeur »,  « IdxID_to »: »Valeur »}
• La recherche jusqu’à : {« IdxID_to »: »Valeur »}
• La recherche bornée : {« IdxID »: »ValeurDébut »,  « IdxID_to »: »ValeurFin »}

Par exemple, La valeur IdxID numérique serait 1012, cela donnerait : {« 1012″: »01/01/2022 »,  « 1012_to »: »30/06/2022″}

De plus, en utilisant la méthode searchArchivesAdvanced vous pouvez utiliser l’option suivante pour une recherche exacte de toutes les valeurs. Ce mode accélère grandement les recherches :

« makeExactSearch » : true

Attention : La valeur par défaut est false.