Freigeben über


Encodian - Word

Der Connector "Encodian - Word" bietet eine umfangreiche Sammlung von Aktionen, die die Manipulation und Erstellung von Microsoft Word-Dokumenten erleichtern, die alle gängigen Dateiformate abdecken. Dieser Verbinder ist einer von neun Verbindern, die "Encodian Flowr" bilden; eine vollständige Lösung für die End-to-End-Dokumentautomatisierung, die von über 75.000 Organisationen verwendet wird. "Encodian Flowr" treibt alles von vorlagenbasierter Dokumenterstellung bis hin zur komplexen Dokumentbearbeitung an.

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Dienstleistung Class Regions
Copilot Studio Norm Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - 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 China-Regionen
     - US Department of Defense (DoD)
Power Apps Norm Alle Power Apps-Regionen mit Ausnahme der folgenden:
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Power Automate Norm Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Kontakt
Name Encodian Support
URL https://support.encodian.com
Email support@encodian.com
Connectormetadaten
Herausgeber Encodian
Webseite https://www.encodian.com
Datenschutzrichtlinie https://support.encodian.com/hc/en-gb/articles/360010885513-Privacy-Policy
Kategorien Inhalt und Dateien; Zusammenarbeit

Encodian 'Flowr' Word für Power Automate

Der Connector "Encodian Flowr Word" bietet Unternehmensqualität und einfache Verwendung von Power Automate-Aktionen zum Erstellen, Zusammenführen, Teilen und Bearbeiten von Word-Dokumenten.

Der Word-Connector "Flowr" wird von Power Automate, Azure Logic Apps und Power Apps unterstützt.

Konto registrieren

Für die Verwendung des Word-Connectors "Encodian" ist ein Encodian-Abonnement erforderlich.

Füllen Sie das Registrierungsformular aus, um sich für eine 30-tägige Testversion zu registrieren und einen API-Schlüssel zu erhalten.

Klicken Sie hier , um eine schrittweise Anleitung zum Erstellen einer Encodian-Verbindung in Power Automate zu erhalten.

Support

Wenden Sie sich an den Encodian-Support , um Unterstützung anzufordern.

Encodian Action Documentation finden Sie hier, und Beispielflüsse finden Sie hier.

Weitere Informationen

Besuchen Sie die Encodian-Website für die Preisgestaltung des Abonnementplans.

Sobald Ihre 30-Tage-Testversion abläuft, wird Ihr Encodian-Abonnement automatisch auf die Abonnementstufe "Kostenlos" von Encodian umgestellt, es sei denn, ein kostenpflichtiger Plan wurde erworben.

Erstellen einer Verbindung

Der Connector unterstützt die folgenden Authentifizierungstypen:

Vorgabe Parameter zum Erstellen einer Verbindung. Alle Regionen Freigabefähig

Vorgabe

Anwendbar: Alle Regionen

Parameter zum Erstellen einer Verbindung.

Dies ist eine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird auch die Verbindung freigegeben. Weitere Informationen finden Sie in der Übersicht über Connectors für Canvas-Apps – Power Apps | Microsoft-Dokumente

Name Typ Description Erforderlich
API-Schlüssel securestring Abrufen eines API-Schlüssels – https://www.encodian.com/apikey/ Richtig
Region Schnur

Drosselungsgrenzwerte

Name Aufrufe Verlängerungszeitraum
API-Aufrufe pro Verbindung 100 60 Sekunden

Aktionen

Word - Optimieren

Optimieren eines Microsoft Word-Dokuments – https://support.encodian.com/hc/en-gb/articles/15275076156700

Word - Text ersetzen

Suchen und Ersetzen von Text in einem Microsoft Word-Dokument – https://support.encodian.com/hc/en-gb/articles/15949925002268

Word - Text extrahieren

Extrahieren von Text, der in der bereitgestellten Microsoft Word-Datei enthalten ist – https://support.encodian.com/hc/en-gb/articles/10583756977180

Word - Textwasserzeichen hinzufügen

Hinzufügen eines Textwasserzeichens zum angegebenen Microsoft Word-Dokument – https://support.encodian.com/hc/en-gb/articles/4411284008593

Word - Wasserzeichen entfernen

Entfernen des Wasserzeichens aus der bereitgestellten Word-Datei - https://support.encodian.com/hc/en-gb/articles/7752587767965

Word – Aktivieren von Überarbeitungen

Aktivieren von überarbeitungen Änderungen im bereitgestellten Microsoft Word-Dokument – https://support.encodian.com/hc/en-gb/articles/6695385009053

Word – Auffüllen

Auffüllen eines Microsoft Word-Dokuments (DOCX) mit den bereitgestellten JSON-Daten - https://support.encodian.com/hc/en-gb/articles/360019620578-Populate-Word-Document

Word – Dateien zusammenführen

Zusammenführen eines Arrays von Microsoft Word-Dokumenten mit einem einzelnen Microsoft Word-Dokument (DOCX) – https://support.encodian.com/hc/en-gb/articles/360023972213-Merge-document-array-to-Word

Word – Deaktivieren nachverfolgter Änderungen

Nachverfolgte Änderungen im bereitgestellten Microsoft Word-Dokument deaktivieren – https://support.encodian.com/hc/en-gb/articles/6695370804125

Word – Entfernen von Kopf- und Fußzeilen

Entfernen von Kopf- und/oder Fußzeilen aus dem bereitgestellten Microsoft Word-Dokument – https://support.encodian.com/hc/en-gb/articles/11349707504540

Word – Entsperren

Entfernen der angewendeten Sicherheit und des Schutzes aus dem bereitgestellten Microsoft Word-Dokument – https://support.encodian.com/hc/en-gb/articles/19367982647068

Word – Ersetzen von Text durch Bild

Suchen und Ersetzen von Text in einem Word-Dokument durch ein Bild - https://support.encodian.com/hc/en-gb/articles/15089626493340

Word – Extrahieren nachverfolgter Änderungen

Extrahieren aller überarbeitungen Änderungen (Überarbeitungen und Kommentare) für das bereitgestellte Microsoft Word-Dokument – https://support.encodian.com/hc/en-gb/articles/6634950400669

Word – Extrahieren von Bildern

Extrahieren von angegebenen Bildern aus der bereitgestellten Microsoft Word-Datei - https://support.encodian.com/hc/en-gb/articles/15433980042908

Word – Extrahieren von Dateien

Extrahieren von Dateien aus der bereitgestellten Microsoft Word-Datei – https://support.encodian.com/hc/en-gb/articles/22255231258524

Word – Extrahieren von Metadaten

Extrahieren von Microsoft Word-Metadaten und verwandten Informationen – https://support.encodian.com/hc/en-gb/articles/18211067662492

Word – Extrahieren von Seiten

Extrahieren der angegebenen Seiten aus der bereitgestellten Microsoft Word-Datei – https://support.encodian.com/hc/en-gb/articles/14902696561948

Word – Festlegen von Metadaten

Festlegen der Metadaten des bereitgestellten Microsoft Word-Dokuments – https://support.encodian.com/hc/en-gb/articles/15942705445788

Word – Hinzufügen eines Bildwasserzeichens

Hinzufügen eines Bildwasserzeichens zum angegebenen Microsoft Word-Dokument – https://support.encodian.com/hc/en-gb/articles/4411329161361

Word – Hinzufügen von Kopf- und Fußzeilen

Hinzufügen von HTML-Kopf- und/oder Fußzeilen zum bereitgestellten Microsoft Word-Dokument – https://support.encodian.com/hc/en-gb/articles/11348579020572

Word – Hyperlinks aktualisieren

Suchen und Aktualisieren von Links in einem Microsoft Word-Dokument – https://support.encodian.com/hc/en-gb/articles/7136687719837

Word – Inhaltsverzeichnis aktualisieren

Aktualisieren des Inhaltsverzeichnisses im bereitgestellten Microsoft Word-Dokument – https://support.encodian.com/hc/en-gb/articles/10594864447260

Word – Inhaltsverzeichnis entfernen

Entfernen des Inhaltsverzeichnisses aus dem bereitgestellten Microsoft Word-Dokument - https://support.encodian.com/hc/en-gb/articles/14544663512860

Word – Seiten löschen

Löschen angegebener Seiten aus der bereitgestellten Microsoft Word-Datei – https://support.encodian.com/hc/en-gb/articles/14903494355996

Word – Sicher

Sichern und Schützen eines Microsoft Word-Dokuments – https://support.encodian.com/hc/en-gb/articles/6634150180253

Word – Vergleichen

Unterschiede zwischen Microsoft Word-Dokumenten vergleichen – https://support.encodian.com/hc/en-gb/articles/360018576278-Compare-Word-Documents

Word – Verwalten nachverfolgter Änderungen

Nachverfolgte Änderungen innerhalb des bereitgestellten Microsoft Word-Dokuments verarbeiten - https://support.encodian.com/hc/en-gb/articles/10074318228765

Wort - Teilen

Teilen des bereitgestellten Microsoft Word-Dokuments – https://support.encodian.com/hc/en-gb/articles/14575340646940

Word - Optimieren

Optimieren eines Microsoft Word-Dokuments – https://support.encodian.com/hc/en-gb/articles/15275076156700

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dateiname
fileName True string

Der Dateiname der Microsoft Word-Quelldatei, die Dateierweiterung ist obligatorisch: 'file.docx' und nicht 'Datei'

Inhalt der Datei
fileContent True byte

Der Dateiinhalt der Microsoft Word-Quelldatei

Version
version True string

Angeben der Zu optimierenden Microsoft Word-Version

Kulturname
cultureName string

Ändern der Threadkultur, die zum Verarbeiten der Anforderung verwendet wird

Gibt zurück

Word - Text ersetzen

Suchen und Ersetzen von Text in einem Microsoft Word-Dokument – https://support.encodian.com/hc/en-gb/articles/15949925002268

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dateiname
fileName True string

Der Dateiname der Quelldatei, die Dateierweiterung ist obligatorisch: 'file.docx' und nicht 'Datei'

Inhalt der Datei
fileContent byte

Der Dateiinhalt der Quelldatei

Suchtext
searchText True string

Der Text, der durch den Wert "Ersetzungstext" gesucht und ersetzt werden soll.

Ist Ausdruck
isExpression boolean

Legen Sie fest, ob der Wert "Suchtext" als regulärer Ausdruck ausgewertet werden soll, der Standardwert ist "false".

Ersetzungstext
replacementText string

Der Wert, durch den der Text "Text durchsuchen" ersetzt werden soll

Nur ganze Wörter suchen
findWholeWordsOnly boolean

Festlegen, ob nur ganze Wörter gefunden werden sollen

Groß-/Kleinschreibung beachten
caseSensitive boolean

Legen Sie fest, ob der Wert "Suchtext" als Groß-/Kleinschreibung ausgewertet werden soll.

Schriftart
font string

Der Schriftartname, der für den "Ersetzungstext" verwendet werden soll. Wenn die Schriftart nicht festgelegt ist, erbt sie die aktuelle Schriftart, die im Dokument verwendet wird.

Schriftart - Farbe
fontColour string

Die Schriftfarbe, die für den "Ersetzungstext" verwendet werden soll, die Standardeinstellung lautet "Erben".

Schriftart – Schriftgrad
fontSize integer

Der Schriftgrad, der für den 'Ersetzungstext' verwendet werden soll. Wenn der Schriftgrad nicht festgelegt ist, erbt er den aktuellen Schriftgrad, der im Dokument verwendet wird.

Stil - Hintergrundfarbe
styleBackgroundColour string

Die Hintergrundfarbe, die für den "Ersetzungstext" verwendet werden soll, die Standardeinstellung lautet "Erben".

Formatvorlage - Fett
styleBold string

Legen Sie fest, ob der 'Ersetzungstext' auf 'Fett' festgelegt ist, der Standardwert ist 'Inherit'.

Stil - Kursiv
styleItalic string

Legen Sie fest, ob der 'Ersetzungstext' auf 'Kursiv' festgelegt ist, der Standardwert ist 'Inherit'.

Formatvorlage – Durchgestrichen
styleStrikethrough string

Legen Sie fest, ob der "Ersetzungstext" "Struck Through" lautet, der Standardwert ist "Inherit"

Formatvorlage – Doppelt durchgestrichen
styleDoubleStrikethrough string

Legen Sie fest, ob der "Ersetzungstext" "Durchgestrichen" ist, der Standardwert ist "Erben".

Formatvorlage – Tiefgestellt
styleSubscript string

Legen Sie fest, ob der "Ersetzungstext" "Tiefgestellt" ist, der Standardwert ist "Inherit"

Formatvorlage - Hochgestellt
styleSuperscript string

Legen Sie fest, ob der "Ersetzungstext" "Hochgestellt" ist, der Standardwert ist "Inherit"

Formatvorlage - Unterstrichen
styleUnderline string

Legen Sie fest, ob der Ersetzungstext "Unterstrichen" sein soll, der Standardwert ist "Inherit"

Wortabstand
wordSpacing float

Der Wortabstand, der auf den "Ersetzungstext" angewendet werden soll. Wenn "Word-Abstand" nicht festgelegt ist, erbt er den aktuellen Wortabstand, der im Dokument verwendet wird.

Kulturname
cultureName string

Ändern Sie die Threadkultur, die zum Verarbeiten der Anforderung verwendet wird.

Gibt zurück

Word - Text extrahieren

Extrahieren von Text, der in der bereitgestellten Microsoft Word-Datei enthalten ist – https://support.encodian.com/hc/en-gb/articles/10583756977180

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Inhalt der Datei
fileContent True byte

Der Dateiinhalt der Microsoft Word-Datei

Startseite
startPage integer

Legt die Seitenzahl so fest, dass die Textebenenextraktion von

Seite beenden
endPage integer

Legt die Seitenzahl auf die Endtextebenenextraktion fest. Der Standardwert wird auf die letzte Seite des bereitgestellten Microsoft Word-Dokuments festgelegt.

Kommentare entfernen
removeComments boolean

Festlegen, ob Kommentare vor dem Extrahieren von Text aus der Microsoft Word-Datei entfernt werden sollen

Änderungen annehmen
acceptChanges boolean

Festlegen, ob nachverfolgte Änderungen vor dem Extrahieren von Text aus der Microsoft Word-Datei akzeptiert werden sollen

Kopf- und Fußzeilen entfernen
removeHeadersAndFooters boolean

Festlegen, ob Kopf- und Fußzeilen aus der Microsoft Word-Datei entfernt werden sollen

Kulturname
cultureName string

Ändern der Threadkultur, die zum Verarbeiten der Anforderung verwendet wird

Gibt zurück

Word - Textwasserzeichen hinzufügen

Hinzufügen eines Textwasserzeichens zum angegebenen Microsoft Word-Dokument – https://support.encodian.com/hc/en-gb/articles/4411284008593

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dateiname
fileName True string

Der Dateiname der Microsoft Word-Quelldatei, die Dateierweiterung ist obligatorisch: 'file.docx' und nicht 'Datei'

Inhalt der Datei
fileContent True byte

Der Dateiinhalt der Microsoft Word-Quelldatei

Text
text True string

Der Text, der als Wasserzeichen in die Microsoft Word-Datei eingebettet werden soll

Ausrichtung
orientation string

Festlegen der Ausrichtung des Textwasserzeichens

Kulturname
cultureName string

Ändern der Threadkultur, die zum Verarbeiten der Anforderung verwendet wird

Schriftart
font string

Legen Sie den Schriftarttyp fest, der auf das Textwasserzeichen angewendet wird, und die Standardschriftart wird auf Calibri festgelegt.

Textfarbe
textColour string

Festlegen der HTML-Farbe, die auf das Textwasserzeichen angewendet wird, wird die Standardfarbe auf #808080 (Grau) festgelegt.

Textgröße
textSize integer

Legen Sie den Schriftgrad fest, der auf das Textwasserzeichen angewendet wird. Die Standardgröße ist auf 0 (automatisch) festgelegt.

Semi Transparent
isSemiTransparent boolean

Festlegen, ob das Textwasserzeichen halb transparent sein soll

Gibt zurück

Word - Wasserzeichen entfernen

Entfernen des Wasserzeichens aus der bereitgestellten Word-Datei - https://support.encodian.com/hc/en-gb/articles/7752587767965

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dateiname
fileName True string

Der Dateiname der Microsoft Word-Quelldatei, die Dateierweiterung ist obligatorisch: 'file.docx' und nicht 'Datei'

Inhalt der Datei
fileContent True byte

Der Dateiinhalt der Microsoft Word-Quelldatei

Kulturname
cultureName string

Ändern der Threadkultur, die zum Verarbeiten der Anforderung verwendet wird

Gibt zurück

Word – Aktivieren von Überarbeitungen

Aktivieren von überarbeitungen Änderungen im bereitgestellten Microsoft Word-Dokument – https://support.encodian.com/hc/en-gb/articles/6695385009053

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dateiname
fileName True string

Der Dateiname der Microsoft Word-Quelldatei, die Dateierweiterung ist obligatorisch: 'file.docx' und nicht 'Datei'

Inhalt der Datei
fileContent True byte

Der Dateiinhalt des Microsoft Word-Quelldokuments

Kulturname
cultureName string

Ändern Sie die Threadkultur, die zum Verarbeiten der Anforderung verwendet wird.

Gibt zurück

Word – Auffüllen

Auffüllen eines Microsoft Word-Dokuments (DOCX) mit den bereitgestellten JSON-Daten - https://support.encodian.com/hc/en-gb/articles/360019620578-Populate-Word-Document

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Inhalt der Datei
fileContent True byte

Microsoft Word-Dokument (DOCX) zum Auffüllen

Dokumentdaten
documentData True string

Die JSON-Daten zum Auffüllen des Microsoft Word-Dokuments mit

JSON-Analysemodus
jsonParseMode string

Legt den JSON-Analysemodus für einfache Werte fest (null, boolescher Wert, Zahl, ganze Zahl und Zeichenfolge)

Fehlende Werte zulassen
allowMissingMembers boolean

Legt das Modul so fest, dass fehlende Werte in den "Dokumentdaten" zulässig sind.

Inlinefehler
inlineErrorMessages boolean

Erzeugt Fehler innerhalb des resultierenden Dokuments im Gegensatz zum Ablehnen der Anforderung mit einem HTTP 4**-Fehler

Entfernen leerer Absätze
removeEmptyParagraphs boolean

Legt fest, dass das Modul bei ausführung automatisch alle leeren Absätze entfernt.

Datums-Uhrzeitformate
dateTimeFormat string

Festlegen eines oder mehrerer Spezifikationsformate für die Analyse von DateTime-Werten

Kulturname
cultureName string

Ändern der Threadkultur, die zum Verarbeiten der Anforderung verwendet wird

Zeitzone
timezone string

Festlegen einer bestimmten Zeitzone für die Datums- und Uhrzeitverarbeitung

Gibt zurück

Word – Dateien zusammenführen

Zusammenführen eines Arrays von Microsoft Word-Dokumenten mit einem einzelnen Microsoft Word-Dokument (DOCX) – https://support.encodian.com/hc/en-gb/articles/360023972213-Merge-document-array-to-Word

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dateiname
outputFilename True string

Der Dateiname des DOCX-Ausgabedokuments

Dateiname
fileName True string

Der Dateiname der Quelldatei, die Dateierweiterung ist obligatorisch: 'file.docx' und nicht 'Datei'

Inhalt der Datei
fileContent True byte

Der Dateiinhalt der Quelldatei

Sortierposition
sortPosition integer

Festlegen der Sortierposition innerhalb des Dokumentarrays

Formatmodus
wordInputFormatMode string

Legen Sie fest, wie die Formatierung behandelt wird, wenn Dokumente mit dem ersten Dokument im Array zusammengeführt werden.

Zeitzone
timezone string

Festlegen einer bestimmten Zeitzone für die Datums- und Uhrzeitverarbeitung

Complianceebene
WordComplianceLevel string

Angeben, welche OOXML-Spezifikation beim Speichern im DOCX-Format verwendet wird

Gibt zurück

Word – Deaktivieren nachverfolgter Änderungen

Nachverfolgte Änderungen im bereitgestellten Microsoft Word-Dokument deaktivieren – https://support.encodian.com/hc/en-gb/articles/6695370804125

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dateiname
fileName True string

Der Dateiname der Microsoft Word-Quelldatei, die Dateierweiterung ist obligatorisch: 'file.docx' und nicht 'Datei'

Inhalt der Datei
fileContent True byte

Der Dateiinhalt des Microsoft Word-Quelldokuments

Kulturname
cultureName string

Ändern Sie die Threadkultur, die zum Verarbeiten der Anforderung verwendet wird.

Gibt zurück

Word – Entfernen von Kopf- und Fußzeilen

Entfernen von Kopf- und/oder Fußzeilen aus dem bereitgestellten Microsoft Word-Dokument – https://support.encodian.com/hc/en-gb/articles/11349707504540

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Inhalt der Datei
fileContent True byte

Der Dateiinhalt der Microsoft Word-Quelldatei

Alle Kopfzeilen entfernen
removeAllHeaders boolean

Festlegen, dass alle Kopfzeilen entfernt werden

Alle Fußzeilen entfernen
removeAllFooters boolean

Festlegen, dass alle Fußzeilen entfernt werden

Kopfzeile – Erste Seite
removeFirstPageHeader boolean

Festlegen, dass die Kopfzeile von der ersten Seite entfernt wird

Kopfzeile – Gerade Seiten
removeEvenPageHeader boolean

Festlegen, dass die Kopfzeile von geraden Seiten entfernt wird

Kopfzeile – Ungerade Seiten
removeOddPageHeader boolean

Festlegen, dass die Kopfzeile von ungeraden Seiten entfernt wird

Fußzeile – Erste Seite
removeFirstPageFooter boolean

Festlegen, dass die Fußzeile von der ersten Seite entfernt wird

Fußzeile – Gerade Seiten
removeEvenPageFooter boolean

Festlegen, dass die Fußzeile von geraden Seiten entfernt wird

Fußzeile – Ungerade Seiten
removeOddPageFooter boolean

Festlegen, dass die Fußzeile von ungeraden Seiten entfernt wird

Gibt zurück

Word – Entsperren

Entfernen der angewendeten Sicherheit und des Schutzes aus dem bereitgestellten Microsoft Word-Dokument – https://support.encodian.com/hc/en-gb/articles/19367982647068

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dateiname
fileName True string

Der Dateiname der Microsoft Word-Quelldatei, die Dateierweiterung ist obligatorisch: 'file.docx' und nicht 'Datei'

Inhalt der Datei
fileContent True byte

Der Dateiinhalt der Microsoft Word-Quelldatei

Schutzkennwort
password string

Festlegen des Kennworts zum Schützen des Microsoft Word-Dokuments

Sicher beim Öffnen des Kennworts
secureOnOpenPassword string

Festlegen des Kennworts zum Öffnen des Microsoft Word-Dokuments

Kulturname
cultureName string

Ändern Sie die Threadkultur, die zum Verarbeiten der Anforderung verwendet wird.

Gibt zurück

Word – Ersetzen von Text durch Bild

Suchen und Ersetzen von Text in einem Word-Dokument durch ein Bild - https://support.encodian.com/hc/en-gb/articles/15089626493340

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dateiname
FileName True string

Der Dateiname der Quelldatei, die Dateierweiterung ist obligatorisch: 'file.docx' und nicht 'Datei'

Inhalt der Datei
FileContent True byte

Der Dateiinhalt der Quelldatei

Suchtext
SearchText True string

Der Text, der durch das angegebene Bild gesucht und ersetzt werden soll

Bilddateiinhalt
imageFileContent True byte

Der Inhalt der Bilddatei

Erste Seite überspringen
skipFirstPage boolean

Festlegen, ob die erste Seite beim Suchen nach dem Textfragment ignoriert werden soll

Anwenden auf
applyTo string

Festlegen, welche Seiten im Dokument nach dem Textfragment gesucht werden sollen

Seitenzahlen
pageNumbers string

Geben Sie die Seitenzahlen an, die nach dem Textfragment gesucht werden sollen, diese Eigenschaft gilt nur, wenn die Eigenschaft "Apply To" auf "Specific" festgelegt ist.

Seitenzahlen ignorieren
pageNumbersIgnore string

Geben Sie die Seitenzahlen an, die nicht nach dem Textfragment gesucht werden sollen. Diese Eigenschaft gilt nur, wenn die Eigenschaft "Apply To" auf "Specific" festgelegt ist.

Kulturname
cultureName string

Ändern der Threadkultur, die zum Verarbeiten der Anforderung verwendet wird

Gibt zurück

Word – Extrahieren nachverfolgter Änderungen

Extrahieren aller überarbeitungen Änderungen (Überarbeitungen und Kommentare) für das bereitgestellte Microsoft Word-Dokument – https://support.encodian.com/hc/en-gb/articles/6634950400669

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Inhalt der Datei
fileContent True byte

Der Dateiinhalt der Microsoft Word-Quelldatei

Kommentare einschließen
includeComments boolean

Legen Sie fest, ob Kommentare in das Ergebnis der nachverfolgten Änderungen eingeschlossen werden sollen.

Kulturname
cultureName string

Ändern der Threadkultur, die zum Verarbeiten der Anforderung verwendet wird

Gibt zurück

Word – Extrahieren von Bildern

Extrahieren von angegebenen Bildern aus der bereitgestellten Microsoft Word-Datei - https://support.encodian.com/hc/en-gb/articles/15433980042908

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Inhalt der Datei
fileContent True byte

Der Dateiinhalt der Microsoft Word-Quelldatei

Startseite
startPage integer

Festlegen der Seitenzahl, um mit dem Extrahieren von Bildern aus zu beginnen

Seite beenden
endPage integer

Legen Sie die Seitenzahl fest, um das Extrahieren von Bildern zu beenden. Der Standardwert wird auf die letzte Seite des bereitgestellten Microsoft Word-Dokuments festgelegt.

Seitenzahlen
pageNumbers string

Eine durch Trennzeichen getrennte Liste der Seitenzahlen der Seiten, aus der Bilder extrahiert werden sollen: 1,3,4

Bildindizes
imageIndexes string

Eine durch Trennzeichen getrennte Liste der zu extrahierenden Bilder: 1,3,4

Einschließen von Textkörperbildern
includeBodyImages boolean

Gibt an, ob Im Textkörper des Word-Dokuments gefundene Bilder extrahiert werden sollen.

Kopfzeilenbilder einschließen
includeHeaderImages boolean

Gibt an, ob Bilder in den Kopfzeilen des Word-Dokuments extrahiert werden sollen.

Fußzeilenbilder einschließen
includeFooterImages boolean

Gibt an, ob Bilder in den Fußzeilen des Word-Dokuments extrahiert werden sollen.

Kulturname
cultureName string

Ändern der Threadkultur, die zum Verarbeiten der Anforderung verwendet wird

Gibt zurück

Word – Extrahieren von Dateien

Extrahieren von Dateien aus der bereitgestellten Microsoft Word-Datei – https://support.encodian.com/hc/en-gb/articles/22255231258524

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Inhalt der Datei
fileContent True byte

Der Dateiinhalt der Microsoft Word-Quelldatei

Startseite
startPage integer

Legen Sie die Seitenzahl so fest, dass sie mit dem Extrahieren von Dateien beginnt, standardmäßig auf Seite 1

Seite beenden
endPage integer

Legen Sie die Seitenzahl so fest, dass das Extrahieren von Dateien beendet wird, wobei standardmäßig die letzte Seite des Dokuments angezeigt wird.

Seitenzahlen
pageNumbers string

Eine durch Trennzeichen getrennte Liste von Seitenzahlen zum Extrahieren eingebetteter Dateien aus: 1,3,4

Kulturname
cultureName string

Ändern der Threadkultur, die zum Verarbeiten der Anforderung verwendet wird

Gibt zurück

Word – Extrahieren von Metadaten

Extrahieren von Microsoft Word-Metadaten und verwandten Informationen – https://support.encodian.com/hc/en-gb/articles/18211067662492

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Inhalt der Datei
fileContent True byte

Der Dateiinhalt der Microsoft Word-Quelldatei

Kulturname
cultureName string

Ändern der Threadkultur, die zum Verarbeiten der Anforderung verwendet wird

Gibt zurück

Word – Extrahieren von Seiten

Extrahieren der angegebenen Seiten aus der bereitgestellten Microsoft Word-Datei – https://support.encodian.com/hc/en-gb/articles/14902696561948

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dateiname
fileName True string

Der Dateiname der Microsoft Word-Quelldatei, die Dateierweiterung ist obligatorisch: 'file.docx' und nicht 'Datei'

Inhalt der Datei
fileContent True byte

Der Dateiinhalt der Microsoft Word-Datei

Startseite
startPage integer

Festlegen der Seitenzahl, um mit dem Extrahieren von Seiten aus zu beginnen

Seite beenden
endPage integer

Legen Sie die Seitenzahl fest, um das Extrahieren von Seiten zu beenden. Der Standardwert wird auf die letzte Seite des bereitgestellten Microsoft Word-Dokuments festgelegt.

Seitenzahlen
pageNumbers string

Eine durch Trennzeichen getrennte Liste der zu extrahierenden Seitenzahlen: 1,3,4

Kulturname
cultureName string

Ändern der Threadkultur, die zum Verarbeiten der Anforderung verwendet wird

Gibt zurück

Word – Festlegen von Metadaten

Festlegen der Metadaten des bereitgestellten Microsoft Word-Dokuments – https://support.encodian.com/hc/en-gb/articles/15942705445788

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dateiname
fileName True string

Der Dateiname der Microsoft Word-Quelldatei, die Dateierweiterung ist obligatorisch: 'file.docx' und nicht 'Datei'

Inhalt der Datei
fileContent True byte

Der Dateiinhalt der Microsoft Word-Quelldatei

Autor
author string

Der Autor des Dokuments

Kategorie
category string

Die Kategorie des Dokuments

Kommentare
comments string

Der Wert für Dokumentkommentare

Firma
company string

Der Wert des Dokumentunternehmens

Erstellt
created string

Das Datum, an dem das Dokument erstellt wurde

Hyperlinkbasis
hyperlinkBase string

Festlegen des Basiswerts, der für die Auswertung relativer Hyperlinks innerhalb des Dokuments verwendet wird

Schlüsselwörter
keywords string

Die dem Dokument zugeordneten Schlüsselwörter

Zuletzt geändert
lastModified string

Das Datum, an dem das Dokument geändert wurde

Zuletzt geändert von
lastModifiedBy string

Der letzte Autor, der das Dokument geändert hat

Zuletzt gedruckt
lastPrinted string

Das Datum, an dem das Dokument zuletzt gedruckt wurde

Leiter
manager string

Der Vorgesetzte des Dokuments

Revisionsnummer
revisionNumber integer

Die Dokumentrevisionsnummer

Der Status
status string

Der Status des Dokuments

Betreff
subject string

Der Betreff des Dokuments

Title
title string

Der Titel des Dokuments

Gesamtbearbeitungszeit
totalEditingTime integer

Die Gesamtzeit für das Bearbeiten des Dokuments

Benutzerdefinierte Eigenschaften
customProperties string

Eine JSON-Sammlung von Keypair-Werten, die als Metadateneinträge für das bereitgestellte Dokument festgelegt werden sollen

Kulturname
cultureName string

Ändern der Threadkultur, die zum Verarbeiten der Anforderung verwendet wird

Gibt zurück

Word – Hinzufügen eines Bildwasserzeichens

Hinzufügen eines Bildwasserzeichens zum angegebenen Microsoft Word-Dokument – https://support.encodian.com/hc/en-gb/articles/4411329161361

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dateiname
fileName True string

Der Dateiname der Microsoft Word-Quelldatei, die Dateierweiterung ist obligatorisch: 'file.docx' und nicht 'Datei'

Inhalt der Datei
fileContent True byte

Der Dateiinhalt der Microsoft Word-Quelldatei

Dateiname des Wasserzeichens
watermarkFilename True string

Der Dateiname für die Wasserzeichenbilddatei, die Dateierweiterung ist obligatorisch: 'file.jpg' und nicht 'Datei'

Inhalt der Wasserzeichendatei
watermarkFileContent True byte

Der Inhalt der Wasserzeichenbilddatei

Kulturname
cultureName string

Ändern der Threadkultur, die zum Verarbeiten der Anforderung verwendet wird

Scale
scale double

Legen Sie den Skalierungsfaktor fest, der als Bruchteil des Bilds ausgedrückt wird. Der Standardwert ist 1, gültige Werte liegen zwischen 0 und 65,5.

Semi Transparent
isSemiTransparent boolean

Festlegen, ob das Textwasserzeichen halb transparent sein soll

Bild ausrichten
alignImage boolean

Stellen Sie sicher, dass das bereitgestellte Bild an den EXIF-Ausrichtungstags ausgerichtet ist.

Gibt zurück

Word – Hinzufügen von Kopf- und Fußzeilen

Hinzufügen von HTML-Kopf- und/oder Fußzeilen zum bereitgestellten Microsoft Word-Dokument – https://support.encodian.com/hc/en-gb/articles/11348579020572

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Inhalt der Datei
fileContent True byte

Der Dateiinhalt der Microsoft Word-Quelldatei

Kopfzeile – Alle Seiten
allPagesHeaderHtml string

Der HTML-Header, der allen Seiten hinzugefügt werden soll

Fußzeile – Alle Seiten
allPagesFooterHtml string

Die HTML-Fußzeile, die allen Seiten hinzugefügt werden soll

Kopfzeile – Erste Seite
firstPageHeaderHtml string

Die HTML-Kopfzeile, die der ersten Seite hinzugefügt werden soll

Kopfzeile – Gerade Seiten
evenPageHeaderHtml string

Der HTML-Header, der allen geraden Seiten hinzugefügt werden soll

Kopfzeile – Ungerade Seiten
oddPageHeaderHtml string

Der HTML-Header, der allen ungeraden Seiten hinzugefügt werden soll

Fußzeile – Erste Seite
firstPageFooterHtml string

Die HTML-Fußzeile, die der ersten Seite hinzugefügt werden soll

Fußzeile – Gerade Seiten
evenPageFooterHtml string

Die HTML-Fußzeile, die allen geraden Seiten hinzugefügt werden soll

Fußzeile – Ungerade Seiten
oddPageFooterHtml string

Die HTML-Fußzeile, die allen ungeraden Seiten hinzugefügt werden soll

Kulturname
cultureName string

Ändern der Threadkultur, die zum Verarbeiten der Anforderung verwendet wird

Gibt zurück

Suchen und Aktualisieren von Links in einem Microsoft Word-Dokument – https://support.encodian.com/hc/en-gb/articles/7136687719837

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dateiname
fileName string

Der Dateiname der Microsoft Word-Quelldatei, die Dateierweiterung ist obligatorisch: 'file.docx' und nicht 'Datei'

Inhalt der Datei
fileContent True byte

Der Dateiinhalt der Quelldatei

Suchen nach
searchOn True string

Legen Sie fest, ob die Suche für den Linktext oder den URL-Wert ausgeführt werden soll.

Suchwert
searchValue True string

Der linktext oder der URL-Wert, nach dem gesucht werden soll

Ist Ausdruck
isExpression boolean

Legen Sie fest, ob der Wert "Suchwert" als regulärer Ausdruck ausgewertet werden soll, der Standardwert ist "false".

Aktueller Textwert
hyperlinkLabelValueCurrent string

Der zu ersetzende Textwert, lassen Sie leer, um den gesamten Wert zu ersetzen.

Neuer Textwert
hyperlinkLabelValueNew string

Der neue festzulegende Wert

AKTUELLER URL-Wert
hyperlinkUrlValueCurrent string

Der zu ersetzende URL-Wert, lassen Sie leer, um den gesamten Wert zu ersetzen.

NEUER URL-Wert
hyperlinkUrlValueNew string

Der festzulegende neue URL-Wert

Kulturname
cultureName string

Ändern Sie die Threadkultur, die zum Verarbeiten der Anforderung verwendet wird.

Gibt zurück

Word – Inhaltsverzeichnis aktualisieren

Aktualisieren des Inhaltsverzeichnisses im bereitgestellten Microsoft Word-Dokument – https://support.encodian.com/hc/en-gb/articles/10594864447260

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dateiname
fileName True string

Der Dateiname der Microsoft Word-Quelldatei, die Dateierweiterung ist obligatorisch: 'file.docx' und nicht 'Datei'

Inhalt der Datei
fileContent True byte

Der Dateiinhalt der Microsoft Word-Quelldatei

Zeitzone
timezone string

Festlegen einer bestimmten Zeitzone für die Datums- und Uhrzeitverarbeitung

Kulturname
cultureName string

Ändern der Threadkultur, die zum Verarbeiten der Anforderung verwendet wird

Gibt zurück

Word – Inhaltsverzeichnis entfernen

Entfernen des Inhaltsverzeichnisses aus dem bereitgestellten Microsoft Word-Dokument - https://support.encodian.com/hc/en-gb/articles/14544663512860

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dateiname
fileName True string

Der Dateiname der Microsoft Word-Quelldatei, die Dateierweiterung ist obligatorisch: 'file.docx' und nicht 'Datei'

Inhalt der Datei
fileContent True byte

Der Dateiinhalt der Microsoft Word-Quelldatei

Kulturname
cultureName string

Ändern der Threadkultur, die zum Verarbeiten der Anforderung verwendet wird

Inhaltsverzeichnisindizes
tableOfContentsIndexes string

Festlegen der Indexnummer(en) der zu entfernenden Inhaltsverzeichnisse

Gibt zurück

Word – Seiten löschen

Löschen angegebener Seiten aus der bereitgestellten Microsoft Word-Datei – https://support.encodian.com/hc/en-gb/articles/14903494355996

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dateiname
fileName True string

Der Dateiname der Microsoft Word-Quelldatei, die Dateierweiterung ist obligatorisch: 'file.docx' und nicht 'Datei'

Inhalt der Datei
fileContent True byte

Der Dateiinhalt der Microsoft Word-Datei

Startseite
startPage integer

Festlegen der Seitenzahl, um mit dem Löschen von Seiten zu beginnen

Seite beenden
endPage integer

Legen Sie die Seitenzahl so fest, dass das Löschen von Seiten beendet wird. Der Standardwert wird auf die letzte Seite des bereitgestellten Microsoft Word-Dokuments festgelegt.

Seitenzahlen
pageNumbers string

Eine durch Trennzeichen getrennte Liste der zu löschenden Seitenzahlen: 1,3,4

Kulturname
cultureName string

Ändern der Threadkultur, die zum Verarbeiten der Anforderung verwendet wird

Gibt zurück

Word – Sicher

Sichern und Schützen eines Microsoft Word-Dokuments – https://support.encodian.com/hc/en-gb/articles/6634150180253

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dateiname
fileName True string

Der Dateiname der Microsoft Word-Quelldatei, die Dateierweiterung ist obligatorisch: 'file.docx' und nicht 'Datei'

Inhalt der Datei
fileContent True byte

Der Dateiinhalt der Microsoft Word-Quelldatei

Schutztyp
wordProtectionType string

Festlegen des Schutztyps für das Microsoft Word-Dokument

Schutzkennwort
password string

Festlegen des Kennworts zum Schützen des Microsoft Word-Dokuments

Sicher beim Öffnen
secureOnOpen boolean

Festlegen, ob ein Kennwort zum Öffnen des Microsoft Word-Dokuments erforderlich sein soll

Sicher beim Öffnen des Kennworts
secureOnOpenPassword string

Festlegen des Kennworts zum Öffnen des Microsoft Word-Dokuments

Kulturname
cultureName string

Ändern Sie die Threadkultur, die zum Verarbeiten der Anforderung verwendet wird.

Gibt zurück

Word – Vergleichen

Unterschiede zwischen Microsoft Word-Dokumenten vergleichen – https://support.encodian.com/hc/en-gb/articles/360018576278-Compare-Word-Documents

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dateiinhalt - eins
fileContentOne True byte

Der Dateiinhalt der ersten zu vergleichenden Microsoft Word- oder PDF-Datei.

Dateiinhalt - zwei
fileContentTwo True byte

Der Dateiinhalt der zweiten zu vergleichenden Microsoft Word- oder PDF-Datei.

Autor
author string

Legen Sie den Namen des Autors fest, der zum Kennzeichnen von Unterschieden im Ausgabedokument verwendet wird.

Formatierung ignorieren
ignoreFormatting boolean

Gibt an, ob Unterschiede bei der Dokumentformatierung ignoriert werden sollen.

Schreibungsunabhängig
caseInsensitive boolean

Gibt an, ob Unterschiede in Dokumenten verglichen werden sollen, wenn die Groß-/Kleinschreibung nicht beachtet wird.

Kommentare ignorieren
ignoreComments boolean

Gibt an, ob Unterschiede in Kommentaren verglichen werden sollen.

Tabellen ignorieren
ignoreTables boolean

Gibt an, ob die Unterschiede in daten in Tabellen verglichen werden sollen.

Felder ignorieren
ignoreFields boolean

Gibt an, ob Unterschiede in Feldern verglichen werden sollen. Standardmäßige Felder

Fußnoten ignorieren
ignoreFootnotes boolean

Gibt an, ob Unterschiede in Fuß- und Endnoten verglichen werden sollen.

Textfelder ignorieren
ignoreTextboxes boolean

Gibt an, ob Unterschiede in den in Textfeldern enthaltenen Daten verglichen werden sollen.

Kopf- und Fußzeilen ignorieren
ignoreHeadersAndFooters boolean

Gibt an, ob Unterschiede in den Daten in Kopf- und Fußzeilen verglichen werden sollen.

Gibt zurück

Word – Verwalten nachverfolgter Änderungen

Nachverfolgte Änderungen innerhalb des bereitgestellten Microsoft Word-Dokuments verarbeiten - https://support.encodian.com/hc/en-gb/articles/10074318228765

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dateiname
FileName True string

Der Dateiname der Microsoft Word-Quelldatei, die Dateierweiterung ist obligatorisch: 'file.docx' und nicht 'Datei'

Inhalt der Datei
FileContent True byte

Der Dateiinhalt der Microsoft Word-Quelldatei

Einfügen annehmen
acceptInsertions string

Festlegen, ob Einfügungen akzeptiert oder abgelehnt werden sollen

Löschungen annehmen
acceptDeletions string

Festlegen, ob Löschvorgänge akzeptiert oder abgelehnt werden sollen

Formatänderungen annehmen
acceptFormatChanges string

Festlegen, ob Formatänderungen akzeptiert oder abgelehnt werden sollen

Bewegungen annehmen
acceptMovements string

Festlegen, ob Inhaltsverschiebungen akzeptiert oder abgelehnt werden sollen

Kommentare entfernen
removeComments boolean

Festlegen, ob Kommentare entfernt werden sollen

Kulturname
cultureName string

Ändern der Threadkultur, die zum Verarbeiten der Anforderung verwendet wird

Gibt zurück

Wort - Teilen

Teilen des bereitgestellten Microsoft Word-Dokuments – https://support.encodian.com/hc/en-gb/articles/14575340646940

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dateiname
fileName True string

Der Dateiname der Microsoft Word-Quelldatei, die Dateierweiterung ist obligatorisch: 'file.docx' und nicht 'Datei'

Inhalt der Datei
fileContent True byte

Der Dateiinhalt der Microsoft Word-Datei

Geteilter Typ
splitType True string

Auswählen, wie die Datei geteilt werden soll

Geteilte Konfiguration
splitConfiguration string

Bereitstellen einer geteilten Konfiguration

Kulturname
cultureName string

Ändern der Threadkultur, die zum Verarbeiten der Anforderung verwendet wird

Gibt zurück

Definitionen

DocumentArray

Name Pfad Typ Beschreibung
Dateiname
fileName string

Der Dateiname der Datei

Inhalt der Datei
fileContent byte

Der Dateiinhalt der Datei

DtoResponseAddHtmlHeaderFooterWord

Name Pfad Typ Beschreibung
HTTP-Statuscode
HttpStatusCode integer

Der HTTP-Statuscode für die Antwort.

HTTP-Statusmeldung
HttpStatusMessage string

Die HTTP-Statusmeldung für die Antwort.

Betriebs-ID
OperationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist.

Errors
Errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten.

Vorgangsstatus
OperationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

Inhalt der Datei
FileContent byte

Das verarbeitete Dokument.

DtoResponseAddImageWatermarkWord

Name Pfad Typ Beschreibung
HTTP-Statuscode
HttpStatusCode integer

Der HTTP-Statuscode für die Antwort.

HTTP-Statusmeldung
HttpStatusMessage string

Die HTTP-Statusmeldung für die Antwort.

Betriebs-ID
OperationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist.

Errors
Errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten.

Vorgangsstatus
OperationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

Dateiname
Filename string

Der Dateiname des Dokuments.

Inhalt der Datei
FileContent byte

Das verarbeitete Dokument.

DtoResponseAddTextWatermarkWord

Name Pfad Typ Beschreibung
HTTP-Statuscode
HttpStatusCode integer

Der HTTP-Statuscode für die Antwort.

HTTP-Statusmeldung
HttpStatusMessage string

Die HTTP-Statusmeldung für die Antwort.

Betriebs-ID
OperationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist.

Errors
Errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten.

Vorgangsstatus
OperationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

Dateiname
Filename string

Der Dateiname des Dokuments.

Inhalt der Datei
FileContent byte

Das verarbeitete Dokument.

DtoResponseCompareWordDocuments

Name Pfad Typ Beschreibung
HTTP-Statuscode
HttpStatusCode integer

Der HTTP-Statuscode für die Antwort.

HTTP-Statusmeldung
HttpStatusMessage string

Die HTTP-Statusmeldung für die Antwort.

Betriebs-ID
OperationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist.

Errors
Errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten.

Vorgangsstatus
OperationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

Dateiname
Filename string

Der Dateiname des Dokuments.

Inhalt der Datei
FileContent byte

Das verarbeitete Dokument.

DtoResponseDeleteWordPages

Name Pfad Typ Beschreibung
HTTP-Statuscode
HttpStatusCode integer

Der HTTP-Statuscode für die Antwort.

HTTP-Statusmeldung
HttpStatusMessage string

Die HTTP-Statusmeldung für die Antwort.

Betriebs-ID
OperationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist.

Errors
Errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten.

Vorgangsstatus
OperationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

Dateiname
Filename string

Der Dateiname des Dokuments.

Inhalt der Datei
FileContent byte

Das verarbeitete Dokument.

DtoResponseDisableTrackedChanges

Name Pfad Typ Beschreibung
HTTP-Statuscode
HttpStatusCode integer

Der HTTP-Statuscode für die Antwort.

HTTP-Statusmeldung
HttpStatusMessage string

Die HTTP-Statusmeldung für die Antwort.

Betriebs-ID
OperationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist.

Errors
Errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten.

Vorgangsstatus
OperationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

Dateiname
Filename string

Der Dateiname des Dokuments.

Inhalt der Datei
FileContent byte

Das verarbeitete Dokument.

DtoResponseEnableTrackedChanges

Name Pfad Typ Beschreibung
HTTP-Statuscode
HttpStatusCode integer

Der HTTP-Statuscode für die Antwort.

HTTP-Statusmeldung
HttpStatusMessage string

Die HTTP-Statusmeldung für die Antwort.

Betriebs-ID
OperationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist.

Errors
Errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten.

Vorgangsstatus
OperationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

Dateiname
Filename string

Der Dateiname des Dokuments.

Inhalt der Datei
FileContent byte

Das verarbeitete Dokument.

DtoResponseExtractWordPages

Name Pfad Typ Beschreibung
HTTP-Statuscode
HttpStatusCode integer

Der HTTP-Statuscode für die Antwort.

HTTP-Statusmeldung
HttpStatusMessage string

Die HTTP-Statusmeldung für die Antwort.

Betriebs-ID
OperationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist.

Errors
Errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten.

Vorgangsstatus
OperationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

Dateiname
Filename string

Der Dateiname des Dokuments.

Inhalt der Datei
FileContent byte

Das verarbeitete Dokument.

DtoResponseGetTextFromWord

Name Pfad Typ Beschreibung
Text
text string

Der aus dem bereitgestellten Wortdokument extrahierte Text

HTTP-Statuscode
HttpStatusCode integer

Der HTTP-Statuscode für die Antwort.

HTTP-Statusmeldung
HttpStatusMessage string

Die HTTP-Statusmeldung für die Antwort.

Betriebs-ID
OperationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist.

Errors
Errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten.

Vorgangsstatus
OperationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

DtoResponseGetTrackedChanges

Name Pfad Typ Beschreibung
JSON – Nachverfolgte Änderungen
trackedChangesJson string

Eine JSON-formatierte Zeichenfolge mit Überarbeitungsdetails

JSON – Kommentare
commentsJson string

Eine JSON-formatierte Zeichenfolge mit Kommentaren

HTTP-Statuscode
HttpStatusCode integer

Der HTTP-Statuscode für die Antwort.

HTTP-Statusmeldung
HttpStatusMessage string

Die HTTP-Statusmeldung für die Antwort.

Betriebs-ID
OperationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist.

Errors
Errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten.

Vorgangsstatus
OperationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

DtoResponseManageTrackedChanges

Name Pfad Typ Beschreibung
HTTP-Statuscode
HttpStatusCode integer

Der HTTP-Statuscode für die Antwort.

HTTP-Statusmeldung
HttpStatusMessage string

Die HTTP-Statusmeldung für die Antwort.

Betriebs-ID
OperationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist.

Errors
Errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten.

Vorgangsstatus
OperationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

Dateiname
Filename string

Der Dateiname des Dokuments.

Inhalt der Datei
FileContent byte

Das verarbeitete Dokument.

DtoResponseMergeArrayOfDocumentsToWord

Name Pfad Typ Beschreibung
HTTP-Statuscode
HttpStatusCode integer

Der HTTP-Statuscode für die Antwort.

HTTP-Statusmeldung
HttpStatusMessage string

Die HTTP-Statusmeldung für die Antwort.

Betriebs-ID
OperationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist.

Errors
Errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten.

Vorgangsstatus
OperationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

Dateiname
Filename string

Der Dateiname des Dokuments.

Inhalt der Datei
FileContent byte

Das verarbeitete Dokument.

DtoResponseOptimiseWordDocument

Name Pfad Typ Beschreibung
HTTP-Statuscode
HttpStatusCode integer

Der HTTP-Statuscode für die Antwort.

HTTP-Statusmeldung
HttpStatusMessage string

Die HTTP-Statusmeldung für die Antwort.

Betriebs-ID
OperationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist.

Errors
Errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten.

Vorgangsstatus
OperationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

Dateiname
Filename string

Der Dateiname des Dokuments.

Inhalt der Datei
FileContent byte

Das verarbeitete Dokument.

DtoResponsePopulateWordDocument

Name Pfad Typ Beschreibung
HTTP-Statuscode
HttpStatusCode integer

Der HTTP-Statuscode für die Antwort.

HTTP-Statusmeldung
HttpStatusMessage string

Die HTTP-Statusmeldung für die Antwort.

Betriebs-ID
OperationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist.

Errors
Errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten.

Vorgangsstatus
OperationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

Dateiname
Filename string

Der Dateiname des Dokuments.

Inhalt der Datei
FileContent byte

Das verarbeitete Dokument.

DtoResponseRemoveHeaderFooterWord

Name Pfad Typ Beschreibung
HTTP-Statuscode
HttpStatusCode integer

Der HTTP-Statuscode für die Antwort.

HTTP-Statusmeldung
HttpStatusMessage string

Die HTTP-Statusmeldung für die Antwort.

Betriebs-ID
OperationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist.

Errors
Errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten.

Vorgangsstatus
OperationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

Inhalt der Datei
FileContent byte

Das verarbeitete Dokument.

DtoResponseRemoveWatermarksFromWord

Name Pfad Typ Beschreibung
HTTP-Statuscode
HttpStatusCode integer

Der HTTP-Statuscode für die Antwort.

HTTP-Statusmeldung
HttpStatusMessage string

Die HTTP-Statusmeldung für die Antwort.

Betriebs-ID
OperationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist.

Errors
Errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten.

Vorgangsstatus
OperationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

Dateiname
Filename string

Der Dateiname des Dokuments.

Inhalt der Datei
FileContent byte

Das verarbeitete Dokument.

DtoResponseRemoveWordTableOfContents

Name Pfad Typ Beschreibung
HTTP-Statuscode
HttpStatusCode integer

Der HTTP-Statuscode für die Antwort.

HTTP-Statusmeldung
HttpStatusMessage string

Die HTTP-Statusmeldung für die Antwort.

Betriebs-ID
OperationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist.

Errors
Errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten.

Vorgangsstatus
OperationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

Dateiname
Filename string

Der Dateiname des Dokuments.

Inhalt der Datei
FileContent byte

Das verarbeitete Dokument.

Name Pfad Typ Beschreibung
HTTP-Statuscode
HttpStatusCode integer

Der HTTP-Statuscode für die Antwort.

HTTP-Statusmeldung
HttpStatusMessage string

Die HTTP-Statusmeldung für die Antwort.

Betriebs-ID
OperationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist.

Errors
Errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten.

Vorgangsstatus
OperationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

Dateiname
Filename string

Der Dateiname des Dokuments.

Inhalt der Datei
FileContent byte

Das verarbeitete Dokument.

DtoResponseSecureWordDocument

Name Pfad Typ Beschreibung
HTTP-Statuscode
HttpStatusCode integer

Der HTTP-Statuscode für die Antwort.

HTTP-Statusmeldung
HttpStatusMessage string

Die HTTP-Statusmeldung für die Antwort.

Betriebs-ID
OperationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist.

Errors
Errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten.

Vorgangsstatus
OperationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

Dateiname
Filename string

Der Dateiname des Dokuments.

Inhalt der Datei
FileContent byte

Das verarbeitete Dokument.

DtoResponseSplitWordDocument

Name Pfad Typ Beschreibung
Dokumente
documents array of DocumentArray

Das Array der zu verarbeitenden Dokumente

HTTP-Statuscode
HttpStatusCode integer

Der HTTP-Statuscode für die Antwort.

HTTP-Statusmeldung
HttpStatusMessage string

Die HTTP-Statusmeldung für die Antwort.

Betriebs-ID
OperationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist.

Errors
Errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten.

Vorgangsstatus
OperationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

DtoResponseUpdateWordTableOfContents

Name Pfad Typ Beschreibung
HTTP-Statuscode
HttpStatusCode integer

Der HTTP-Statuscode für die Antwort.

HTTP-Statusmeldung
HttpStatusMessage string

Die HTTP-Statusmeldung für die Antwort.

Betriebs-ID
OperationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist.

Errors
Errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten.

Vorgangsstatus
OperationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

Dateiname
Filename string

Der Dateiname des Dokuments.

Inhalt der Datei
FileContent byte

Das verarbeitete Dokument.

DtoResponseWordExtractFiles

Name Pfad Typ Beschreibung
Dokumente
documents array of DocumentArray

Das Array von Dateien, die aus dem Word-Dokument extrahiert wurden

HTTP-Statuscode
HttpStatusCode integer

Der HTTP-Statuscode für die Antwort.

HTTP-Statusmeldung
HttpStatusMessage string

Die HTTP-Statusmeldung für die Antwort.

Betriebs-ID
OperationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist.

Errors
Errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten.

Vorgangsstatus
OperationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

DtoResponseWordExtractImages

Name Pfad Typ Beschreibung
Bilder
Images array of DocumentArray

Das Array von Bildern, die aus dem Word-Dokument extrahiert wurden

HTTP-Statuscode
HttpStatusCode integer

Der HTTP-Statuscode für die Antwort.

HTTP-Statusmeldung
HttpStatusMessage string

Die HTTP-Statusmeldung für die Antwort.

Betriebs-ID
OperationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist.

Errors
Errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten.

Vorgangsstatus
OperationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

DtoResponseWordExtractMetadata

Name Pfad Typ Beschreibung
Autor
author string

Der Autor des Dokuments

Kategorie
category string

Die Kategorie des Dokuments

Zeichen
characters integer

Eine Schätzung der Gesamtzahl der Zeichen, die im Dokument vorhanden sind

Zeichen – einschließlich Leerzeichen
charactersWithSpaces integer

Eine Schätzung der Gesamtzahl der Zeichen (einschließlich Leerzeichen), die im Dokument vorhanden sind

Kommentare
comments string

Der Wert für Dokumentkommentare

Firma
company string

Der Wert des Dokumentunternehmens

Inhaltstyp
contentType string

Der MIME-Typ des Dokuments

Erstellt
created date-time

Das Datum, an dem das Dokument erstellt wurde

Benutzerdefinierte Eigenschaften
customProperties string

Alle benutzerdefinierten Eigenschaften, die im Word-Dokument als JSON-Array von Schlüssel-Wert-Paaren vorhanden sind

Dateigröße (MBs)
fileSize string

Die Größe der bereitgestellten Datei in MBs

Schlüsselwörter
keywords string

Die dem Dokument zugeordneten Schlüsselwörter

Zuletzt geändert
lastModified date-time

Das Datum, an dem das Dokument zuletzt geändert wurde

Zuletzt geändert von
lastModifiedBy string

Der letzte Autor, der das Dokument geändert hat

Zuletzt gedruckt
lastPrinted date-time

Das Datum, an dem das Dokument zuletzt gedruckt wurde

Positionen
lines integer

Eine Schätzung der Gesamtanzahl der Zeilen, die im Dokument vorhanden sind

Leiter
manager string

Der Vorgesetzte des Dokuments

Seiten
pages integer

Eine Schätzung der Gesamtzahl der Seiten, die im Dokument vorhanden sind

Paragraphs
paragraphs integer

Eine Schätzung der Gesamtzahl der Absätze, die im Dokument vorhanden sind

Revisionsnummer
revisionNumber integer

Die Dokumentrevisionsnummer

Der Status
status string

Der Status des Dokuments

Betreff
subject string

Der Betreff des Dokuments

Template
template string

Der Name der Vorlage, die auf das Dokument angewendet wurde

Title
title string

Der Titel des Dokuments

Gesamtbearbeitungszeit
totalEditingTime integer

Die Gesamtzeit für das Bearbeiten des Dokuments

Wörter
words integer

Eine Schätzung der Gesamtzahl der im Dokument vorhandenen Wörter

HTTP-Statuscode
HttpStatusCode integer

Der HTTP-Statuscode für die Antwort.

HTTP-Statusmeldung
HttpStatusMessage string

Die HTTP-Statusmeldung für die Antwort.

Betriebs-ID
OperationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist.

Errors
Errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten.

Vorgangsstatus
OperationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

DtoResponseWordReplaceTextWithImage

Name Pfad Typ Beschreibung
HTTP-Statuscode
HttpStatusCode integer

Der HTTP-Statuscode für die Antwort.

HTTP-Statusmeldung
HttpStatusMessage string

Die HTTP-Statusmeldung für die Antwort.

Betriebs-ID
OperationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist.

Errors
Errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten.

Vorgangsstatus
OperationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

Dateiname
Filename string

Der Dateiname des Dokuments.

Inhalt der Datei
FileContent byte

Das verarbeitete Dokument.

DtoResponseWordSearchAndReplaceText

Name Pfad Typ Beschreibung
HTTP-Statuscode
HttpStatusCode integer

Der HTTP-Statuscode für die Antwort.

HTTP-Statusmeldung
HttpStatusMessage string

Die HTTP-Statusmeldung für die Antwort.

Betriebs-ID
OperationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist.

Errors
Errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten.

Vorgangsstatus
OperationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

Dateiname
Filename string

Der Dateiname des Dokuments.

Inhalt der Datei
FileContent byte

Das verarbeitete Dokument.

DtoResponseWordSetMetadata

Name Pfad Typ Beschreibung
HTTP-Statuscode
HttpStatusCode integer

Der HTTP-Statuscode für die Antwort.

HTTP-Statusmeldung
HttpStatusMessage string

Die HTTP-Statusmeldung für die Antwort.

Betriebs-ID
OperationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist.

Errors
Errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten.

Vorgangsstatus
OperationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

Dateiname
Filename string

Der Dateiname des Dokuments.

Inhalt der Datei
FileContent byte

Das verarbeitete Dokument.

DtoResponseWordUnlock

Name Pfad Typ Beschreibung
HTTP-Statuscode
HttpStatusCode integer

Der HTTP-Statuscode für die Antwort.

HTTP-Statusmeldung
HttpStatusMessage string

Die HTTP-Statusmeldung für die Antwort.

Betriebs-ID
OperationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist.

Errors
Errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten.

Vorgangsstatus
OperationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

Dateiname
Filename string

Der Dateiname des Dokuments.

Inhalt der Datei
FileContent byte

Das verarbeitete Dokument.