Documentation Index

Fetch the complete documentation index at: https://knowledgecenter.docuware.com/llms.txt

Use this file to discover all available pages before exploring further.

Service Web standard API de la Plate-forme DocuWare

Prev Next

Accédez à vos armoires et aux documents qu'elles contiennent via le service web intégré par défaut, DocuWare Platform API.
La liste ci-dessous présente les endpoints disponibles pour le service web REST par défaut « DocuWare Platform API ».

Information : certains endpoints peuvent exécuter plusieurs opérations

Par exemple, l'endpoint « documentAnnotations » permet d'apposer un tampon à une position libre ou fixe, ou d'ajouter une annotation textuelle. Le chemin/endpoint est le même pour ces trois fonctions avec « documentAnnotations ». La différence réside dans le corps HTTP. Cependant, DocuWare ne peut préremplir automatiquement qu'un seul corps HTTP. Dans l'exemple de « documentAnnotations », le corps HTTP de la fonction « Apposer un tampon à une position définie automatiquement » est renseigné par défaut. Si vous souhaitez utiliser une autre fonction avec « documentAnnotations », vous devez remplacer et adapter manuellement le corps HTTP. Les modèles correspondants se trouvent en bas de la liste des endpoints.

Le libellé « Par défaut » dans la liste des endpoints indique quel corps HTTP est prérempli automatiquement.

Consultez cet aperçu pour identifier les opérations qui partagent le même chemin/endpoint :

  • documentAnnotations

    POST /FileCabinets/{TrayId/FileCabinetId}/Operations/ProcessDocumentAction?docId={DocId}

    • Apposer un tampon à une position définie automatiquement - par défaut

    • Apposer un tampon à une position fixe

    • Ajouter une annotation textuelle à une position fixe

  • processDocumentAction

    PUT /FileCabinets/{TrayId/FileCabinetId}/Documents/{DocId}/Annotation

    • Fusionner les calques - par défaut

    • Annexer un document

  • userRoles

    PUT /Organization/UserRoles?UserId={UserId}

    • Ajouter un utilisateur à un rôle - par défaut

    • Retirer un utilisateur d'un rôle

  • userGroups

    PUT /Organization/UserGroups?UserId={UserId}

    • Ajouter un utilisateur à un groupe - par défaut

    • Retirer un utilisateur d'un rôle

Pour transmettre l'ID/GUID d'un utilisateur, il suffit d'inscrire le nom d'utilisateur dans une variable globale de type « User » et de passer cette variable dans la requête HTTP. Le système fournira automatiquement le GUID approprié.

Liste des endpoints

Obtenir le nombre total de documents dans une armoire ou un bac

  • Description : DialogId (facultatif) : l'identifiant de la boîte de dialogue de recherche utilisée.
    FieldName (facultatif) : le nom du champ dont les valeurs sont regroupées et comptées.

  • Par défaut : oui

  • Opération : countResult

  • Commande : POST

  • Route/Chemin :
    /DocuWare/Platform/FileCabinets/ {TrayId/FileCabinetId}/Query/CountExpression?dialogId={DialogId}&fieldName= {FieldName}

Rechercher via une boîte de dialogue

  • Description : DialogId (facultatif) : l'identifiant de la boîte de dialogue de recherche utilisée.

  • Par défaut : oui

  • Opération : dialogExpression

  • Commande : POST

  • Route/Chemin :
    /DocuWare/Platform/FileCabinets/ {TrayId/FileCabinetId}/Query/CountExpression?dialogId={DialogId}&fieldName= {FieldName}

  • Corps HTTP (exemple) : 

    { "Condition":[ {"DBName":"COMPANY", "Value":["Peter's Engineering"]},{"DBName":"CONTACT", "Value":["EMPTY()"]},{"DBName":"DocuWareFulltext", "Value":["Solar Panels"]}], "Operation":"And"}

Créer une nouvelle entrée de base de données dans un bac ou une armoire

  • Par défaut : oui

  • Opération : documents

  • Commande : POST

  • Route/Chemin : /FileCabinets/{TrayId/FileCabinetId}/Documents

  • Corps HTTP (exemple) : 

    { "Fields": [ { "FieldName": "COMPANY", "Item": "Peter's Engineering" }, { "FieldName": "CONTACT", "Item": "Peter Sanders" }, { "FieldName": "DOCUMENT_DATE", "Item": "2020-01-01" }, { "FieldName": "COST_CENTER", "Item": { "$type": "DocumentIndexFieldKeywords", "Keyword": [ "A", "B", "C" ] } } ] }

Obtenir les informations d'un document

  • Par défaut : oui

  • Opération : document

  • Commande : GET

  • Route/Chemin : /FileCabinets/{TrayId/FileCabinetId}/Documents/{DocId}

Supprimer un document

  • Par défaut : oui

  • Opération : documentDelete

  • Commande : DELETE

  • Route/Chemin : /FileCabinets/{TrayId/FileCabinetId}/Documents/{DocId}

Supprimer une section d'un document

  • Description : si la seule section d'un document est supprimée, celui-ci est automatiquement converti en entrée de base de données.

  • Par défaut : oui

  • Opération : sectionDelete

  • Commande : DELETE

  • Route/Chemin : /FileCabinets/{TrayId/FileCabinetId}/Sections/{SectionId}

Apposer un tampon à une position définie automatiquement

  • Description : apposer un tampon à la meilleure position.

  • Par défaut : oui

  • Opération : documentAnnotations

  • Commande : POST

  • Route/Chemin : /FileCabinets/{TrayId/FileCabinetId}/Documents/{DocId}/Annotation

  • Corps HTTP (exemple) : 

    { "Annotations": [ { "PageNumber": 0, "SectionNumber": 0, "AnnotationsPlacement": { "Items": [ { "$type": "StampPlacement", "StampId": "73d54f34-1b80-4b43-81ec-f0d31176d990", "Layer": 1, "Field": [ { "Name": "<#1>", "TypedValue": { "Item": "*Test007*" }, "Value": "Jenkins" }, { "Name": "<#2>", "TypedValue": { "Item": "*Test007*" }, "Value": "Approved" } ], "Password": null } ] } } ] }

Apposer un tampon à une position fixe

  • Opération : documentAnnotations

  • Commande : POST

  • Route/Chemin : FileCabinets/{TrayId/FileCabinetId}/Documents/{DocId}/Annotation

  • Corps HTTP (exemple) : 

    { "Annotations": [ { "PageNumber": 0, "SectionNumber": 0, "AnnotationsPlacement": { "Items": [ { "$type": "StampPlacement", "Location": { "X": "100", "Y": "100" }, "StampId": "6ab67774-074d-4d93-99c5-5bc46262b84c", "Layer": 1, "Field": [ { "Name": "<#1>", "TypedValue": { "Item": "September" }, "Value": "Sep." } ], "Password": null } ] } } ] }

Ajouter une annotation textuelle

  • Opération : documentAnnotations

  • Commande : POST

  • Route/Chemin : FileCabinets/{TrayId/FileCabinetId}/Documents/{DocId}/Annotation

  • Corps HTTP (exemple) : 

    { "Annotations": [ { "PageNumber": 0, "SectionNumber": 0, "AnnotationsPlacement": { "Items": [ { "$type": "Annotation", "Layer": [ { "Id": "1", "Items": [ { "$type": "TextEntry", "Font": { "FontName": "Lucida Console", "Bold": true, "Italic": true, "Underlined": false, "StrikeThrough": false, "FontSize": 200, "Spacing": 0 }, "Value": "Test annotation", "Location": { "Left": 100, "Top": 100, "Width": 1500, "Height": 500 }, "Color": "Black", "Rotation": 0, "Transparent": false, "StrokeWidth": 50 } ] } ] } ] } } ] }

Transférer un document

  • Description : transfère un document depuis une armoire ou un bac source vers l'armoire ou le bac de destination spécifié.

    Le type de contenu doit être défini sur application/vnd.docuware.platform.documentstransferinfo+json

  • Par défaut : oui

  • Opération : transfer

  • Commande : POST

  • Route/Chemin : /FileCabinets/ {TrayId/FileCabinetId} /Task/Transfer

  • Corps HTTP (exemple) : 

    { "SourceFileCabinetId": "ae156510-ffa8-48b1-a3ec-baec3180669c", "Documents": [ { "Id": 123456, "Fields": null } ], "KeepSource": true, "FillIntellix": false,"UseDefaultDialog": true}

Remplacer le fichier d'un document

  • Description : remplace le fichier d'un document par le document en cours de traitement dans le processus de travail.

  • Par défaut : oui

  • Opération : sectionData

  • Commande : POST

  • Route/Chemin : /FileCabinets/{TrayId/FileCabinetId}/Sections/{SectionId}/Data

Ajouter un nouveau fichier

  • Description : ajoute le document en cours à un autre document dans une armoire ou un bac.

    Le document peut être ajouté au format d'origine ou au format PDF sans annotations ni tampons.

    Si la cible est une entrée de base de données, elle sera automatiquement convertie en document.

  • Par défaut : oui

  • Opération : sections

  • Commande : POST

  • Route/Chemin : /FileCabinets/{TrayId/FileCabinetId}/Sections?DocId={DocId}

Détacher un document

  • Description : automatise la séparation de fichiers. Par exemple, lorsque des documents attachés sont stockés dans l'armoire, ils peuvent être transférés vers le bac, détachés, puis stockés à nouveau dans l'armoire.

    • Dans la route de la requête, indiquez le GUID du bac.

    • Dans les paramètres de requête, ajoutez l'ID du document.

  • Par défaut : oui

  • Opération : unclipDocument

  • Commande : POST

  • Route/Chemin : /FileCabinets/{TrayId/FileCabinetId}/Operations/ContentDivide?docId={docId}

Fusionner les calques

  • Description : fusionne les calques d'annotation avec le document. Un nouveau PDF est créé et remplace l'ancien.

  • Par défaut : oui

  • Opération : processDocumentAction

  • Commande : PUT

  • Route/Chemin :
    /FileCabinets/{TrayId/FileCabinetId}/Operations/ProcessDocumentAction?docId={DocId}

  • Corps HTTP (exemple) : 

    { "DocumentAction": "MergeAnnotations","DocumentActionParameters":{"$type":"MergeAnnotationsParameters","SectionNumber":0}}

Annexer un document

  • Description : DialogId (facultatif) : l'identifiant de la boîte de dialogue de recherche utilisée. FieldName (facultatif) : le nom du champ dont les valeurs sont regroupées et comptées.

  • Opération : processDocumentAction

  • Commande : PUT

  • Route/Chemin :
    /FileCabinets/{TrayId/FileCabinetId}/Operations/ProcessDocumentAction?docId={DocId}

  • Corps HTTP (exemple) : 

    { "DocumentAction": "Append", "DocumentActionParameters": { "$type": "AppendActionParameters", "RemoveSourceDocuments": false, "DocumentsInFront": [ ], "DocumentsAtBack": [ { "SourceCabinetId": "ae156510-ffa8-48b1-a3ec-baec3180669c", "Documents": [ 123456 ] } ] } }

Créer un utilisateur

  • Description : le type de contenu doit être défini sur application/vnd.docuware.platform.createorganizationuser+json

  • Par défaut : oui

  • Opération : createUser

  • Commande : POST

  • Route/Chemin : /Organization/UserInfo

  • Corps HTTP (exemple) : 

    { "EMail": "firstname.lastname@domain.com", "Name": "MyUserName", "DBName": "MYUSERNA", "Password": "eLK%4s*Z", "NetworkID": "Domain\\MyUserName" }

Modifier les propriétés d'un utilisateur

  • Par défaut : oui

  • Opération : modifyUser

  • Commande : PATCH

  • Route/Chemin : /Organization/UserInfo

Obtenir tous les utilisateurs de l'organisation

  • Par défaut : oui

  • Opération : users

  • Commande : GET

  • Route/Chemin : /Organization/Users?Active={true|false}&Name={UserName}

Obtenir tous les utilisateurs d'un groupe

  • Description : GroupID (obligatoire) : l'identifiant du groupe.

  • Par défaut : oui

  • Opération : usersByGroup

  • Commande : GET

  • Route/Chemin : /Organization/GroupUsers?groupId={GroupId}

Obtenir tous les utilisateurs d'un rôle

  • Description : RoleID (obligatoire) : l'identifiant du groupe.
    IncludeGroupUsers (facultatif) : booléen – valeur par défaut : 'false'

  • Par défaut : oui

  • Opération : usersByRole

  • Commande : GET

  • Route/Chemin :
    /Organization/UserRoles?UserId={UserId}&Active={true|false}&Name={RoleName}&Type={Standard|Default|Administrator}

Obtenir les informations d'un utilisateur

  • Description : permet d'obtenir les propriétés d'un utilisateur spécifique, telles que l'état actif ou l'état d'absence du bureau.

    UserID (obligatoire) :

    l'identifiant de l'utilisateur.

  • Par défaut : oui

  • Opération : userById

  • Commande : GET

  • Route/Chemin : /Organization/UserByID?userId={UserId}

Obtenir tous les rôles d'un utilisateur

  • Description :
    UserID (obligatoire) : l'identifiant de l'utilisateur.

    Active (facultatif) : booléen – valeur par défaut : vide

    Name (facultatif) : le nom du rôle

    Type (facultatif) : {Standard|Default|Administrator}

  • Par défaut : oui

  • Opération : userRoles

  • Commande : GET

  • Route/Chemin : /Organization/UserRoles?UserId={UserId}

Ajouter un utilisateur à un rôle

  • Description : UserID (obligatoire) : l'identifiant de l'utilisateur.

  • Par défaut : oui

  • Opération : userRoles

  • Commande : PUT

  • Route/Chemin : Organization/UserRoles?UserId={UserId}

  • Corps HTTP (exemple) : 

    { "Ids": [ "2d89fc45-a3c4-49c6-971b-ebc696a67d78" ], "OperationType": "Add" }

Retirer un utilisateur d'un rôle

  • Description : UserID (obligatoire) : l'identifiant de l'utilisateur.

  • Opération : userRoles

  • Commande : PUT

  • Route/Chemin : Organization/UserRoles?UserId={UserId}

  • Corps HTTP (exemple) : 

    { "Ids": [ "2d89fc45-a3c4-49c6-971b-ebc696a67d78" ], "OperationType": "Remove" }

Obtenir tous les groupes d'un utilisateur

  • Description :
    UserID (obligatoire) : l'identifiant de l'utilisateur.

    Active (facultatif) : booléen – valeur par défaut : vide

    Name (facultatif) : le nom du groupe

  • Par défaut : oui

  • Opération : userGroups

  • Commande : GET

  • Route/Chemin : /Organization/UserGroups?UserId={UserId}

Ajouter un utilisateur à un groupe

  • Description : UserID (obligatoire) : l'identifiant de l'utilisateur.

  • Par défaut : oui

  • Opération : userGroups

  • Commande : PUT

  • Route/Chemin : /Organization/UserGroups?UserId={UserId}

  • Corps HTTP (exemple) : 

    { "Ids": [ "2d89fc45-a3c4-49c6-971b-ebc696a67d78" ], "OperationType": "Add" }

Retirer un utilisateur d'un groupe

  • Description : UserID (obligatoire) : l'identifiant de l'utilisateur.

  • Par défaut : oui

  • Opération : userGroups

  • Commande : PUT

  • Route/Chemin : /Organization/UserGroups?UserId={UserId}

  • Corps HTTP (exemple) : 

    { "Ids": [ "2d89fc45-a3c4-49c6-971b-ebc696a67d78" ], "OperationType": "Remove" }

Obtenir tous les rôles de l'organisation

  • Description :
    Active (facultatif) : booléen – valeur par défaut : vide

    Name (facultatif) : le nom du rôle

    Type (facultatif) : {Standard|Default|Administrator}

  • Opération : roles

  • Commande : GET

  • Route/Chemin : /Organization/Roles? Active={true|false}&Name={RoleName}&Type={Standard|Default|Administrator}

Obtenir les informations d'un rôle

  • Description :
    permet d'obtenir les informations d'un rôle, telles que l'état actif.

    RoleID (obligatoire) : l'identifiant du rôle.

  • Par défaut : oui

  • Opération : role

  • Commande : GET

  • Route/Chemin : /Organization/Role?roleId={RoleId}

Obtenir tous les groupes de l'organisation

  • Description :
    Active (facultatif) : booléen – valeur par défaut : vide

    Name (facultatif) : le nom du groupe

  • Par défaut : oui

  • Opération : groups

  • Commande : GET

  • Route/Chemin : /Organization/Groups?&Active={true|false}&Name={GroupName}

Obtenir les informations d'un groupe

  • Description :
    permet d'obtenir les informations d'un groupe, telles que l'état actif.

    GroupID (obligatoire) : l'identifiant du groupe.

  • Par défaut : oui

  • Opération : group

  • Commande : GET

  • Route/Chemin : /Organization/Group?groupId={GroupId}

Créer un nouveau groupe

  • Description : automatise la création de groupes DocuWare. Par exemple, lorsque de nouveaux fichiers de projet sont stockés, un groupe portant le nom du projet peut être créé et un profil de valeur d'index peut être attribué à ce groupe.
    Propriétés obligatoires :

    • id

    • name

    • active

  • Par défaut : oui

  • Opération : createGroup

  • Commande : POST

  • Route/Chemin : /Organization/Groups

  • Corps HTTP (exemple) : 

    { "Ids": [ "group-1234" ], "name": "Accounting Team", "Active": "true" }

Exemple d'utilisation pour apposer un tampon avec l'endpoint « documentAnnotations »

Après le traitement d'une facture dans le logiciel de comptabilité, vous souhaitez apposer automatiquement un tampon « Payée » sur la facture dans DocuWare.

Pour ce faire, créez une tâche Autoindex qui modifie l'entrée d'index de la facture en « payée ». La modification de l'entrée d'index déclenche un processus de travail dont l'activité de service web appose automatiquement le tampon « Payée » sur le document de facture.

Le tampon « Payée » doit être configuré et attribué à l'utilisateur spécifié pour l'exécution des activités automatiques du processus de travail.

Versions prises en charge : DocuWare Cloud + 7.14 + 7.13 + 7.12 + 7.11 + 7.10