DocuWare
Greifen Sie in Ihren Flüssen auf allgemeine DocuWare-Features zu.
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Dienstleistung | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Logik-Apps | Norm | Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: – Azure Government-Regionen - Azure China-Regionen - US Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | DocuWare GmbH |
| URL | https://support.docuware.com |
| support@docuware.com |
| Connectormetadaten | |
|---|---|
| Herausgeber | DocuWare |
| Webseite | https://start.docuware.com |
| Datenschutzrichtlinie | https://start.docuware.com/data-privacy |
| Kategorien | Inhalt und Dateien; Produktivität |
DocuWare bietet eine leistungsstarke und umfangreiche REST-API. Mit dem Power Automate Connector von DocuWare können Benutzer jetzt viele der am häufigsten verwendeten Features der DocuWare-REST-API in Power Automate nutzen. Dies ermöglicht es dem Benutzer, dank der nahtlosen Integration in DocuWare Abläufe zu schaffen, die ihre Geschäftsanforderungen vollständig erfüllen.
Voraussetzungen
Sie benötigen Folgendes, um fortzufahren:
- Ein DocuWare Cloud-Abonnement
- Ein Microsoft Power Apps- oder Power Automate-Konto
So erhalten Sie Anmeldeinformationen
Das Erstellen eines neuen API-Schlüssels ist einfach und kann in DocuWare erfolgen.
Führen Sie die folgenden Schritte aus, um einen neuen API-Schlüssel in DocuWare zu erstellen:
- Melden Sie sich bei Ihrem DocuWare-Konto an, das Sie mit Power Automate verwenden möchten
- Navigieren Sie im Hauptmenü zu "Konfigurationen".
- Wechseln Sie auf der Seite "Konfigurationen" zum Abschnitt "Integrationen", und klicken Sie auf das Symbol für "Power Automate-API-Schlüssel"
- Wenn das Symbol "Power Automate-API-Schlüssel" nicht angezeigt wird, ist es möglich, dass Der Benutzer nicht über die richtigen Berechtigungen verfügt. Wenden Sie sich an Ihren DocuWare-Administrator, um dies zu beheben.
- Klicken Sie auf die Schaltfläche "API-Schlüssel erstellen"
- Füllen Sie die Werte "Name" und "Description" (optional) aus, und klicken Sie auf "Erstellen".
- Nach dem Drücken von "Erstellen" kann es eine geringfügige Verzögerung geben, da der Konfigurationsprozess Ihren Schlüssel erstellt.
- Achten Sie außerdem darauf, den API-Schlüssel zu speichern. Dies ist Ihre einzige Möglichkeit, den vollständigen API-Schlüssel anzuzeigen. Wenn Sie diesen Schlüssel verlieren, müssen Sie eine weitere erstellen.
An diesem Punkt verfügen Sie jetzt über einen gültigen API-Schlüssel, der in Power Automate verwendet werden kann, um eine Verbindung mit DocuWare zu erstellen. Diese Verbindung kann dann mit dem DocuWare Power Automate Connector verwendet werden.
Erste Schritte mit Ihrem Connector
Das Erstellen einer Verbindung in Power Automate ist einfach und kann ausgeführt werden, wenn Sie Ihre Flüsse erstellen.
Führen Sie die folgenden Schritte aus, um eine neue Verbindung in Power Automate zu erstellen:
- Anmelden bei Power Automate
- Erstellen eines neuen Flusses oder Öffnen eines vorhandenen Flusses
- Hinzufügen einer Aktivität aus dem DocuWare Power Automate-Connector zu Ihrem Flow
- Klicken Sie auf "+ Neuer Schritt", um ihrem Fluss einen neuen Schritt hinzuzufügen.
- Wenn "Auswählen eines Vorgangs" angezeigt wird, wählen Sie "Alle" aus der Kategorieauswahl aus, und geben Sie dann "DocuWare" in das Suchfeld ein.
- Wählen Sie den "DocuWare"-Connector und dann aus der Liste der verfügbaren Aktionen aus.
- Wenn die Aktion dem Fluss hinzugefügt wird, werden Sie aufgefordert, eine neue Verbindung zu erstellen.
- Geben Sie einen Verbindungsnamen ("Verbindungsname") und den API-Schlüssel ("API-Schlüssel") ein, den Sie von DocuWare im vorherigen Abschnitt erhalten haben, und klicken Sie auf "Erstellen".
Ab diesem Zeitpunkt verwenden alle Aktivitäten, die aus dem DocuWare-Connector hinzugefügt werden, diese Verbindung. Sie können zusätzliche Verbindungen erstellen, indem Sie auf "..." klicken. in der oberen rechten Ecke einer Aktivität, und klicken Sie dann unten im Menü auf "+ Neue Verbindung hinzufügen", das eingeblendet wird.
Bekannte Probleme und Einschränkungen
Derzeit wird der Power Automate-Connector von DocuWare im neuen Power Automate Flow-Designer nicht unterstützt.
Häufige Fehler und Abhilfemaßnahmen
HTTP-Fehlercodes:
- 400: Stellen Sie sicher, dass Sie alle erforderlichen Felder in der Aktivität ausgefüllt haben. Einige Felder sind erforderlich und müssen ausgefüllt werden, bevor die Aktivität ausgeführt werden kann.
- 401: Stellen Sie sicher, dass Sie den richtigen API-Schlüssel eingegeben haben. Sie können auch den Status des API-Schlüssels auf der Seite "Konfigurationen" unter "Integrationen" –> "Power Automate-API-Schlüssel" überprüfen.
- 404: Stellen Sie sicher, dass das angegebene Dokument und/oder dateischrank vorhanden sind und Sie Zugriff darauf haben. Wenn das Dokument oder die Dateischrank nicht vorhanden ist oder Sie keinen Zugriff darauf haben, erhalten Sie einen Fehler 404.
- 500: Dies ist ein allgemeiner Fehler, der durch eine Reihe verschiedener Probleme verursacht werden kann. Wenn Sie diese Fehlermeldung erhalten, wenden Sie sich an den DocuWare-Support, um Unterstützung zu erhalten.
Häufig gestellte Fragen
Bewährte Methoden
Im Folgenden sind einige der bewährten Methoden aufgeführt, die wir bei der Verwendung des DocuWare Power Automate-Connectors empfehlen:
- Verwenden Sie immer einen dedizierten DocuWare-Benutzer für die Authentifizierung mit dem DocuWare Power Automate Connector. Auf diese Weise können Sie die Aktionen, die vom Connector ausgeführt werden, ganz einfach nachverfolgen und verwalten.
- Testen Sie zunächst Ihren Ablauf mit der Aktivität "Organisation abrufen". Dies ist die grundlegendste Aktion, die im DocuWare Power Automate Connector bereitgestellt wird, und ermöglicht Es Ihnen zu überprüfen, ob Ihre Verbindung ordnungsgemäß funktioniert.
Erstellen einer Verbindung
Der Connector unterstützt die folgenden Authentifizierungstypen:
| Vorgabe | Parameter zum Erstellen einer Verbindung. | Alle Regionen | Nicht teilbar |
Vorgabe
Anwendbar: Alle Regionen
Parameter zum Erstellen einer Verbindung.
Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.
| Name | Typ | Description | Erforderlich |
|---|---|---|---|
| API-Schlüssel | securestring | Der API-Schlüssel für den Zugriff auf DocuWare | Richtig |
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Abrufen von Dateischrankfeldern |
Ruft eine Liste der Felder für ein Dateischrank ab. |
| Abrufen von Dateischränken und Dokumentschacht |
Ruft eine Liste von Dateischränken und/oder Dokumentleisten ab. |
| Abrufen von Dokumentinformationen |
Ruft Informationen zu einem Dokument ab. |
| Abrufen von Stempelfeldern |
Ruft eine Liste der Felder für einen Stempel ab. |
| Abrufen von Stempeln |
Ruft eine Liste der Stempel für eine Dateischrank oder Dokumentleiste ab. |
| Aktualisieren von Indexfeldern |
Aktualisiert die Indexfelder eines Dokuments. |
| Anfügen einer Datei |
Fügt eine Datei/einen Abschnitt an ein vorhandenes Dokument an. |
| Auflisten von Dokumenten in der Dokumentleiste |
Auflisten von Dokumenten aus der angegebenen Dokumentleiste |
| Dialogfelder abrufen |
Ruft eine Liste der Dialogfelder für eine Dateischrank oder Dokumentleiste ab. |
| Dialogfeldfelder abrufen |
Ruft die Felder für ein Dialogfeld ab. |
| Ersetzen einer Datei |
Ersetzt eine Datei/einen Abschnitt in einem vorhandenen Dokument. |
| Herunterladen einer Datei |
Lädt eine Datei/einen Abschnitt eines Dokuments herunter, das in einem Dateischrank oder einer Dokumentleiste gespeichert ist. |
| Herunterladen eines Dokuments |
Lädt ein Dokument aus einem Dateischrank oder einer Dokumentleiste herunter. |
| In Dateischrank speichern |
Speichert ein neues Dokument in einem Dateischrank. |
| In Dokumentleiste importieren |
Importieren Sie ein neues Dokument in eine Dokumentleiste. |
| Löschen einer Datei |
Löscht eine Datei/einen Abschnitt aus einem vorhandenen Dokument. |
| Löschen eines Dokuments |
Löscht ein Dokument aus einem Dateischrank oder einer Dokumentleiste. |
| Organisation abrufen |
Rufen Sie den Organisationsnamen ab. |
| Platzieren eines Stempels |
Platziert einen Stempel auf einem Dokument. |
| Suchen im Dateischrank |
Durchsuchen Sie eine Dateischrank nach Dokumenten, die den angegebenen Kriterien entsprechen. |
| Übertragen von Dokumenten |
Verschiebt ein oder mehrere Dokumente aus einem Dateischrank/Dokumentschacht in eine andere. |
Abrufen von Dateischrankfeldern
Ruft eine Liste der Felder für ein Dateischrank ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Aktenschrank
|
FileCabinet | True | string |
Wählen Sie die Dateischrank aus, für die Felder abgerufen werden sollen. |
|
Feldtyp
|
FieldType | string |
Wählen Sie den Typ der zurückzugebenden Felder aus. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Felder
|
Fields | array of object |
Felder |
|
TableFieldColumns
|
Fields.TableFieldColumns | array of object |
TableFieldColumns |
|
DBFieldName
|
Fields.TableFieldColumns.DBFieldName | string |
DBFieldName |
|
DWFieldType
|
Fields.TableFieldColumns.DWFieldType | string |
DWFieldType |
|
Anzeigename
|
Fields.TableFieldColumns.DisplayName | string |
Anzeigename |
|
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äzision
|
Fields.TableFieldColumns.Precision | integer |
Präzision |
|
Umfang
|
Fields.TableFieldColumns.Scope | string |
Umfang |
|
UsedAsDocumentName
|
Fields.UsedAsDocumentName | boolean |
UsedAsDocumentName |
|
DBFieldName
|
Fields.DBFieldName | string |
DBFieldName |
|
DWFieldType
|
Fields.DWFieldType | string |
DWFieldType |
|
Anzeigename
|
Fields.DisplayName | string |
Anzeigename |
|
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äzision
|
Fields.Precision | integer |
Präzision |
|
Umfang
|
Fields.Scope | string |
Umfang |
Abrufen von Dateischränken und Dokumentschacht
Ruft eine Liste von Dateischränken und/oder Dokumentleisten ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dateischranktyp
|
FileCabinetType | True | string |
Wählen Sie aus, welche Typen zurückgegeben werden sollen. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
FileCabinets
|
FileCabinets | array of object |
FileCabinets |
|
Name
|
FileCabinets.Name | string |
Name |
|
Leitfaden
|
FileCabinets.Guid | string |
Leitfaden |
|
Farbe
|
FileCabinets.Color | string |
Farbe |
|
IsTray
|
FileCabinets.IsTray | boolean |
IsTray |
Abrufen von Dokumentinformationen
Ruft Informationen zu einem Dokument ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dateischrank/Dokumentschacht
|
FileCabinetID | True | string |
Wählen Sie die Dateischrank oder Dokumentleiste mit Ihrem Dokument aus. |
|
Dokument-ID
|
DocumentID | True | integer |
Geben Sie die ID des Dokuments an, zu dem Sie Informationen benötigen. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Abschnitte
|
Sections | array of object |
Abschnitte |
|
SignatureStatus
|
Sections.SignatureStatus | array of string |
SignatureStatus |
|
SectionId
|
Sections.SectionId | string |
SectionId |
|
Inhaltstyp
|
Sections.ContentType | string |
Inhaltstyp |
|
HaveMorePages
|
Sections.HaveMorePages | boolean |
HaveMorePages |
|
PageCount
|
Sections.PageCount | integer |
PageCount |
|
Dateigröße
|
Sections.FileSize | integer |
Dateigröße |
|
OriginalFileName
|
Sections.OriginalFileName | string |
OriginalFileName |
|
ContentModified
|
Sections.ContentModified | string |
ContentModified |
|
HasTextAnnotation
|
Sections.HasTextAnnotation | boolean |
HasTextAnnotation |
|
AnnotationsPreview
|
Sections.AnnotationsPreview | boolean |
AnnotationsPreview |
|
DokumentID
|
DocumentId | integer |
DokumentID |
|
IndexFields
|
IndexFields | object |
IndexFields |
|
DocumentTitle
|
DocumentTitle | string |
DocumentTitle |
|
FileCabinetId
|
FileCabinetId | string |
FileCabinetId |
|
TotalPages
|
TotalPages | integer |
TotalPages |
|
Dateigröße
|
FileSize | integer |
Dateigröße |
|
Inhaltstyp
|
ContentType | string |
Inhaltstyp |
|
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 |
Abrufen von Stempelfeldern
Ruft eine Liste der Felder für einen Stempel ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dateischrank/Dokumentschacht
|
FileCabinet | True | string |
Wählen Sie den Dateischrank oder die Dokumentleiste mit dem gewünschten Stempel aus. |
|
Briefmarke
|
Stamp | True | string |
Wählen Sie den Stempel aus, um dessen Felder abzurufen. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Felder
|
Fields | array of object |
Felder |
|
Id
|
Fields.Id | string |
Id |
|
Etikett
|
Fields.Label | string |
Etikett |
|
Anzeigename
|
Fields.DisplayName | string |
Anzeigename |
Abrufen von Stempeln
Ruft eine Liste der Stempel für eine Dateischrank oder Dokumentleiste ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dateischrank/Dokumentschacht
|
FileCabinet | True | string |
Wählen Sie die Dateischrank- oder Dokumentleiste aus, um Stempel abzurufen. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Briefmarken
|
Stamps | array of object |
Briefmarken |
|
Id
|
Stamps.Id | string |
Id |
|
Name
|
Stamps.Name | string |
Name |
|
Anzeigename
|
Stamps.DisplayName | string |
Anzeigename |
|
Farbe
|
Stamps.Color | string |
Farbe |
|
Signature
|
Stamps.Signature | string |
Signature |
|
PasswordProtected
|
Stamps.PasswordProtected | boolean |
PasswordProtected |
|
Überschreiben
|
Stamps.Overwrite | boolean |
Überschreiben |
|
Typ
|
Stamps.Type | string |
Typ |
|
FileCabinetId
|
Stamps.FileCabinetId | string |
FileCabinetId |
Aktualisieren von Indexfeldern
Aktualisiert die Indexfelder eines Dokuments.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Aktenschrank
|
FileCabinetID | True | string |
Wählen Sie die Dateischrank mit dem zu aktualisierenden Dokument aus. |
|
Dokument-ID
|
DocumentID | True | integer |
Geben Sie die ID des zu aktualisierenden Dokuments an. |
|
Name
|
Name | string |
Wählen Sie ein Indexfeld aus, oder geben Sie es an. |
|
|
Wert
|
Value | string |
Geben Sie einen Indexwert an. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Abschnitte
|
Sections | array of object |
Abschnitte |
|
SignatureStatus
|
Sections.SignatureStatus | array of string |
SignatureStatus |
|
SectionId
|
Sections.SectionId | string |
SectionId |
|
Inhaltstyp
|
Sections.ContentType | string |
Inhaltstyp |
|
HaveMorePages
|
Sections.HaveMorePages | boolean |
HaveMorePages |
|
PageCount
|
Sections.PageCount | integer |
PageCount |
|
Dateigröße
|
Sections.FileSize | integer |
Dateigröße |
|
OriginalFileName
|
Sections.OriginalFileName | string |
OriginalFileName |
|
ContentModified
|
Sections.ContentModified | string |
ContentModified |
|
HasTextAnnotation
|
Sections.HasTextAnnotation | boolean |
HasTextAnnotation |
|
AnnotationsPreview
|
Sections.AnnotationsPreview | boolean |
AnnotationsPreview |
|
DokumentID
|
DocumentId | integer |
DokumentID |
|
IndexFields
|
IndexFields | object |
IndexFields |
|
DocumentTitle
|
DocumentTitle | string |
DocumentTitle |
|
FileCabinetId
|
FileCabinetId | string |
FileCabinetId |
|
TotalPages
|
TotalPages | integer |
TotalPages |
|
Dateigröße
|
FileSize | integer |
Dateigröße |
|
Inhaltstyp
|
ContentType | string |
Inhaltstyp |
|
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 |
Anfügen einer Datei
Fügt eine Datei/einen Abschnitt an ein vorhandenes Dokument an.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dateischrank/Dokumentschacht
|
FileCabinet | True | string |
Wählen Sie die Dateischrank oder Dokumentleiste mit Ihrem Dokument aus. |
|
Dokument-ID
|
DocID | True | string |
Geben Sie die ID des anzufügenden Dokuments an. |
|
Dateiinhalte
|
file | file |
Geben Sie den Inhalt der zu speichernden Datei an. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
SignatureStatus
|
SignatureStatus | array of string |
SignatureStatus |
|
SectionId
|
SectionId | string |
SectionId |
|
Inhaltstyp
|
ContentType | string |
Inhaltstyp |
|
HaveMorePages
|
HaveMorePages | boolean |
HaveMorePages |
|
PageCount
|
PageCount | integer |
PageCount |
|
Dateigröße
|
FileSize | integer |
Dateigröße |
|
OriginalFileName
|
OriginalFileName | string |
OriginalFileName |
|
ContentModified
|
ContentModified | string |
ContentModified |
|
HasTextAnnotation
|
HasTextAnnotation | boolean |
HasTextAnnotation |
|
AnnotationsPreview
|
AnnotationsPreview | boolean |
AnnotationsPreview |
Auflisten von Dokumenten in der Dokumentleiste
Auflisten von Dokumenten aus der angegebenen Dokumentleiste
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokumentleiste
|
DocumentTray | True | string |
Wählen Sie die zu durchsuchende Dokumentleiste aus. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anzahl
|
Count | integer |
Anzahl |
|
Dokumente
|
Documents | array of object | |
|
Abschnitte
|
Documents.Sections | array of |
Abschnitte |
|
DokumentID
|
Documents.DocumentId | integer |
DokumentID |
|
IndexFields
|
Documents.IndexFields | object |
IndexFields |
|
DocumentTitle
|
Documents.DocumentTitle | string |
DocumentTitle |
|
FileCabinetId
|
Documents.FileCabinetId | string |
FileCabinetId |
|
TotalPages
|
Documents.TotalPages | integer |
TotalPages |
|
Dateigröße
|
Documents.FileSize | integer |
Dateigröße |
|
Inhaltstyp
|
Documents.ContentType | string |
Inhaltstyp |
|
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 |
Dialogfelder abrufen
Ruft eine Liste der Dialogfelder für eine Dateischrank oder Dokumentleiste ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dateischrank/Dokumentschacht
|
FileCabinet | True | string |
Wählen Sie die Dateischrank- oder Dokumentleiste aus, um Dialogfelder abzurufen. |
|
Dialogfeldtyp
|
DialogType | string |
Wählen Sie den Typ der zurückzugebenden Dialogfelder aus. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Dialogfelder
|
Dialogs | array of object |
Dialogfelder |
|
Name
|
Dialogs.Name | string |
Name |
|
Leitfaden
|
Dialogs.Guid | string |
Leitfaden |
|
Farbe
|
Dialogs.Color | string |
Farbe |
|
IsDefault
|
Dialogs.IsDefault | boolean |
IsDefault |
|
Typ
|
Dialogs.Type | string |
Typ |
|
FileCabinetId
|
Dialogs.FileCabinetId | string |
FileCabinetId |
Dialogfeldfelder abrufen
Ruft die Felder für ein Dialogfeld ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Aktenschrank
|
FileCabinet | True | string |
Auswählen des Dateischranks |
|
Dialogfeld
|
DialogId | True | string |
Wählen Sie das Dialogfeld aus, für das die Felder abgerufen werden sollen. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Felder
|
Fields | array of object |
Felder |
|
DBFieldName
|
Fields.DBFieldName | string |
DBFieldName |
|
DWFieldType
|
Fields.DWFieldType | string |
DWFieldType |
|
Anzeigename
|
Fields.DisplayName | string |
Anzeigename |
|
ReadOnly
|
Fields.ReadOnly | boolean |
ReadOnly |
|
Sichtbar
|
Fields.Visible | boolean |
Sichtbar |
Ersetzen einer Datei
Ersetzt eine Datei/einen Abschnitt in einem vorhandenen Dokument.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dateischrank/Dokumentschacht
|
FileCabinet | True | string |
Wählen Sie die Dateischrank oder Dokumentleiste mit Ihrem Dokument aus. |
|
Dokument-ID
|
DocumentID | True | integer |
Geben Sie die ID des Dokuments durch die zu ersetzende Datei an. |
|
Aktenzeichen
|
FileNumber | True | integer |
Geben Sie die zu ersetzende Dateinummer an. |
|
Dateiinhalte
|
file | file |
Geben Sie den Inhalt der zu speichernden Datei an. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
SignatureStatus
|
SignatureStatus | array of string |
SignatureStatus |
|
SectionId
|
SectionId | string |
SectionId |
|
Inhaltstyp
|
ContentType | string |
Inhaltstyp |
|
HaveMorePages
|
HaveMorePages | boolean |
HaveMorePages |
|
PageCount
|
PageCount | integer |
PageCount |
|
Dateigröße
|
FileSize | integer |
Dateigröße |
|
OriginalFileName
|
OriginalFileName | string |
OriginalFileName |
|
ContentModified
|
ContentModified | string |
ContentModified |
|
HasTextAnnotation
|
HasTextAnnotation | boolean |
HasTextAnnotation |
|
AnnotationsPreview
|
AnnotationsPreview | boolean |
AnnotationsPreview |
Herunterladen einer Datei
Lädt eine Datei/einen Abschnitt eines Dokuments herunter, das in einem Dateischrank oder einer Dokumentleiste gespeichert ist.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dateischrank/Dokumentschacht
|
FileCabinetID | True | string |
Wählen Sie die Dateischrank oder Dokumentleiste mit Ihrem Dokument aus. |
|
Dokument-ID
|
DocumentId | True | integer |
Geben Sie die ID des Dokuments mit der Datei an, die Sie herunterladen möchten. |
|
Aktenzeichen
|
FileNumber | True | string |
Geben Sie die Dateinummer der Datei an, die Sie herunterladen möchten. |
|
Dokumentformat
|
DocumentFormat | True | string |
Wählen Sie das Format für das heruntergeladene Dokument aus. |
Gibt zurück
Body
- Body
- binary
Herunterladen eines Dokuments
Lädt ein Dokument aus einem Dateischrank oder einer Dokumentleiste herunter.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dateischrank/Dokumentschacht
|
FileCabinetID | True | string |
Wählen Sie die Dateischrank oder Dokumentleiste mit Ihrem Dokument aus. |
|
Dokument-ID
|
DocumentId | True | integer |
Geben Sie die ID des Dokuments an, das Sie herunterladen möchten. |
|
Dokumentformat
|
DocumentFormat | True | string |
Wählen Sie das Format für das heruntergeladene Dokument aus. |
Gibt zurück
Body
- Body
- binary
In Dateischrank speichern
Speichert ein neues Dokument in einem Dateischrank.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Aktenschrank
|
FileCabinet | True | string |
Wählen Sie das Zu speichernde Dateischrank aus. |
|
Dialogfeld "Store"
|
StoreDialogId | True | string |
Wählen Sie das Speicherdialogfeld aus, das zum Speichern verwendet werden soll. |
|
Indexdaten
|
index | string |
Geben Sie die Indexdaten für das Dokument an. |
|
|
Dateiinhalte
|
file | file |
Geben Sie den Inhalt der zu speichernden Datei an. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Abschnitte
|
Sections | array of object |
Abschnitte |
|
SignatureStatus
|
Sections.SignatureStatus | array of string |
SignatureStatus |
|
SectionId
|
Sections.SectionId | string |
SectionId |
|
Inhaltstyp
|
Sections.ContentType | string |
Inhaltstyp |
|
HaveMorePages
|
Sections.HaveMorePages | boolean |
HaveMorePages |
|
PageCount
|
Sections.PageCount | integer |
PageCount |
|
Dateigröße
|
Sections.FileSize | integer |
Dateigröße |
|
OriginalFileName
|
Sections.OriginalFileName | string |
OriginalFileName |
|
ContentModified
|
Sections.ContentModified | string |
ContentModified |
|
HasTextAnnotation
|
Sections.HasTextAnnotation | boolean |
HasTextAnnotation |
|
AnnotationsPreview
|
Sections.AnnotationsPreview | boolean |
AnnotationsPreview |
|
DokumentID
|
DocumentId | integer |
DokumentID |
|
IndexFields
|
IndexFields | object |
IndexFields |
|
DocumentTitle
|
DocumentTitle | string |
DocumentTitle |
|
FileCabinetId
|
FileCabinetId | string |
FileCabinetId |
|
TotalPages
|
TotalPages | integer |
TotalPages |
|
Dateigröße
|
FileSize | integer |
Dateigröße |
|
Inhaltstyp
|
ContentType | string |
Inhaltstyp |
|
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 |
In Dokumentleiste importieren
Importieren Sie ein neues Dokument in eine Dokumentleiste.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokumentleiste
|
DocumentTray | True | string |
Wählen Sie die Dokumentleiste aus, in die sie importiert werden soll. |
|
Dialogfeld "Store"
|
StoreDialogId | string |
Wählen Sie das Dialogfeld "Store" aus, das während des Imports verwendet werden soll. |
|
|
Indexdaten
|
index | string |
Geben Sie die Indexdaten für das Dokument an. |
|
|
Dateiinhalte
|
file | file |
Geben Sie den Inhalt der zu importierenden Datei an. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Abschnitte
|
Sections | array of object |
Abschnitte |
|
SignatureStatus
|
Sections.SignatureStatus | array of string |
SignatureStatus |
|
SectionId
|
Sections.SectionId | string |
SectionId |
|
Inhaltstyp
|
Sections.ContentType | string |
Inhaltstyp |
|
HaveMorePages
|
Sections.HaveMorePages | boolean |
HaveMorePages |
|
PageCount
|
Sections.PageCount | integer |
PageCount |
|
Dateigröße
|
Sections.FileSize | integer |
Dateigröße |
|
OriginalFileName
|
Sections.OriginalFileName | string |
OriginalFileName |
|
ContentModified
|
Sections.ContentModified | string |
ContentModified |
|
HasTextAnnotation
|
Sections.HasTextAnnotation | boolean |
HasTextAnnotation |
|
AnnotationsPreview
|
Sections.AnnotationsPreview | boolean |
AnnotationsPreview |
|
DokumentID
|
DocumentId | integer |
DokumentID |
|
IndexFields
|
IndexFields | object |
IndexFields |
|
DocumentTitle
|
DocumentTitle | string |
DocumentTitle |
|
FileCabinetId
|
FileCabinetId | string |
FileCabinetId |
|
TotalPages
|
TotalPages | integer |
TotalPages |
|
Dateigröße
|
FileSize | integer |
Dateigröße |
|
Inhaltstyp
|
ContentType | string |
Inhaltstyp |
|
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 |
Löschen einer Datei
Löscht eine Datei/einen Abschnitt aus einem vorhandenen Dokument.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dateischrank/Dokumentschacht
|
FileCabinet | True | string |
Wählen Sie die Dateischrank oder Dokumentleiste mit Ihrem Dokument aus. |
|
Dokument-ID
|
DocumentID | True | integer |
Geben Sie die ID des zu löschenden Dokuments an. |
|
Aktenzeichen
|
FileNumber | True | integer |
Geben Sie die zu löschende Dateinummer an. |
Löschen eines Dokuments
Löscht ein Dokument aus einem Dateischrank oder einer Dokumentleiste.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dateischrank/Dokumentschacht
|
FileCabinetID | True | string |
Wählen Sie die Dateischrank oder Dokumentleiste mit Ihrem Dokument aus. |
|
Dokument-ID
|
DocumentID | True | integer |
Geben Sie die ID des Dokuments an, das Sie löschen möchten. |
Organisation abrufen
Rufen Sie den Organisationsnamen ab.
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Name
|
Name | string |
Name |
Platzieren eines Stempels
Platziert einen Stempel auf einem Dokument.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dateischrank/Dokumentschacht
|
FileCabinetID | True | string |
Wählen Sie die Dateischrank oder Dokumentleiste mit Ihrem Dokument aus. |
|
Dokument-ID
|
DocumentID | True | integer |
Geben Sie die ID des Dokuments an, das Sie stempeln möchten. |
|
Aktenzeichen
|
FileNumber | True | integer |
Geben Sie die Datei/den Abschnitt an, die die zu stempelnde Seite enthält. |
|
Seitennummer
|
PageNumber | True | integer |
Geben Sie die Seitenzahl an, auf der der Stempel platziert werden soll. |
|
Ebene
|
Layer | True | integer |
Geben Sie die Dokumentebene an, um den Stempel auf [1-5] zu platzieren. |
|
Horizontale Position (X-Position)
|
PositionX | number |
[Optional] Position vom linken Rand der Seite in mm. |
|
|
Vertikale Position (Y-Position)
|
PositionY | number |
[Optional] Position vom oberen Rand der Seite in mm. |
|
|
Briefmarke
|
StampId | True | string |
Wählen Sie den zu verwendenden Stempel aus, oder geben Sie den zu verwendenden Stempel an. |
|
Kennwort
|
Password | string |
Geben Sie das Kennwort für den Stempel an (falls erforderlich). |
|
|
Name
|
Name | string |
Geben Sie einen Feldnamen an. |
|
|
Wert
|
Value | string |
Geben Sie einen Feldwert an. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Benutzer
|
Created.User | string |
Benutzer |
|
Uhrzeit
|
Created.Time | string |
Uhrzeit |
|
Typ
|
Type | string |
Typ |
|
Farbe
|
Color | string |
Farbe |
|
Drehung
|
Rotation | integer |
Drehung |
|
Transparent
|
Transparent | boolean |
Transparent |
|
StrokeWidth
|
StrokeWidth | integer |
StrokeWidth |
|
Leitfaden
|
Guid | string |
Leitfaden |
Suchen im Dateischrank
Durchsuchen Sie eine Dateischrank nach Dokumenten, die den angegebenen Kriterien entsprechen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Aktenschrank
|
FileCabinet | True | string |
Wählen Sie das zu durchsuchende Dateischrank aus. |
|
Suchdialogfeld
|
SearchDialogId | True | string |
Wählen Sie das Suchdialogfeld aus, das für die Suche verwendet werden soll. |
|
Suchabfrage
|
SearchQuery | True |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anzahl
|
Count | integer |
Anzahl |
|
Dokumente
|
Documents | array of object |
Dokumente |
|
Abschnitte
|
Documents.Sections | array of |
Abschnitte |
|
DokumentID
|
Documents.DocumentId | integer |
DokumentID |
|
IndexFields
|
Documents.IndexFields | object |
IndexFields |
|
DocumentTitle
|
Documents.DocumentTitle | string |
DocumentTitle |
|
FileCabinetId
|
Documents.FileCabinetId | string |
FileCabinetId |
|
TotalPages
|
Documents.TotalPages | integer |
TotalPages |
|
Dateigröße
|
Documents.FileSize | integer |
Dateigröße |
|
Inhaltstyp
|
Documents.ContentType | string |
Inhaltstyp |
|
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 |
Übertragen von Dokumenten
Verschiebt ein oder mehrere Dokumente aus einem Dateischrank/Dokumentschacht in eine andere.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Zieldateischrank/Dokumentschacht
|
DestinationFileCabinetID | True | string |
Wählen Sie das Zieldateischrank oder die Dokumentleiste aus. |
|
Dialogfeld "Store"
|
StoreDialogID | string |
Wählen Sie das Speicherdialogfeld zum Indizieren der verschobenen Dokumente aus. |
|
|
Quelldateischrank/Dokumentschacht
|
SourceFileCabinetId | True | string |
Wählen Sie das Quelldateischrank oder die Dokumentleiste aus. |
|
ID
|
DocumentId | integer |
Geben Sie eine Dokument-ID an. |
|
|
Name
|
Name | string |
Wählen Oder geben Sie einen Feldnamen an. |
|
|
Wert
|
Value | string |
Geben Sie einen Feldwert an. |
|
|
Quelle beibehalten
|
KeepSource | boolean |
Wählen Sie aus, ob die Quelldokumente gelöscht werden sollen. |
|
|
Intellix ausfüllen
|
FillIntellix | boolean |
Wählen Sie aus, ob intelligente Indizierung beim Speichern verwendet werden soll. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anzahl
|
Count | integer |
Anzahl |
|
Dokumente
|
Documents | array of object |
Dokumente |
|
Abschnitte
|
Documents.Sections | array of object |
Abschnitte |
|
SignatureStatus
|
Documents.Sections.SignatureStatus | array of string |
SignatureStatus |
|
SectionId
|
Documents.Sections.SectionId | string |
SectionId |
|
Inhaltstyp
|
Documents.Sections.ContentType | string |
Inhaltstyp |
|
HaveMorePages
|
Documents.Sections.HaveMorePages | boolean |
HaveMorePages |
|
PageCount
|
Documents.Sections.PageCount | integer |
PageCount |
|
Dateigröße
|
Documents.Sections.FileSize | integer |
Dateigröße |
|
OriginalFileName
|
Documents.Sections.OriginalFileName | string |
OriginalFileName |
|
ContentModified
|
Documents.Sections.ContentModified | string |
ContentModified |
|
HasTextAnnotation
|
Documents.Sections.HasTextAnnotation | boolean |
HasTextAnnotation |
|
AnnotationsPreview
|
Documents.Sections.AnnotationsPreview | boolean |
AnnotationsPreview |
|
DokumentID
|
Documents.DocumentId | integer |
DokumentID |
|
IndexFields
|
Documents.IndexFields | object |
IndexFields |
|
DocumentTitle
|
Documents.DocumentTitle | string |
DocumentTitle |
|
FileCabinetId
|
Documents.FileCabinetId | string |
FileCabinetId |
|
TotalPages
|
Documents.TotalPages | integer |
TotalPages |
|
Dateigröße
|
Documents.FileSize | integer |
Dateigröße |
|
Inhaltstyp
|
Documents.ContentType | string |
Inhaltstyp |
|
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 |
Definitionen
binär
Dies ist der grundlegende Datentyp "binary".