Comment puis-je vous aider ?

Damaris RM Web service V2

You are here:
< Retour
Damaris RM

Introduction

Damaris RM web service est un ensemble d’API qui vous permettent d’exploiter des fonctions à partir de vos autres outils informatiques.

Cette documentation concerne Damaris RM v10.

Le principe des méthodes Damaris RM

Pour pouvoir utiliser les Web Services, il convient de suivre les séquences des appels qui vous permettent d’obtenir les informations nécessaires pour l’appel suivant.

Voici un exemple de séquence d’appels :

  • /rest/services/auth/login : Authentifie l’utilisateur
    • Génère une clé unique : uniqueKey
  • … Lancement des autres méthodes en utilisant la valeur uniqueKey
  • /rest/services/auth/logout : Fin de session

 

web service damaris rm

L’accès à la liste des méthodes

Pour accéder à la liste des méthodes, et même pour pouvoir les tester, la solution Damaris RM intègre une page swagger.

Cette interface liste les différents contrôleurs et méthodes.

Vous pouvez ensuite tester directement chaque appel API à partir de la page web.

De plus, vous trouverez des exemples de codes JSON et curl pour vous guider dans le codage des appels.

Pour accéder à la page swagger, lancez l’URL de votre serveur Damaris RM, suivi de /swagger-ui/

Voici un exemple de lien URL : https://prod27.damaris.pro/DamarisRM4/swagger-ui/

 

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
    • 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 :

Code indexType d’indexCommentaires
1Numérique 
2Alphanumérique 
3Monétaire 
4Date 
5Horodatage 
6Liste ferméeUtilisez la méthode getIndexListValues pour obtenir les valeurs de la liste
7Liste ouverteUtilisez la méthode getIndexListValues pour obtenir les valeurs de la liste
9Email 
10Virtual Folder 
11Dictionnaire 
12Simple Closed ListUtilisez la méthode getIndexListValues pour obtenir les valeurs de la liste
13URL 
14Lien Table 
15Champ chiffré 
16Icône 

 

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″}

web service search logo
web service archiving logo

L’archivage de documents électroniques

Voici la séquence d’appels pour déclencher l’archivage d’un document dans Damaris RM :

  • /rest/services/auth/login
    • Soumettre le login et le mot de passe crypté
    • Récupérer uniqueKey
  • /rest/services/archiving/getDocumentTypes
    • Soumettre uniqueKey
    • Récupérer les docTypeID
  • /rest/services/archiving/getDocumentTypeIndexes
    • Soumettre uniqueKey, docTypeID
    • Récupérer les résultats dont indexID
  • /rest/services/archiving/archiveElectronicDocument
    • Soumettre uniqueKey docTypeID et les indexID
    • Soumettre également le PDF à archiver
    • Récupérer le statut et le numéro unique de dépôt archiveID
  • /rest/services/auth/logout
    • Soumettre uniqueKey

La modification des index

  • /rest/services/auth/login
    • Soumettre le login et le mot de passe crypté
    • Récupérer uniqueKey
  • /rest/services/archiving/getDocumentTypes
    • Soumettre uniqueKey
    • Récupérer les docTypeID
  • /rest/services/search/updateArchiveIndex
    • Soumettre uniqueKey, archiveID, indexID et la nouvelle valeur d’index
  • /rest/services/auth/logout
    • Soumettre uniqueKey
Archives physiques

Les méthodes concernant la gestion des archives physiques

Pour rappel, la solution Damaris RM propose en standard la gestion des archives physiques.

Pour cela, un ensemble de méthodes API web services est disponible pour vous permettre d’interagir avec la solution de Records Management et intégrer les différentes fonctions depuis vos propres outils.

Voici la liste de ces appels :

MéthodeDescription
/rest/services/archiving/getBoxTypesRetrouve la liste des types de boites déclarés dans le système
/rest/services/archiving/getStoragesRetrouve la liste des sites de stockage
/rest/services/archiving/localizeLocalisation d’article ou de boite
/rest/services/archiving/packagingConditionnement d’articles dans une boite
/rest/services/archiving/receiveRéception des articles ou des boites
/rest/services/archiving/relocalizeRelocalisation
/rest/services/declaration/doDeclarationPermet de déclarer un nouvel article ou boite
/rest/services/declaration/getBatchesRetrouve la liste des lots de versements
/rest/services/declaration/getDocumentStorageYearsRetrouve la durée utile de conservation pour une typologie
/rest/services/declaration/getFinalStatesRetrouve le sort final pour une typologie
/rest/services/declaration/getParentBoxCodesRetrouve la boite parent pour un article ou une boite
/rest/services/prediction/predictPropose des actions pour un code boite
/rest/services/prediction/storageInfoListe les actions à effectuer sur un site donné
/rest/services/requests/changeRequestStatusFait évoluer le statut d’une demande de sortie
/rest/services/requests/doRequestEffectue une demande de sortie
/rest/services/requests/getRequestReasonsRetrouve la liste des motifs de demandes
/rest/services/requests/getRequestTypesRetrouve la liste des types de demandes

 

 

swagger damaris rm

Les Contrôleurs disponibles

Ici, il convient de citer les différents “Contrôleurs” qui sont un regroupement de méthodes par grande fonction de Damaris RM.

Voici la liste des contrôleurs et des méthodes pour chaque.

NB : Vous trouverez tous ces éléments depuis votre interface Swagger de Damaris RM.

Contrôleur Courte description
archiving-controller

Regroupe toutes les fonctions nécessaires pour archiver de nouveaux documents.

Vous y trouverez les méthodes vous permettant d’obtenir les différentes informations pour composer vos flux JSON à soumettre à Damaris RM.

authentication-controllerConcerne essentiellement les méthodes pour connecter un utilisateur ou pour gérer les jetons de connexion.
bookmarks-controller
(Damaris RM v10)
Permet d’accéder aux marques pages créées par l’utilisateur connecté ou de les mettre à jour.

contract-controller
(Damaris RM v10)

Accédez aux conventions de dématérialisation destinées à l’utilisateur connecté. Il est également possible de gérer sa décision, l’acceptation ou le refus de la convention.

declaration-controller

Sert pour la gestion des archives physiques et particulièrement, la gestion des lots de versements.
documentsignature-controller (Damaris RM v10)Permet à un utilisateur invité de signer numériquement un document qui lui est présenté.
documentuploaderportal-controller
(Damaris RM v10)
Le portail de téléversement de fichiers en vue de leur traitement dans les projets configurés.
messages-controllerRegroupe les méthodes de la messagerie interne à Damaris RM, l’envoi des notifications vers Damaris Mobile ou la possibilité de créer un nouveau ticket Hotline dans Damaris Extranet.
my-basket-controller
(Damaris RM v10)
Tous les appels API pour la gestion de la fonction “Mon Panier”.
mydashboard-controller
(Damaris RM v10)
Gère le Tableau de bord utilisateur en lui permettant de mettre à jour et d’accéder aux objets qui y sont positionnés.
prediction-controller

Utilisez la fonction de prédiction pour obtenir des informations pertinentes concernant les archives physiques.

Cette fonction aide les archivistes à mieux gérer leurs fonds.

projects-controllerTransmet des données statistiques et quantitatives vers Damaris Extranet pour alimenter la gestion centralisée des projets.
requests-controllerRegroupe les méthodes pour la gestion des demandes de sorties et la gestion des sorties et des retours des boites d’archives physiques.
scanning-controller

Retrouvez ici toutes les méthodes vous permettant de gérer les projets de numérisation massive de documents.

Cela correspond aux fonctions de Scanning Centers multi-scanners et multi-sites.

search-controllerRegroupe toutes les fonctions de recherches de documents et l’obtention des résultats de recherches.
stamps-controller

Ajoutez et vérifiez la présence des Tampons électroniques sur les documents.

Faites évoluer l’état d’avancement de vos documents dans vos Workflows.

statisticsws-controller
(Damaris RM v10)

Accédez aux informations statistiques sur le fonds d’archives.

supplier-portal-controller

Ce sont les API de dépôt et de suivi des factures fournisseurs.

Vos fournisseurs peuvent exploiter ces API REST pour déposer leurs factures à votre destination.

tasks-controller

Gérez vos tâches automatisées ou manuelles.

Vous pouvez les déclencher à distance depuis vos autres processus.

Damaris RM Web service V2