Besoin d'aide ?
A quoi sert le module damaris_rm.py pour Python ?
Vous souhaitez intégrer les API Damaris RM dans vos développements ?
Récupérez le module Python damaris_rm et importez-le dans votre code Python.
Ensuite, vous pouvez utiliser les appels API et ainsi exploiter les Web Services Damaris RM depuis votre code.
Les prérequis du module damaris_rm.py
Le module damaris_rm.py nécessite un certain nombre de modules lui permettant de fonctionner.
Voici la liste actuelle :
- configparser
- sys
- os
- shutil
- datetime
- codecs
- xml.etree.ElementTree
- json
- requests
- hashlib
- base64
- MultipartEncoder
Attention : Cette liste n’est pas exhaustive et peut varier selon les versions.
Les fonctions disponibles dans damaris_rm.py
Voici la liste des fonctions disponibles dans damaris_rm.py :
- login
- searchArchiveAdvanced
- getElectronicDocument
- getDocumentTypes
- transferTaskFile
- logout
La fonction login
| L’appel | retValue = login(damaris_rm_url, damaris_rm_username, damaris_rm_password) |
| Variables en entrée | damaris_rm_url : L’URL vers le serveur Damaris RM. Par exemple : « https://demo.damaris.pro/DamarisRM« damaris_rm_username : Le code utilisateur damaris_rm_password : Le mot de passe de l’utilisateur |
| Les fonctions | Ouvre une nouvelle session Web Service dans Damaris RM. |
| Les sorties | Variable JSON contenant en priorité la valeur « uniqueKey » qui vous servira por les appels ultérieurs. |
La fonction searchArchiveAdvanced
| L’appel | retValue = searchArchiveAdvanced(damaris_rm_url, uniqueKey, docTypeID, indexesData) |
| Variables en entrée | damaris_rm_url : L’URL vers le serveur Damaris RM. Par exemple : « https://demo.damaris.pro/DamarisRM« uniqueKey : La clé de session renvoyée par la fonction login docTypeID : L’identifiant du type de document disponible dans Damaris RM ou retrouvé en appelant la fonction getDocumentTypes indexesData : Dictionnaire Python contenant les idxID et la valeur recherchée. Les idxID sont disponibles dans Damaris RM ou peuvent être récupérés en utilisant la fonction getDocumentTypeIndexes |
| Les fonctions | Lance une recherche avancée dans Damaris RM en utilisant les critères d’indexation. |
| Les sorties | Variable JSON contenant la liste des résultats. |
La fonction getElectronicDocument
| L’appel | retValue = getElectronicDocument(damaris_rm_url, uniqueKey, boxCode, fileCode, imageID, recordID) |
| Variables en entrée | damaris_rm_url : L’URL vers le serveur Damaris RM. Par exemple : « https://demo.damaris.pro/DamarisRM« uniqueKey : La clé de session renvoyée par la fonction login boxCode / fileCode / imageID / recordID : Les identifiants uniques pour retrouver un document en particulier. Ces informations sont disponibles dans la variable JSON retournée par searchArchiveAdvanced. |
| Les fonctions | Récupère le fichier binaire d’un document en particulier. |
| Les sorties | La variable retournée est le contenu binaire du fichier. |
La fonction getDocumentTypes
| L’appel | retValue = getDocumentTypes(damaris_rm_url, uniqueKey) |
| Variables en entrée | damaris_rm_url : L’URL vers le serveur Damaris RM. Par exemple : « https://demo.damaris.pro/DamarisRM« uniqueKey : La clé de session renvoyée par la fonction login |
| Les fonctions | Retrouve la liste des typologies de documents dont l’utilisateur connecté a accès. |
| Les sorties | La variable JSON contient la liste des types de documents accessibles pour l’utilisateur. Les valeurs les plus importantes sont DocID et DocName. |
La fonction transferTaskFile
| L’appel | retValue = transferTaskFile(damaris_rm_url, uniqueKey, taskID, filename) |
| Variables en entrée | damaris_rm_url : L’URL vers le serveur Damaris RM. Par exemple : « https://demo.damaris.pro/DamarisRM« uniqueKey : La clé de session renvoyée par la fonction login taskID : L’identifiant de la tâche à l’entrée de laquelle vous souhaitez transférer le fichier. Cette information est disponible depuis Damaris RM filename : Le nom complet du fichier à transférer. Attention : Intégrez bien le chemin complet |
| Les fonctions | Transfert de manière sécurisée le fichier dans le répertoire d’entrée de la tâche |
| Les sorties | Variable JSON contenant le statut de retour, succès ou échec. |
La fonction logout
| L’appel | retValue = logout(damaris_rm_url, uniqueKey) |
| Variables en entrée | damaris_rm_url : L’URL vers le serveur Damaris RM. Par exemple : « https://demo.damaris.pro/DamarisRM« uniqueKey : La clé de session renvoyée par la fonction login |
| Les fonctions | Met fin à la session ouverte. |
| Les sorties | Variable JSON contenant le statut de retour, succès ou échec. |