DocuWare
Accédez aux fonctionnalités courantes de DocuWare à partir de vos flux.
Ce connecteur est disponible dans les produits et régions suivants :
| Service | classe | Régions |
|---|---|---|
| Copilot Studio | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Applications logiques | Norme | Toutes les régions Logic Apps , à l’exception des suivantes : - Régions Azure Government - Régions Azure Chine - Us Department of Defense (DoD) |
| Power Apps | Premium | Toutes les régions Power Apps , à l’exception des suivantes : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Contact | |
|---|---|
| Nom | DocuWare GmbH |
| URL | https://support.docuware.com |
| Messagerie électronique | support@docuware.com |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | DocuWare |
| Site internet | https://start.docuware.com |
| Politique de confidentialité | https://start.docuware.com/data-privacy |
| Catégories | Contenu et fichiers ; Productivité |
DocuWare fournit une API REST puissante et étendue. Avec le connecteur Power Automate de DocuWare, les utilisateurs peuvent désormais tirer parti de la plupart des fonctionnalités les plus courantes de l’API REST DocuWare dans Power Automate. Cela permet à l’utilisateur de créer des flux qui répondent pleinement à leurs besoins métier, grâce à l’intégration transparente avec DocuWare.
Prerequisites
Vous devez procéder comme suit :
- Un abonnement DocuWare Cloud
- Un compte Microsoft Power Apps ou Power Automate
Comment obtenir des informations d’identification
La création d’une clé API est facile et peut être effectuée à partir de DocuWare.
Procédez comme suit pour créer une clé API dans DocuWare :
- Connectez-vous à votre compte DocuWare que vous souhaitez utiliser avec Power Automate
- Dans le menu principal, accédez à « Configurations »
- Dans la page « Configurations », accédez à la section « Intégrations », puis cliquez sur l’icône « Clés API Power Automate »
- Si vous ne voyez pas l’icône « Clés API Power Automate », il est possible que votre utilisateur ne dispose pas des autorisations appropriées. Contactez votre administrateur DocuWare pour résoudre ce problème.
- Cliquez sur le bouton « Créer une clé API »
- Renseignez les valeurs « Name » et « Description » (facultatif), puis cliquez sur « Créer »
- Après avoir appuyé sur « Créer », il peut y avoir un léger délai lorsque le processus de configuration crée votre clé.
- Veillez également à enregistrer votre clé API. Il s’agit de votre seule opportunité d’afficher la clé API complète. Si vous perdez cette clé, vous devrez en créer une autre.
À ce stade, vous disposez maintenant d’une clé API valide qui peut être utilisée dans Power Automate pour créer une connexion à DocuWare. Cette connexion peut ensuite être utilisée avec le connecteur DocuWare Power Automate.
Bien démarrer avec votre connecteur
La création d’une connexion dans Power Automate est facile et peut être effectuée lorsque vous créez vos flux.
Procédez comme suit pour créer une connexion dans Power Automate :
- Connexion à Power Automate
- Créer un flux ou ouvrir un flux existant
- Ajouter une activité à partir du connecteur DocuWare Power Automate à votre flux
- Cliquez sur « + Nouvelle étape » pour ajouter une nouvelle étape à votre flux
- Lorsqu’elle est présentée avec « Choisir une opération », sélectionnez « Tout » dans la sélection de catégorie, puis tapez « DocuWare » dans le champ de recherche.
- Sélectionnez le connecteur « DocuWare », puis choisissez dans la liste des actions disponibles.
- Lorsque l’action est ajoutée au flux, vous êtes invité à créer une connexion.
- Entrez un nom de connexion (« Nom de connexion ») et la clé API (« Clé API ») que vous avez reçue de DocuWare dans la section précédente, puis cliquez sur « Créer ».
À partir de ce stade, toutes les activités ajoutées à partir du connecteur DocuWare utilisent cette connexion. Vous pouvez créer des connexions supplémentaires en cliquant sur le bouton « ... » dans le coin supérieur droit d’une activité, puis en cliquant sur « + Ajouter une nouvelle connexion » en bas du menu qui s’affiche.
Problèmes connus et limitations
À ce stade, le connecteur Power Automate de DocuWare n’est pas pris en charge dans le nouveau concepteur de flux Power Automate.
Erreurs courantes et solutions
Codes d’erreur HTTP :
- 400 : Vérifiez que vous avez rempli tous les champs requis dans l’activité. Certains champs sont obligatoires et doivent être remplis avant que l’activité puisse être exécutée.
- 401 : Vérifiez que vous avez entré la clé API correcte. Vous pouvez également vérifier l’état de la clé API dans la page « Configurations », sous « Intégrations » -> « Clés API Power Automate ».
- 404 : Assurez-vous que le document spécifié et/ou l’armoire de fichiers existent et que vous y avez accès. Si le document ou l’armoire de fichiers n’existe pas ou si vous n’avez pas accès à ces documents, vous recevrez une erreur 404.
- 500 : Il s’agit d’une erreur générique qui peut être provoquée par un certain nombre de problèmes différents. Si vous recevez cette erreur, contactez le support Technique DocuWare pour obtenir de l’aide.
Questions fréquentes (FAQ)
Meilleures pratiques
Voici quelques-unes des meilleures pratiques que nous vous recommandons lors de l’utilisation du connecteur DocuWare Power Automate :
- Utilisez toujours un utilisateur DocuWare dédié pour l’authentification auprès du connecteur DocuWare Power Automate. Cela vous permet de suivre et de gérer facilement les actions effectuées par le connecteur.
- Commencez par tester votre flux avec l’activité « Obtenir l’organisation ». Il s’agit de l’action la plus simple fournie dans le connecteur DocuWare Power Automate et vous permet de vérifier que votre connexion fonctionne correctement.
Création d’une connexion
Le connecteur prend en charge les types d’authentification suivants :
| Par défaut | Paramètres de création de connexion. | Toutes les régions | Non partageable |
Faire défaut
Applicable : Toutes les régions
Paramètres de création de connexion.
Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.
| Nom | Type | Descriptif | Obligatoire |
|---|---|---|---|
| Clé API | securestring | Clé API pour accéder à DocuWare | Vrai |
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Ajouter un fichier |
Ajoute un fichier/section à un document existant. |
| Importer dans la barre d’état des documents |
Importez un nouveau document dans une barre d’état de document. |
| Mettre à jour les champs d’index |
Met à jour les champs d’index d’un document. |
| Obtenir des armoires de fichiers et des plateaux de documents |
Obtient une liste d’armoires de fichiers et/ou de plateaux de documents. |
| Obtenir des boîtes de dialogue |
Obtient une liste de boîtes de dialogue pour une boîte de fichiers ou une barre d’état de documents. |
| Obtenir des champs d’horodatage |
Obtient une liste de champs pour un tampon. |
| Obtenir des informations sur le document |
Obtient des informations sur un document. |
| Obtenir des tampons |
Obtient une liste d’empreintes pour une armoire de fichiers ou un plateau de documents. |
| Obtenir les champs de boîte de dialogue |
Obtient les champs d’une boîte de dialogue |
| Obtenir les champs de l’armoire de fichiers |
Obtient la liste des champs d’une armoire de fichiers. |
| Obtenir l’organisation |
Obtenez le nom de l’organisation. |
| Placer un tampon |
Place un tampon sur un document. |
| Rechercher dans l’armoire de fichiers |
Recherchez dans une armoire de fichiers des documents correspondant aux critères spécifiés. |
| Remplacer un fichier |
Remplace un fichier/section dans un document existant. |
| Répertorier les documents dans la barre d’état des documents |
Répertorier les documents à partir de la barre d’état de documents spécifiée. |
| Stocker dans une armoire de fichiers |
Stocke un nouveau document dans une armoire de fichiers. |
| Supprimer un document |
Supprime un document d’une armoire de fichiers ou d’une barre d’état de documents. |
| Supprimer un fichier |
Supprime un fichier/section d’un document existant. |
| Transférer des documents |
Déplace un ou plusieurs documents d’une armoire de fichiers/plateau de documents vers un autre. |
| Téléchargement d’un fichier |
Télécharge un fichier/section d’un document stocké dans une boîte de fichiers ou une barre d’état de documents. |
| Télécharger un document |
Télécharge un document à partir d’une armoire de fichiers ou d’une barre d’état de documents. |
Ajouter un fichier
Ajoute un fichier/section à un document existant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Armoire de fichiers/Plateau de documents
|
FileCabinet | True | string |
Sélectionnez l’armoire de fichiers ou la barre d’état des documents avec votre document. |
|
Document ID
|
DocID | True | string |
Spécifiez l’ID du document à ajouter. |
|
Contenu du fichier
|
file | file |
Spécifiez le contenu du fichier à stocker. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
SignatureStatus
|
SignatureStatus | array of string |
SignatureStatus |
|
SectionId
|
SectionId | string |
SectionId |
|
ContentType
|
ContentType | string |
ContentType |
|
HaveMorePages
|
HaveMorePages | boolean |
HaveMorePages |
|
PageCount
|
PageCount | integer |
PageCount |
|
Taille de fichier
|
FileSize | integer |
Taille de fichier |
|
OriginalFileName
|
OriginalFileName | string |
OriginalFileName |
|
ContentModified
|
ContentModified | string |
ContentModified |
|
HasTextAnnotation
|
HasTextAnnotation | boolean |
HasTextAnnotation |
|
AnnotationsPreview
|
AnnotationsPreview | boolean |
AnnotationsPreview |
Importer dans la barre d’état des documents
Importez un nouveau document dans une barre d’état de document.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Plateau de documents
|
DocumentTray | True | string |
Sélectionnez la barre d’état de document à importer. |
|
Boîte de dialogue Stocker
|
StoreDialogId | string |
Sélectionnez la boîte de dialogue stocker à utiliser lors de l’importation. |
|
|
Données d’index
|
index | string |
Spécifiez les données d’index du document. |
|
|
Contenu du fichier
|
file | file |
Spécifiez le contenu du fichier à importer. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Rubriques
|
Sections | array of object |
Rubriques |
|
SignatureStatus
|
Sections.SignatureStatus | array of string |
SignatureStatus |
|
SectionId
|
Sections.SectionId | string |
SectionId |
|
ContentType
|
Sections.ContentType | string |
ContentType |
|
HaveMorePages
|
Sections.HaveMorePages | boolean |
HaveMorePages |
|
PageCount
|
Sections.PageCount | integer |
PageCount |
|
Taille de fichier
|
Sections.FileSize | integer |
Taille de fichier |
|
OriginalFileName
|
Sections.OriginalFileName | string |
OriginalFileName |
|
ContentModified
|
Sections.ContentModified | string |
ContentModified |
|
HasTextAnnotation
|
Sections.HasTextAnnotation | boolean |
HasTextAnnotation |
|
AnnotationsPreview
|
Sections.AnnotationsPreview | boolean |
AnnotationsPreview |
|
DocumentId
|
DocumentId | integer |
DocumentId |
|
IndexFields
|
IndexFields | object |
IndexFields |
|
DocumentTitle
|
DocumentTitle | string |
DocumentTitle |
|
FileCabinetId
|
FileCabinetId | string |
FileCabinetId |
|
TotalPages
|
TotalPages | integer |
TotalPages |
|
Taille de fichier
|
FileSize | integer |
Taille de fichier |
|
ContentType
|
ContentType | string |
ContentType |
|
VersionStatus
|
VersionStatus | string |
VersionStatus |
|
isCold
|
DocumentFlags.isCold | boolean |
isCold |
|
isDBRecord
|
DocumentFlags.isDBRecord | boolean |
isDBRecord |
|
isCheckedOut
|
DocumentFlags.isCheckedOut | boolean |
isCheckedOut |
|
isCopyRightProtected
|
DocumentFlags.isCopyRightProtected | boolean |
isCopyRightProtected |
|
isVoiceAvailable
|
DocumentFlags.isVoiceAvailable | boolean |
isVoiceAvailable |
|
hasAppendedDocuments
|
DocumentFlags.hasAppendedDocuments | boolean |
hasAppendedDocuments |
|
isProtected
|
DocumentFlags.isProtected | boolean |
isProtected |
|
isDeleted
|
DocumentFlags.isDeleted | boolean |
isDeleted |
|
isEmail
|
DocumentFlags.isEmail | boolean |
isEmail |
Mettre à jour les champs d’index
Met à jour les champs d’index d’un document.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Armoire de fichiers
|
FileCabinetID | True | string |
Sélectionnez l’armoire de fichiers avec le document à mettre à jour. |
|
Document ID
|
DocumentID | True | integer |
Spécifiez l’ID du document à mettre à jour. |
|
Nom
|
Name | string |
Sélectionnez ou spécifiez un champ d’index. |
|
|
Valeur
|
Value | string |
Spécifiez une valeur d’index. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Rubriques
|
Sections | array of object |
Rubriques |
|
SignatureStatus
|
Sections.SignatureStatus | array of string |
SignatureStatus |
|
SectionId
|
Sections.SectionId | string |
SectionId |
|
ContentType
|
Sections.ContentType | string |
ContentType |
|
HaveMorePages
|
Sections.HaveMorePages | boolean |
HaveMorePages |
|
PageCount
|
Sections.PageCount | integer |
PageCount |
|
Taille de fichier
|
Sections.FileSize | integer |
Taille de fichier |
|
OriginalFileName
|
Sections.OriginalFileName | string |
OriginalFileName |
|
ContentModified
|
Sections.ContentModified | string |
ContentModified |
|
HasTextAnnotation
|
Sections.HasTextAnnotation | boolean |
HasTextAnnotation |
|
AnnotationsPreview
|
Sections.AnnotationsPreview | boolean |
AnnotationsPreview |
|
DocumentId
|
DocumentId | integer |
DocumentId |
|
IndexFields
|
IndexFields | object |
IndexFields |
|
DocumentTitle
|
DocumentTitle | string |
DocumentTitle |
|
FileCabinetId
|
FileCabinetId | string |
FileCabinetId |
|
TotalPages
|
TotalPages | integer |
TotalPages |
|
Taille de fichier
|
FileSize | integer |
Taille de fichier |
|
ContentType
|
ContentType | string |
ContentType |
|
VersionStatus
|
VersionStatus | string |
VersionStatus |
|
isCold
|
DocumentFlags.isCold | boolean |
isCold |
|
isDBRecord
|
DocumentFlags.isDBRecord | boolean |
isDBRecord |
|
isCheckedOut
|
DocumentFlags.isCheckedOut | boolean |
isCheckedOut |
|
isCopyRightProtected
|
DocumentFlags.isCopyRightProtected | boolean |
isCopyRightProtected |
|
isVoiceAvailable
|
DocumentFlags.isVoiceAvailable | boolean |
isVoiceAvailable |
|
hasAppendedDocuments
|
DocumentFlags.hasAppendedDocuments | boolean |
hasAppendedDocuments |
|
isProtected
|
DocumentFlags.isProtected | boolean |
isProtected |
|
isDeleted
|
DocumentFlags.isDeleted | boolean |
isDeleted |
|
isEmail
|
DocumentFlags.isEmail | boolean |
isEmail |
Obtenir des armoires de fichiers et des plateaux de documents
Obtient une liste d’armoires de fichiers et/ou de plateaux de documents.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Type d’armoire de fichiers
|
FileCabinetType | True | string |
Sélectionnez les types que vous souhaitez retourner. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
FileCabinets
|
FileCabinets | array of object |
FileCabinets |
|
Nom
|
FileCabinets.Name | string |
Nom |
|
GUID
|
FileCabinets.Guid | string |
GUID |
|
Color
|
FileCabinets.Color | string |
Color |
|
IsTray
|
FileCabinets.IsTray | boolean |
IsTray |
Obtenir des boîtes de dialogue
Obtient une liste de boîtes de dialogue pour une boîte de fichiers ou une barre d’état de documents.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Armoire de fichiers/Plateau de documents
|
FileCabinet | True | string |
Sélectionnez l’armoire de fichiers ou la barre d’état des documents à partir duquel obtenir des boîtes de dialogue. |
|
Type de boîte de dialogue
|
DialogType | string |
Sélectionnez le type de dialogue à retourner. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Dialogs
|
Dialogs | array of object |
Dialogs |
|
Nom
|
Dialogs.Name | string |
Nom |
|
GUID
|
Dialogs.Guid | string |
GUID |
|
Color
|
Dialogs.Color | string |
Color |
|
IsDefault
|
Dialogs.IsDefault | boolean |
IsDefault |
|
Type
|
Dialogs.Type | string |
Type |
|
FileCabinetId
|
Dialogs.FileCabinetId | string |
FileCabinetId |
Obtenir des champs d’horodatage
Obtient une liste de champs pour un tampon.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Armoire de fichiers/Plateau de documents
|
FileCabinet | True | string |
Sélectionnez l’armoire de fichiers ou la barre d’état de documents avec l’empreinte souhaitée. |
|
Timbre
|
Stamp | True | string |
Sélectionnez l’empreinte pour obtenir ses champs. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Fields
|
Fields | array of object |
Fields |
|
Id
|
Fields.Id | string |
Id |
|
Étiquette
|
Fields.Label | string |
Étiquette |
|
DisplayName
|
Fields.DisplayName | string |
DisplayName |
Obtenir des informations sur le document
Obtient des informations sur un document.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Armoire de fichiers/Plateau de documents
|
FileCabinetID | True | string |
Sélectionnez l’armoire de fichiers ou la barre d’état des documents avec votre document. |
|
Document ID
|
DocumentID | True | integer |
Spécifiez l’ID du document sur lequel vous souhaitez obtenir des informations. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Rubriques
|
Sections | array of object |
Rubriques |
|
SignatureStatus
|
Sections.SignatureStatus | array of string |
SignatureStatus |
|
SectionId
|
Sections.SectionId | string |
SectionId |
|
ContentType
|
Sections.ContentType | string |
ContentType |
|
HaveMorePages
|
Sections.HaveMorePages | boolean |
HaveMorePages |
|
PageCount
|
Sections.PageCount | integer |
PageCount |
|
Taille de fichier
|
Sections.FileSize | integer |
Taille de fichier |
|
OriginalFileName
|
Sections.OriginalFileName | string |
OriginalFileName |
|
ContentModified
|
Sections.ContentModified | string |
ContentModified |
|
HasTextAnnotation
|
Sections.HasTextAnnotation | boolean |
HasTextAnnotation |
|
AnnotationsPreview
|
Sections.AnnotationsPreview | boolean |
AnnotationsPreview |
|
DocumentId
|
DocumentId | integer |
DocumentId |
|
IndexFields
|
IndexFields | object |
IndexFields |
|
DocumentTitle
|
DocumentTitle | string |
DocumentTitle |
|
FileCabinetId
|
FileCabinetId | string |
FileCabinetId |
|
TotalPages
|
TotalPages | integer |
TotalPages |
|
Taille de fichier
|
FileSize | integer |
Taille de fichier |
|
ContentType
|
ContentType | string |
ContentType |
|
VersionStatus
|
VersionStatus | string |
VersionStatus |
|
isCold
|
DocumentFlags.isCold | boolean |
isCold |
|
isDBRecord
|
DocumentFlags.isDBRecord | boolean |
isDBRecord |
|
isCheckedOut
|
DocumentFlags.isCheckedOut | boolean |
isCheckedOut |
|
isCopyRightProtected
|
DocumentFlags.isCopyRightProtected | boolean |
isCopyRightProtected |
|
isVoiceAvailable
|
DocumentFlags.isVoiceAvailable | boolean |
isVoiceAvailable |
|
hasAppendedDocuments
|
DocumentFlags.hasAppendedDocuments | boolean |
hasAppendedDocuments |
|
isProtected
|
DocumentFlags.isProtected | boolean |
isProtected |
|
isDeleted
|
DocumentFlags.isDeleted | boolean |
isDeleted |
|
isEmail
|
DocumentFlags.isEmail | boolean |
isEmail |
Obtenir des tampons
Obtient une liste d’empreintes pour une armoire de fichiers ou un plateau de documents.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Armoire de fichiers/Plateau de documents
|
FileCabinet | True | string |
Sélectionnez l’armoire de fichiers ou la barre d’état des documents pour obtenir des empreintes. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Album
|
Stamps | array of object |
Album |
|
Id
|
Stamps.Id | string |
Id |
|
Nom
|
Stamps.Name | string |
Nom |
|
DisplayName
|
Stamps.DisplayName | string |
DisplayName |
|
Color
|
Stamps.Color | string |
Color |
|
Signature
|
Stamps.Signature | string |
Signature |
|
Protection par mot de passe
|
Stamps.PasswordProtected | boolean |
Protection par mot de passe |
|
Écraser
|
Stamps.Overwrite | boolean |
Écraser |
|
Type
|
Stamps.Type | string |
Type |
|
FileCabinetId
|
Stamps.FileCabinetId | string |
FileCabinetId |
Obtenir les champs de boîte de dialogue
Obtient les champs d’une boîte de dialogue
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Armoire de fichiers
|
FileCabinet | True | string |
Sélectionner l’armoire de fichiers |
|
Dialog
|
DialogId | True | string |
Sélectionnez la boîte de dialogue pour laquelle obtenir les champs. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Fields
|
Fields | array of object |
Fields |
|
DBFieldName
|
Fields.DBFieldName | string |
DBFieldName |
|
DWFieldType
|
Fields.DWFieldType | string |
DWFieldType |
|
DisplayName
|
Fields.DisplayName | string |
DisplayName |
|
ReadOnly
|
Fields.ReadOnly | boolean |
ReadOnly |
|
Visibles
|
Fields.Visible | boolean |
Visibles |
Obtenir les champs de l’armoire de fichiers
Obtient la liste des champs d’une armoire de fichiers.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Armoire de fichiers
|
FileCabinet | True | string |
Sélectionnez l’armoire de fichiers pour laquelle obtenir les champs. |
|
Type de champ
|
FieldType | string |
Sélectionnez le type de champs à retourner. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Fields
|
Fields | array of object |
Fields |
|
TableFieldColumns
|
Fields.TableFieldColumns | array of object |
TableFieldColumns |
|
DBFieldName
|
Fields.TableFieldColumns.DBFieldName | string |
DBFieldName |
|
DWFieldType
|
Fields.TableFieldColumns.DWFieldType | string |
DWFieldType |
|
DisplayName
|
Fields.TableFieldColumns.DisplayName | string |
DisplayName |
|
DropLeadingBlanks
|
Fields.TableFieldColumns.DropLeadingBlanks | boolean |
DropLeadingBlanks |
|
DropLeadingZero
|
Fields.TableFieldColumns.DropLeadingZero | boolean |
DropLeadingZero |
|
FieldInfoText
|
Fields.TableFieldColumns.FieldInfoText | string |
FieldInfoText |
|
FixedEntry
|
Fields.TableFieldColumns.FixedEntry | string |
FixedEntry |
|
Length
|
Fields.TableFieldColumns.Length | integer |
Length |
|
NotEmpty
|
Fields.TableFieldColumns.NotEmpty | boolean |
NotEmpty |
|
Précision
|
Fields.TableFieldColumns.Precision | integer |
Précision |
|
Scope
|
Fields.TableFieldColumns.Scope | string |
Scope |
|
UsedAsDocumentName
|
Fields.UsedAsDocumentName | boolean |
UsedAsDocumentName |
|
DBFieldName
|
Fields.DBFieldName | string |
DBFieldName |
|
DWFieldType
|
Fields.DWFieldType | string |
DWFieldType |
|
DisplayName
|
Fields.DisplayName | string |
DisplayName |
|
DropLeadingBlanks
|
Fields.DropLeadingBlanks | boolean |
DropLeadingBlanks |
|
DropLeadingZero
|
Fields.DropLeadingZero | boolean |
DropLeadingZero |
|
FieldInfoText
|
Fields.FieldInfoText | string |
FieldInfoText |
|
FixedEntry
|
Fields.FixedEntry | string |
FixedEntry |
|
Length
|
Fields.Length | integer |
Length |
|
NotEmpty
|
Fields.NotEmpty | boolean |
NotEmpty |
|
Précision
|
Fields.Precision | integer |
Précision |
|
Scope
|
Fields.Scope | string |
Scope |
Obtenir l’organisation
Obtenez le nom de l’organisation.
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nom
|
Name | string |
Nom |
Placer un tampon
Place un tampon sur un document.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Armoire de fichiers/Plateau de documents
|
FileCabinetID | True | string |
Sélectionnez l’armoire de fichiers ou la barre d’état des documents avec votre document. |
|
Document ID
|
DocumentID | True | integer |
Spécifiez l’ID du document que vous souhaitez tamponner. |
|
Numéro de fichier
|
FileNumber | True | integer |
Spécifiez le fichier/section contenant la page à tamponner. |
|
Numéro de page
|
PageNumber | True | integer |
Spécifiez le numéro de page sur lequel placer l’empreinte. |
|
Couche
|
Layer | True | integer |
Spécifier la couche de document à placer sur [1-5] |
|
Position horizontale (position X)
|
PositionX | number |
[Facultatif] Position à partir du bord gauche de la page en mm. |
|
|
Position verticale (position Y)
|
PositionY | number |
[Facultatif] Position à partir du bord supérieur de la page en mm. |
|
|
Timbre
|
StampId | True | string |
Sélectionnez ou spécifiez l’empreinte à utiliser. |
|
Mot de passe
|
Password | string |
Spécifiez le mot de passe du tampon (si nécessaire). |
|
|
Nom
|
Name | string |
Spécifiez un nom de champ. |
|
|
Valeur
|
Value | string |
Spécifiez une valeur de champ. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Utilisateur
|
Created.User | string |
Utilisateur |
|
Heure
|
Created.Time | string |
Heure |
|
Type
|
Type | string |
Type |
|
Color
|
Color | string |
Color |
|
Rotation
|
Rotation | integer |
Rotation |
|
Transparent
|
Transparent | boolean |
Transparent |
|
StrokeWidth
|
StrokeWidth | integer |
StrokeWidth |
|
GUID
|
Guid | string |
GUID |
Rechercher dans l’armoire de fichiers
Recherchez dans une armoire de fichiers des documents correspondant aux critères spécifiés.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Armoire de fichiers
|
FileCabinet | True | string |
Sélectionnez l’armoire de fichiers à rechercher. |
|
Boîte de dialogue Rechercher
|
SearchDialogId | True | string |
Sélectionnez la boîte de dialogue de recherche à utiliser pour la recherche. |
|
Requête de recherche
|
SearchQuery | True |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre
|
Count | integer |
Nombre |
|
Documents
|
Documents | array of object |
Documents |
|
Rubriques
|
Documents.Sections | array of |
Rubriques |
|
DocumentId
|
Documents.DocumentId | integer |
DocumentId |
|
IndexFields
|
Documents.IndexFields | object |
IndexFields |
|
DocumentTitle
|
Documents.DocumentTitle | string |
DocumentTitle |
|
FileCabinetId
|
Documents.FileCabinetId | string |
FileCabinetId |
|
TotalPages
|
Documents.TotalPages | integer |
TotalPages |
|
Taille de fichier
|
Documents.FileSize | integer |
Taille de fichier |
|
ContentType
|
Documents.ContentType | string |
ContentType |
|
VersionStatus
|
Documents.VersionStatus | string |
VersionStatus |
|
isCold
|
Documents.DocumentFlags.isCold | boolean |
isCold |
|
isDBRecord
|
Documents.DocumentFlags.isDBRecord | boolean |
isDBRecord |
|
isCheckedOut
|
Documents.DocumentFlags.isCheckedOut | boolean |
isCheckedOut |
|
isCopyRightProtected
|
Documents.DocumentFlags.isCopyRightProtected | boolean |
isCopyRightProtected |
|
isVoiceAvailable
|
Documents.DocumentFlags.isVoiceAvailable | boolean |
isVoiceAvailable |
|
hasAppendedDocuments
|
Documents.DocumentFlags.hasAppendedDocuments | boolean |
hasAppendedDocuments |
|
isProtected
|
Documents.DocumentFlags.isProtected | boolean |
isProtected |
|
isDeleted
|
Documents.DocumentFlags.isDeleted | boolean |
isDeleted |
|
isEmail
|
Documents.DocumentFlags.isEmail | boolean |
isEmail |
Remplacer un fichier
Remplace un fichier/section dans un document existant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Armoire de fichiers/Plateau de documents
|
FileCabinet | True | string |
Sélectionnez l’armoire de fichiers ou la barre d’état des documents avec votre document. |
|
Document ID
|
DocumentID | True | integer |
Spécifiez l’ID du document par le fichier à remplacer. |
|
Numéro de fichier
|
FileNumber | True | integer |
Spécifiez le numéro de fichier à remplacer. |
|
Contenu du fichier
|
file | file |
Spécifiez le contenu du fichier à stocker. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
SignatureStatus
|
SignatureStatus | array of string |
SignatureStatus |
|
SectionId
|
SectionId | string |
SectionId |
|
ContentType
|
ContentType | string |
ContentType |
|
HaveMorePages
|
HaveMorePages | boolean |
HaveMorePages |
|
PageCount
|
PageCount | integer |
PageCount |
|
Taille de fichier
|
FileSize | integer |
Taille de fichier |
|
OriginalFileName
|
OriginalFileName | string |
OriginalFileName |
|
ContentModified
|
ContentModified | string |
ContentModified |
|
HasTextAnnotation
|
HasTextAnnotation | boolean |
HasTextAnnotation |
|
AnnotationsPreview
|
AnnotationsPreview | boolean |
AnnotationsPreview |
Répertorier les documents dans la barre d’état des documents
Répertorier les documents à partir de la barre d’état de documents spécifiée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Plateau de documents
|
DocumentTray | True | string |
Sélectionnez la barre d’état de document à rechercher. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre
|
Count | integer |
Nombre |
|
Documents
|
Documents | array of object | |
|
Rubriques
|
Documents.Sections | array of |
Rubriques |
|
DocumentId
|
Documents.DocumentId | integer |
DocumentId |
|
IndexFields
|
Documents.IndexFields | object |
IndexFields |
|
DocumentTitle
|
Documents.DocumentTitle | string |
DocumentTitle |
|
FileCabinetId
|
Documents.FileCabinetId | string |
FileCabinetId |
|
TotalPages
|
Documents.TotalPages | integer |
TotalPages |
|
Taille de fichier
|
Documents.FileSize | integer |
Taille de fichier |
|
ContentType
|
Documents.ContentType | string |
ContentType |
|
VersionStatus
|
Documents.VersionStatus | string |
VersionStatus |
|
isCold
|
Documents.DocumentFlags.isCold | boolean |
isCold |
|
isDBRecord
|
Documents.DocumentFlags.isDBRecord | boolean |
isDBRecord |
|
isCheckedOut
|
Documents.DocumentFlags.isCheckedOut | boolean |
isCheckedOut |
|
isCopyRightProtected
|
Documents.DocumentFlags.isCopyRightProtected | boolean |
isCopyRightProtected |
|
isVoiceAvailable
|
Documents.DocumentFlags.isVoiceAvailable | boolean |
isVoiceAvailable |
|
hasAppendedDocuments
|
Documents.DocumentFlags.hasAppendedDocuments | boolean |
hasAppendedDocuments |
|
isProtected
|
Documents.DocumentFlags.isProtected | boolean |
isProtected |
|
isDeleted
|
Documents.DocumentFlags.isDeleted | boolean |
isDeleted |
|
isEmail
|
Documents.DocumentFlags.isEmail | boolean |
isEmail |
Stocker dans une armoire de fichiers
Stocke un nouveau document dans une armoire de fichiers.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Armoire de fichiers
|
FileCabinet | True | string |
Sélectionnez l’armoire de fichiers dans laquelle stocker. |
|
Boîte de dialogue Stocker
|
StoreDialogId | True | string |
Sélectionnez la boîte de dialogue stocker à utiliser pour le stockage. |
|
Données d’index
|
index | string |
Spécifiez les données d’index du document. |
|
|
Contenu du fichier
|
file | file |
Spécifiez le contenu du fichier à stocker. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Rubriques
|
Sections | array of object |
Rubriques |
|
SignatureStatus
|
Sections.SignatureStatus | array of string |
SignatureStatus |
|
SectionId
|
Sections.SectionId | string |
SectionId |
|
ContentType
|
Sections.ContentType | string |
ContentType |
|
HaveMorePages
|
Sections.HaveMorePages | boolean |
HaveMorePages |
|
PageCount
|
Sections.PageCount | integer |
PageCount |
|
Taille de fichier
|
Sections.FileSize | integer |
Taille de fichier |
|
OriginalFileName
|
Sections.OriginalFileName | string |
OriginalFileName |
|
ContentModified
|
Sections.ContentModified | string |
ContentModified |
|
HasTextAnnotation
|
Sections.HasTextAnnotation | boolean |
HasTextAnnotation |
|
AnnotationsPreview
|
Sections.AnnotationsPreview | boolean |
AnnotationsPreview |
|
DocumentId
|
DocumentId | integer |
DocumentId |
|
IndexFields
|
IndexFields | object |
IndexFields |
|
DocumentTitle
|
DocumentTitle | string |
DocumentTitle |
|
FileCabinetId
|
FileCabinetId | string |
FileCabinetId |
|
TotalPages
|
TotalPages | integer |
TotalPages |
|
Taille de fichier
|
FileSize | integer |
Taille de fichier |
|
ContentType
|
ContentType | string |
ContentType |
|
VersionStatus
|
VersionStatus | string |
VersionStatus |
|
isCold
|
DocumentFlags.isCold | boolean |
isCold |
|
isDBRecord
|
DocumentFlags.isDBRecord | boolean |
isDBRecord |
|
isCheckedOut
|
DocumentFlags.isCheckedOut | boolean |
isCheckedOut |
|
isCopyRightProtected
|
DocumentFlags.isCopyRightProtected | boolean |
isCopyRightProtected |
|
isVoiceAvailable
|
DocumentFlags.isVoiceAvailable | boolean |
isVoiceAvailable |
|
hasAppendedDocuments
|
DocumentFlags.hasAppendedDocuments | boolean |
hasAppendedDocuments |
|
isProtected
|
DocumentFlags.isProtected | boolean |
isProtected |
|
isDeleted
|
DocumentFlags.isDeleted | boolean |
isDeleted |
|
isEmail
|
DocumentFlags.isEmail | boolean |
isEmail |
Supprimer un document
Supprime un document d’une armoire de fichiers ou d’une barre d’état de documents.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Armoire de fichiers/Plateau de documents
|
FileCabinetID | True | string |
Sélectionnez l’armoire de fichiers ou la barre d’état des documents avec votre document. |
|
Document ID
|
DocumentID | True | integer |
Spécifiez l’ID du document à supprimer. |
Supprimer un fichier
Supprime un fichier/section d’un document existant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Armoire de fichiers/Plateau de documents
|
FileCabinet | True | string |
Sélectionnez l’armoire de fichiers ou la barre d’état des documents avec votre document. |
|
Document ID
|
DocumentID | True | integer |
Spécifiez l’ID du document à supprimer. |
|
Numéro de fichier
|
FileNumber | True | integer |
Spécifiez le numéro de fichier à supprimer. |
Transférer des documents
Déplace un ou plusieurs documents d’une armoire de fichiers/plateau de documents vers un autre.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Classeur de destination/Plateau de documents
|
DestinationFileCabinetID | True | string |
Sélectionnez l’armoire de fichiers de destination ou la barre d’état des documents. |
|
Boîte de dialogue Stocker
|
StoreDialogID | string |
Sélectionnez la boîte de dialogue de magasin pour l’indexation des documents déplacés. |
|
|
Bac à documents/Armoire de fichiers source
|
SourceFileCabinetId | True | string |
Sélectionnez l’armoire de fichiers source ou la barre d’état des documents. |
|
ID
|
DocumentId | integer |
Spécifiez un ID de document. |
|
|
Nom
|
Name | string |
Sélectionnez ou spécifiez un nom de champ. |
|
|
Valeur
|
Value | string |
Spécifiez une valeur de champ. |
|
|
Conserver la source
|
KeepSource | boolean |
Indiquez si les documents sources doivent être supprimés ou non. |
|
|
Remplir Intellix
|
FillIntellix | boolean |
Choisissez si l’indexation intelligente doit être utilisée lors du stockage. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre
|
Count | integer |
Nombre |
|
Documents
|
Documents | array of object |
Documents |
|
Rubriques
|
Documents.Sections | array of object |
Rubriques |
|
SignatureStatus
|
Documents.Sections.SignatureStatus | array of string |
SignatureStatus |
|
SectionId
|
Documents.Sections.SectionId | string |
SectionId |
|
ContentType
|
Documents.Sections.ContentType | string |
ContentType |
|
HaveMorePages
|
Documents.Sections.HaveMorePages | boolean |
HaveMorePages |
|
PageCount
|
Documents.Sections.PageCount | integer |
PageCount |
|
Taille de fichier
|
Documents.Sections.FileSize | integer |
Taille de fichier |
|
OriginalFileName
|
Documents.Sections.OriginalFileName | string |
OriginalFileName |
|
ContentModified
|
Documents.Sections.ContentModified | string |
ContentModified |
|
HasTextAnnotation
|
Documents.Sections.HasTextAnnotation | boolean |
HasTextAnnotation |
|
AnnotationsPreview
|
Documents.Sections.AnnotationsPreview | boolean |
AnnotationsPreview |
|
DocumentId
|
Documents.DocumentId | integer |
DocumentId |
|
IndexFields
|
Documents.IndexFields | object |
IndexFields |
|
DocumentTitle
|
Documents.DocumentTitle | string |
DocumentTitle |
|
FileCabinetId
|
Documents.FileCabinetId | string |
FileCabinetId |
|
TotalPages
|
Documents.TotalPages | integer |
TotalPages |
|
Taille de fichier
|
Documents.FileSize | integer |
Taille de fichier |
|
ContentType
|
Documents.ContentType | string |
ContentType |
|
VersionStatus
|
Documents.VersionStatus | string |
VersionStatus |
|
isCold
|
Documents.DocumentFlags.isCold | boolean |
isCold |
|
isDBRecord
|
Documents.DocumentFlags.isDBRecord | boolean |
isDBRecord |
|
isCheckedOut
|
Documents.DocumentFlags.isCheckedOut | boolean |
isCheckedOut |
|
isCopyRightProtected
|
Documents.DocumentFlags.isCopyRightProtected | boolean |
isCopyRightProtected |
|
isVoiceAvailable
|
Documents.DocumentFlags.isVoiceAvailable | boolean |
isVoiceAvailable |
|
hasAppendedDocuments
|
Documents.DocumentFlags.hasAppendedDocuments | boolean |
hasAppendedDocuments |
|
isProtected
|
Documents.DocumentFlags.isProtected | boolean |
isProtected |
|
isDeleted
|
Documents.DocumentFlags.isDeleted | boolean |
isDeleted |
|
isEmail
|
Documents.DocumentFlags.isEmail | boolean |
isEmail |
Téléchargement d’un fichier
Télécharge un fichier/section d’un document stocké dans une boîte de fichiers ou une barre d’état de documents.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Armoire de fichiers/Plateau de documents
|
FileCabinetID | True | string |
Sélectionnez l’armoire de fichiers ou la barre d’état des documents avec votre document. |
|
Document ID
|
DocumentId | True | integer |
Spécifiez l’ID du document avec le fichier que vous souhaitez télécharger. |
|
Numéro de fichier
|
FileNumber | True | string |
Spécifiez le numéro de fichier du fichier que vous souhaitez télécharger. |
|
Document Format
|
DocumentFormat | True | string |
Sélectionnez le format du document téléchargé. |
Retours
Corps
- Corps
- binary
Télécharger un document
Télécharge un document à partir d’une armoire de fichiers ou d’une barre d’état de documents.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Armoire de fichiers/Plateau de documents
|
FileCabinetID | True | string |
Sélectionnez l’armoire de fichiers ou la barre d’état des documents avec votre document. |
|
Document ID
|
DocumentId | True | integer |
Spécifiez l’ID du document que vous souhaitez télécharger. |
|
Document Format
|
DocumentFormat | True | string |
Sélectionnez le format du document téléchargé. |
Retours
Corps
- Corps
- binary
Définitions
binaire
Il s’agit du type de données de base "binaire".