Service-Methoden und Parameter mit DocuSign

Parametername

Variablentyp im Workflow

Obligatorisch/optional

Beschreibung

Werte

AccessCode (string)

Text

Obligatorisch für RecipientAuthenticationType = Access Code

Erforderlich, wenn der Authentifizierungstyp "AccessCode" ist. Dabei handelt es sich um den Zugangscode (ähnlich einem Kennwort), der für die Unterzeichnung des Dokuments erforderlich ist. Der Zugriffscode muss dem Unterzeichner in einem separaten Kommunikationskanal (z. B. per Telefon oder E-Mail) mitgeteilt werden.

AnchorText (string)

Text

Obligatorisch

Nach diesem Text wird auf dem Dokument gesucht, um die Signatur zu platzieren. Wird der Ankertext nicht gefunden, erfolgt eine Fehlermeldung. Wenn hier kein Ankertext angegeben ist, werden die nachfolgenden Ortsangaben absolut und nicht relativ zum Finden eines Textes verwendet.

AnchorTextOccurrence (int)

Integer

Obligatorisch

Wenn der Ankertext mehrfach im Text vorkommt, legt dieser Parameter fest, bei welcher Textstelle die Signatur platziert wird.

• 0 oder 1 = erste Stelle

• -1 = letzte Stelle

• andere Ziffern = weitere Stellen

DateSignedAnchorText (string)

String

Optional

Text, nach dem der Dienst auf dem Dokument suchen kann. Wenn er angegeben und nicht gefunden wird, tritt ein Fehler auf. Wenn nicht angegeben, sind die nachfolgenden Positionsinformationen absolut und nicht relativ, um ein Textstück zu finden.

DateSignedAnchorTextOccurrence (int)

Integer

Optional

Legt fest, welche Stelle mit dem Ankertext als Startpunkt für die Platzierung des Datums verwendet werden soll

• 0 oder 1 = erste Stelle

• -1 = letzte Stelle

• andere Ziffern = weitere Stellen

DateSignedFieldName (string)

Text

Obligatorisch

Name des Datumsfelds, in das das Datum der Signatur eingetragen wird. Es kann ein Text-, Datums- oder Datetime-Feld sein. Das Datum wird in UTC angegeben. Handelt es sich um ein Textfeld, wird das Datum in UTC angezeigt. Handelt es sich um ein Datums- oder Datum/Uhrzeit-Feld, zeigt DocuWare das Datum im lokalen Format und in der lokalen Zeitzone an.

DateSignedPageNumber (int)

Integer

Optional

Seitennummer innerhalb der Datei, um mit der Suche nach dem Ankertext zu beginnen. -1 bedeutet, dass auf der letzten Seite gesucht werden soll. Wenn kein Ankertext angegeben wird, ist die absolute Seitennummer gemeint.

DateSignedPositionX (int)

Integer

Optional

Bezogen auf die linke Seite des Ankertextes ist dies die horizontale Position, an der der mit einem Datum unterzeichnete Text auf dem Dokument platziert werden soll (Millimeter). Positive Zahlen sind nach rechts gerichtet, negative Zahlen nach links.

DateSignedPositionY (int)

Integer

Optional

Bezogen auf den oberen Rand des Ankertextes ist dies die vertikale Position des mit einem Datum unterzeichneten Textes, der auf dem Dokument platziert werden soll (Millimeter). Positive Zahlen sind nach unten gerichtet, negative Zahlen nach oben.

DaysBeforeExpiration (int)

Integer

Obligatorisch

Wenn der angegebene Wert größer als 0 ist, gilt eine Frist von dieser Anzahl von Tagen, bevor das Dokument abläuft. Wird die Frist überschritten, wird das Dokument als abgelehnt betrachtet. Es wird aus dem DocuSign-Dienst gelöscht und der Unterzeichner kann es nicht mehr signieren.

DocId (int)

Integer

Obligatorisch

ID vom zu unterzeichnenden Dokument

EmailMessage (string)

Text

Obligatorisch

Text, der im Inhalt der E-Mail angezeigt wird

EmailSubject (string)

Text

Obligatorisch

Betreff der E-Mail

FailureStatusValue (string)

Text

Obligatorisch

Wert im Indexfeld, wenn die Signatur für ein Dokument in DocuSign abgelehnt wird

FileCabinetId (string)

Text

Obligatorisch

GUID vom Archiv mit dem zu signierenden Dokument

IncludeDateSigned (boolean)

String

Optional

Optional, aber wenn der Parameter "true" ist, wird das Unterschriftsdatum in das Dokument aufgenommen und die unten aufgeführten Parameter zum Auffinden des Unterschriftsdatums werden benötigt.

• True

• false

IncludeReport (boolean)

String

Optional

Wenn Sie den Wert auf „true" setzen, wird nach dem signierten Dokument ein zweites PDF an das Dokument angehängt. Dieses PDF enthält Informationen über den Unterzeichner und das digitale Zertifikat, das dem Dokument hinzugefügt wurde.

• True

• False

PageNumber (int)

Integer

Obligatorisch

Seitennummer im Dokument, ab der nach dem Ankertext gesucht werden soll. -1 zeigt an, dass auf der letzten Seite gesucht werden soll. Wenn kein Ankertext angegeben wird, ist dieser Parameter die absolute Seitenzahl.

PhoneNumber (string)

String

Obligatorisch

Telefonnummer für die Zwei-Faktor-Authentifizierung (internationales Nummernformat, z.B. +18455639045)

PositionX (int)

Integer

Obligatorisch

Bezogen auf die linke Seite des Ankertextes ist dies die horizontale Position der Signatur, die auf dem Dokument platziert werden soll (Millimeter). Positive Zahlen sind nach rechts gerichtet. Negative Zahlen sind nach links gerichtet.

PositionY (int)

Integer

Obligatorisch

Bezogen auf den oberen Rand des Ankertextes ist dies die vertikale Position der Signatur, die auf dem Dokument platziert werden soll (Millimeter). Positive Zahlen sind unten. Negative Zahlen sind oben.

PostSigningAction (string)

Text

Obligatorisch

Gibt an, wie ein signiertes Dokument im Archiv abgelegt wird.

• ClipBefore

• ClipAfter

• Replace

RecipientAuthenticationType (string)

Text

Spezifiziert im Workflow, welche Authentifizierung in DocuSign erforderlich ist

• None

• AccessCode

• Phone

• SMS

• KBA

RecipientMayProvideNumber (Boolean)

Text

Obligatorisch für RecipientAuthenticationType = Phone or SMS

Nur für die Authentifizerung per Telefon. Mit „true" werden alle vom Benutzer gesetzten Werte ignoriert. Erst beim Signieren kann der Unterzeichner eine Telefonnummer eingeben, unter der ihm der Zugangscode mitgeteilt wird.

• True

• False

RejectionReasonFieldName (string)

Text

Optional

Spezifiert ein Indexfeld des Typs "Text" vom zu unterzeichnenden Dokument. Wenn DocuSign so konfiguriert ist, dass eine Begründung für die Ablehnung erforderlich ist, wird diese hier eingetragen.

Report Language (string)

Text

Obligatorisch für IncludeReport = True

Optional, kann nur angegeben werden, wenn IncludeReport auf "true" gesetzt ist. Er stellt sicher, dass der generierte Bericht, der an die signierte Datei angehängt wird, in der gewünschten Sprache vorliegt.

• de, en. es, fr, it, ja, ko, nl, pt, pt_BR, ru, zh_CH,zh_TW

SectionNumber (int)

Integer

Obligatorisch

Der Parameter bezieht sich auf geklammerte Dokumente. Die Indexzahl gibt an, welches der geklammerten Dokumente im Stapel unterzeichnet werden soll.

• 0 oder 1 = erstes Dokument im Stapel

• -1 = letztes Dokument

• Andere Ziffern wie 2,3 etc.geben die jeweiligen Dokumente im Stapel an.

SignerEmail (string)

Text

Obligatorisch

E-Mail-Adresse des unterzeichnenden Benutzers

SignerName (string)

Text

Obligatorisch

Name des unterzeichnenden Benutzers

StatusFieldName (string)

Text

Obligatorisch

Legt ein Indexfeld vom Dokument fest, dessen Wert verändert wird, wenn das Dokument unterzeichnet oder abgelehnt ist.

SuccessStatusValue (string)

Text

Obligatorisch

Wert, der beim Signieren eines Dokuments in das entsprechende Indexfeld gesetzt wird

Token (string)

Text

Obligatorisch

Token wird bei der Registrierung des Signature Service erstellt und per Mail zugeschickt. Es identifiziert die Kundenorganisation und stellt die Logindaten des Benutzers bereit.

Parametername

Variablentyp im Workflow

Obligatorisch/
optional

Beschreibung

Werte

AccessCode (string)

Text

Obligatorisch für RecipientAuthenticationType = Access Code

Erforderlich, wenn der Authentifizierungstyp "AccessCode" ist. Dabei handelt es sich um den Zugangscode (ähnlich einem Kennwort), der für die Unterzeichnung des Dokuments erforderlich ist. Der Zugriffscode muss dem Unterzeichner in einem separaten Kommunikationskanal (z. B. per Telefon oder E-Mail) mitgeteilt werden.

DateSignedFieldName (string)

Text

Obligatorisch

Name des Datumsfelds, in das das Datum der Signatur eingetragen wird. Es kann ein Text-, Datums- oder Datetime-Feld sein. Das Datum wird in UTC angegeben. Handelt es sich um ein Textfeld, wird das Datum in UTC angezeigt. Handelt es sich um ein Datums- oder Datum/Uhrzeit-Feld, zeigt DocuWare das Datum im lokalen Format und in der lokalen Zeitzone an.

DaysBeforeExpiration (int)

Integer

Obligatorisch

Wenn der angegebene Wert größer als 0 ist, gilt eine Frist von dieser Anzahl von Tagen, bevor das Dokument abläuft. Wird die Frist überschritten, wird das Dokument als abgelehnt betrachtet. Es wird aus dem DocuSign-Dienst gelöscht und der Unterzeichner kann es nicht mehr signieren.

DocId (int)

Integer

Obligatorisch

ID vom zu unterzeichnenden Dokument

EmailMessage (string)

Text

Obligatorisch

Text, der im Inhalt der E-Mail angezeigt wird

EmailSubject (string)

Text

Obligatorisch

Betreff der E-Mail

FailureStatusValue (string)

Text

Obligatorisch

Wert im Indexfeld, wenn die Signatur für ein Dokument in DocuSign abgelehnt wird

FileCabinetId (string)

Text

Obligatorisch

GUID vom Archiv mit dem zu signierenden Dokument

IncludeDateSigned (boolean)

Text

Optional

Optional, aber wenn der Parameter "true" ist, wird das Unterschriftsdatum in das Dokument aufgenommen und die unten aufgeführten Parameter zum Auffinden des Unterschriftsdatums werden benötigt.

• True

• False

IncludeReport (boolean)

Text

Optional

Wenn Sie den Wert auf „true" setzen, wird nach dem signierten Dokument ein zweites PDF an das Dokument angehängt. Dieses PDF enthält Informationen über den Unterzeichner und das digitale Zertifikat, das dem Dokument hinzugefügt wurde.

• True

• False

MultiAnchorText (string)

Text

Obligatorisch

Bezogen auf den oberen Rand des Ankertextes ist dies die vertikale Position des mit einem Datum unterzeichneten Textes, der auf dem Dokument platziert werden soll (Millimeter). Positive Zahlen sind nach unten gerichtet, negative Zahlen nach oben.

MultiAnchorTextOccurrence (string)

Text

Obligatorisch

Wenn der Ankertext mehrfach im Text vorkommt, wird hier die Stelle für das Setzen der Signatur festgelegt.

MultiDateSignedAnchorText (string)

Text

Obligatorisch

Enthält die Angaben, wo die Ankertexte für die Unterschriften mit Datumsangaben sich im Dokument befinden

MultiDateSignedAnchorTextOccurrence (string)

Text

Obligatorisch

Enthält die Angaben, wo die Ankertexte für die Unterschriften mit Datumsangaben sich im Dokument befinden

MultiDateSignedPageNumber (string)

Text

Obligatorisch

Liste der X-Positionen für das Aufbringen von Signaturen mit Datumsangabe

MultiDateSignedPositionX (string)

Text

Obligatorisch

Liste der X-Positionen für das Aufbringen von Signaturen mit Datumsangabe

MultiDateSignedPositionY (string)

Text

Obligatorisch

Liste der Y-Positionen für das Aufbringen von Signaturen mit Datumsangabe

MultiPageNumber (string)

Text

Obligatorisch

Abgrenzungsliste für die Seitenzahlen, auf denen die Signaturen platziert werden.

MultiPositionX (string)

Text

Obligatorisch

Liste der X-Positionen für das Aufbringen der Signaturen

MultiPositionY (string)

Text

Obligatorisch

Liste der Y-Positionen für das Aufbringen der Signaturen

MultiSignerCount (int)

Text

Obligatorisch

Anzahl der Mehrfach-Signaturen

MultiSignerEmail (string)

Text

Obligatorisch

Enthält die E-Mail-Adressen der Unterzeichner, z.B. peter.sanders@peters-engineering.net,brian.florent@peters-engineering.net.

MultiSignerName (string)

Text

Obligatorisch

Enthält die Namen der Personen, die das Dokument unterzeichnen sollen, z.B."Peter Sanders,Brian Florent".

• 0 oder 1 bezeichnet die first Stelle

• -1 die letzte Stelle

• andere Ziffern Stellen dazwischen

MultiSignerPhoneNumber (string)

Text

Obligatorisch

Trennzeichenliste für Telefonnummern, die für die Authentifizierung per SMS verwendet wird.

MultiValueSeparator (string))

Text

Obligatorisch

Vermittelt dem Service, wie die Liste der Unterzeichner und deren Informationen getrennt wird. Üblich sind Komma, eine Einfügemarke ^ oder ein senkrechter Strich |

OrderedSignature (bool)

Text

Obligatorisch

Mit true werden die Unterschriften in der Reihenfolge abgearbeitet wie in den Feldern darüber festgelegt. Der erste Unterzeichner erhält eine Mail, signiert das Dokument, dann wird an den zweiten Unterzeichner eine E-Mail gesendet, dieser signiert ebenfalls usw. Mit false werden alle Unterzeichner gleichzeitig benachrichtigt und können in einer beliebigen Reihenfolge signieren. In beiden Fällen wird das Archiv erst aktualisiert, wenn alle Signaturen vorhanden sind.

PostSigningAction (string)

Text

Obligatorisch

Gibt an, wie ein signiertes Dokument im Archiv abgelegt wird.

• ClipBefore

• ClipAfter

• Replace

RecipientAuthenticationType (string)

Text

Spezifiziert im Workflow, welche Authentifizierung in DocuSign erforderlich ist

• None

• AccessCode

• Phone

• SMS

• KBA

RecipientMayProvideNumber (Boolean)

String

Obligatorisch für RecipientAuthenticationType = Phone or SMS

Nur für die Authentifizerung per Telefon. Mit „true" werden alle vom Benutzer gesetzten Werte ignoriert. Erst beim Signieren kann der Unterzeichner eine Telefonnummer eingeben, unter der ihm der Zugangscode mitgeteilt wird.

• True

• False

Report Language (string)

Text

Obligatorisch für IncludeReport = True

Optional, kann nur angegeben werden, wenn IncludeReport auf "true" gesetzt ist. Er stellt sicher, dass der generierte Bericht, der an die signierte Datei angehängt wird, in der gewünschten Sprache vorliegt.

• de, en. es, fr, it, ja, ko, nl, pt, pt_BR, ru, zh_CH,zh_TW

SectionNumber (int)

Integer

Obligatorisch

Der Parameter bezieht sich auf geklammerte Dokumente. Die Indexzahl gibt an, welches der geklammerten Dokumente im Stapel unterzeichnet werden soll.

• 0 oder 1 = erstes Dokument im Stapel

• -1 = letztes Dokument

• Andere Ziffern wie 2,3 etc.geben die jeweiligen Dokumente im Stapel an.

StatusFieldName (string)

Text

Obligatorisch

Legt ein Indexfeld vom Dokument fest, dessen Wert verändert wird, wenn das Dokument unterzeichnet oder abgelehnt ist.

SuccessStatusValue (string)

Text

Obligatorisch

Wert, der beim Signieren eines Dokuments in das entsprechende Indexfeld gesetzt wird

Token (string)

Text

Obligatorisch

Token wird bei der Registrierung des Signature Service erstellt und per Mail zugeschickt. Es identifiziert die Kundenorganisation und stellt die Logindaten des Benutzers bereit.

Parametername

Variablentyp im Workflow

Obligatorisch/
optional

Beschreibung

Werte

AccessCode (string)

Text

Obligatorisch für RecipientAuthenticationType = Access Code

Erforderlich, wenn der Authentifizierungstyp "AccessCode" ist. Dabei handelt es sich um den Zugangscode (ähnlich einem Kennwort), der für die Unterzeichnung des Dokuments erforderlich ist. Der Zugriffscode muss dem Unterzeichner in einem separaten Kommunikationskanal (z. B. per Telefon oder E-Mail) mitgeteilt werden.

DateSignedFieldName (string)

Text

Obligatorisch

Name des Datumsfelds, in das das Datum der Signatur eingetragen wird. Es kann ein Text-, Datums- oder Datetime-Feld sein. Das Datum wird in UTC angegeben. Handelt es sich um ein Textfeld, wird das Datum in UTC angezeigt. Handelt es sich um ein Datums- oder Datum/Uhrzeit-Feld, zeigt DocuWare das Datum im lokalen Format und in der lokalen Zeitzone an.

DaysBeforeExpiration (int)

Integer

Obligatorisch

Wenn der angegebene Wert größer als 0 ist, gilt eine Frist von dieser Anzahl von Tagen, bevor das Dokument abläuft. Wird die Frist überschritten, wird das Dokument als abgelehnt betrachtet. Es wird aus dem DocuSign-Dienst gelöscht und der Unterzeichner kann es nicht mehr signieren.

DocId (int)

Integer

Obligatorisch

ID vom zu unterzeichnenden Dokument

EmailMessage (string)

Text

Obligatorisch

Text, der im Inhalt der E-Mail angezeigt wird

EmailSubject (string)

Text

Obligatorisch

Betreff der E-Mail

FailureStatusValue (string)

Text

Obligatorisch

Wert im Indexfeld, wenn die Signatur für ein Dokument in DocuSign abgelehnt wird

FileCabinetId (string)

Text

Obligatorisch

GUID vom Archiv mit dem zu signierenden Dokument

IncludeReport (boolean)

String

Optional

Wenn Sie den Wert auf „true" setzen, wird nach dem signierten Dokument ein zweites PDF an das Dokument angehängt. Dieses PDF enthält Informationen über den Unterzeichner und das digitale Zertifikat, das dem Dokument hinzugefügt wurde.

• True

• False

MultiDateSignedAnchorText (string)

Text

Obligatorisch

Enthält die Angaben, wo die Ankertexte für die Unterschriften mit Datumsangaben sich im Dokument befinden

MultiDateSignedAnchorTextOccurrence (string)

Text

Obligatorisch

Enthält die Angaben, wo die Ankertexte für die Unterschriften mit Datumsangaben sich im Dokument befinden

MultiDateSignedCount (int)

Integer

Obligatorisch

Enthält die Anzahl der unterzeichneten Tabs, die auf dem Dokument platziert werden.

MultiDateSignedPageNumber (string)

Text

Obligatorisch

Liste der X-Positionen für das Aufbringen von Signaturen mit Datumsangabe

MultiDateSignedPositionX (string)

Text

Obligatorisch

Liste der X-Positionen für das Aufbringen von Signaturen mit Datumsangabe

MultiDateSignedPositionY (string)

Text

Obligatorisch

Liste der Y-Positionen für das Aufbringen von Signaturen mit Datumsangabe

MultiInitialAnchorText (string)

Text

Obligatorisch

Enthält die Ankertexte für die Mehrfach-Signatur per Initialen

• 0 oder 1 bezeichnet die first Stelle

• -1 die letzte Stelle

• andere Ziffern Stellen dazwischen

MultiInitialAnchorTextOccurrence (string)

Text

Obligatorisch

Legt fest, welcher Ankertext für die Mehrfach-Signatur mit Initialen verwendet wird (z.B. das erste, zweite oder dritte Mal, wenn der Ankertext im Dokument vorkommt)

MultiInitialCount (int)

Integer

Obligatorisch

Anzahl der Tabs für die Initialen, die im Dokument platziert werden

MultiInitialPageNumber (string)

Text

Obligatorisch

Enthält eine Abgrenzungsliste für die Zahlen der Seiten, auf denen die Initialen-Signaturen platziert werden

MultiInitialPositionX (string)

Text

Obligatorisch

Enthält eine Liste von X-Positionen für die Platzierung der Initialen

MultiInitialPositionY (string)

Text

Obligatorisch

Enthält eine Liste von Y-Positionen für die Platzierung der Initialen

MultiSignatureAnchorText (string)

Text

Obligatorisch

Enthält die Ankertexte für Mehrfachsignaturen

MultiSignatureAnchorTextOccurrence (string)

Text

Obligatorisch

Enthält die Info, bei welchem Vorkommen der Ankertexte die Signaturen platziert werden sollen (zum Beispiel bei der ersten zweiten oder dritten Stelle)

MultiSignatureCount (int)

Integer

Obligatorisch

Anzahl der Tabs für die Mehrfach-Signaturen im Dokument

MultiSignaturePageNumber (string)

Text

Obligatorisch

Trennzeichenliste mit den Seitenzahlen für die Signaturen

MultiSignaturePositionX (string)

Text

Obligatorisch

Enthält eine Liste von X-Positionen für die Platzierung der Initialen

MultiSignaturePositionY (string)

Text

Obligatorisch

Enthält eine Liste von Y-Positionen für die Platzierung der Initialen

MultiValueSeparator (string))

Text

Obligatorisch

Vermittelt dem Service, wie die Liste der Unterzeichner und deren Informationen getrennt wird. Üblich sind Komma, eine Einfügemarke ^ oder ein senkrechter Strich |.

PostSigningAction (string)

Text

Obligatorisch

Gibt an, wie ein signiertes Dokument im Archiv abgelegt wird.

• ClipBefore

• ClipAfter

• Replace

RecipientAuthenticationType (string)

Text

Spezifiziert im Workflow, welche Authentifizierung in DocuSign erforderlich ist

• None

• AccessCode

• Phone

• SMS

• KBA

RecipientMayProvideNumber (Boolean)

Text

Obligatorisch für RecipientAuthenticationType = Phone or SMS

Nur für die Authentifizerung per Telefon. Mit „true" werden alle vom Benutzer gesetzten Werte ignoriert. Erst beim Signieren kann der Unterzeichner eine Telefonnummer eingeben, unter der ihm der Zugangscode mitgeteilt wird.

• True

• False

Report Language (string)

Text

Obligatorisch für IncludeReport = True

Optional, kann nur angegeben werden, wenn IncludeReport auf "true" gesetzt ist. Er stellt sicher, dass der generierte Bericht, der an die signierte Datei angehängt wird, in der gewünschten Sprache vorliegt.

• de, en. es, fr, it, ja, ko, nl, pt, pt_BR, ru, zh_CH,zh_TW

SectionNumber (int)

Integer

Obligatorisch

Der Parameter bezieht sich auf geklammerte Dokumente. Die Indexzahl gibt an, welches der geklammerten Dokumente im Stapel unterzeichnet werden soll.

• 0 oder 1 = erstes Dokument im Stapel

• -1 = letztes Dokument

• Andere Ziffern wie 2,3 etc.geben die jeweiligen Dokumente im Stapel an.

SignerEmail (string)

Text

Obligatorisch

E-Mail-Adresse des unterzeichnenden Benutzers

SignerName (string)

Text

Obligatorisch

Name des unterzeichnenden Benutzers

StatusFieldName (string)

Text

Obligatorisch

Legt ein Indexfeld vom Dokument fest, dessen Wert verändert wird, wenn das Dokument unterzeichnet oder abgelehnt ist.

SuccessStatusValue (string)

Text

Obligatorisch

Wert, der beim Signieren eines Dokuments in das entsprechende Indexfeld gesetzt wird

Token (string)

Text

Obligatorisch

Token wird bei der Registrierung des Signature Service erstellt und per Mail zugeschickt. Es identifiziert die Kundenorganisation und stellt die Logindaten des Benutzers bereit.

Parametername

Workflow-Variable

Obligatorisch/optional

Beschreibung

Werte

AccessCode (string)

Text

Obligatorisch für RecipientAuthenticationType = Access Code

Erforderlich, wenn der Authentifizierungstyp "AccessCode" ist. Dabei handelt es sich um den Zugangscode (ähnlich einem Kennwort), der für die Unterzeichnung des Dokuments erforderlich ist. Der Zugriffscode muss dem Unterzeichner in einem separaten Kommunikationskanal (z. B. per Telefon oder E-Mail) mitgeteilt werden..

DateSignedFieldName (string)

Text

Obligatorisch

Name des Datumsfelds, in das das Datum der Signatur eingetragen wird. Es kann ein Text-, Datums- oder Datetime-Feld sein. Das Datum wird in UTC angegeben. Handelt es sich um ein Textfeld, wird das Datum in UTC angezeigt. Handelt es sich um ein Datums- oder Datum/Uhrzeit-Feld, zeigt DocuWare das Datum im lokalen Format und in der lokalen Zeitzone an.

DaysBeforeExpiration (int)

Integer

Obligatorisch

Wenn der angegebene Wert größer als 0 ist, gilt eine Frist von dieser Anzahl von Tagen, bevor das Dokument abläuft. Wird die Frist überschritten, wird das Dokument als abgelehnt betrachtet. Es wird aus dem DocuSign-Dienst gelöscht und der Unterzeichner kann es nicht mehr signieren.

DocId (int)

Integer

Obligatorisch

ID vom zu unterzeichnenden Dokument

EmailMessage (string)

Text

Obligatorisch

Text, der im Inhalt der E-Mail angezeigt wird

EmailSubject (string)

Text

Obligatorisch

Betreff der E-Mail

FailureStatusValue (string)

Text

Obligatorisch

Wert im Indexfeld, wenn die Signatur für ein Dokument in DocuSign abgelehnt wird.

FileCabinetId (string)

Text

Obligatorisch

GUID vom Archiv mit dem zu signierenden Dokument

IncludeReport (boolean)

Text

Optional

Wenn Sie den Wert auf „true" setzen, wird nach dem signierten Dokument ein zweites PDF an das Dokument angehängt. Dieses PDF enthält Informationen über den Unterzeichner und das digitale Zertifikat, das dem Dokument hinzugefügt wurde.

• True

• False

MultiAnchorText (string)

Text

Obligatorisch

Text, nach dem der Dienst auf dem Dokument suchen kann. Wenn er angegeben und nicht gefunden wird, tritt ein Fehler auf. Wenn nicht angegeben, sind die nachfolgenden Positionsinformationen absolut und nicht relativ, um ein Textstück zu finden.

MultiAnchorTextOccurrence (string)

Text

Obligatorisch

Enthält das Vorkommen des Ankertextes (d. h. das erste, zweite oder dritte Mal usw., dass der Text im Dokument vorkommt) für die verschiedenen Ausgangsorte..

MultiPageNumber (string)

Text

Obligatorisch

Trennzeichenliste für die Seitenzahlen, auf denen die Signaturen platziert werden

MultiPositionX (string)

Text

Obligatorisch

Liste der X-Positionen für das Aufbringen der Signaturen

MultiPositionY (string)

Text

Obligatorisch

Liste der Y-Positionen für das Aufbringen der Signaturen

MultiSectionCount (int)

Integer

Obligatorisch

Anzahl der Tabs mit Initialen. die auf dem Dokument aufgebracht werden sollen

MultiSectionNumber (string)

Text

Obligatorisch

Enthält eine abgegrenzte Liste von Bereichen, in denen sich die Signaturen befinden

MultiValueSeparator (string)

Text

Obligatorisch

Vermittelt dem Signature Service, wie die Liste der Unterzeichner und deren Informationen getrennt wird. Üblich sind Komma, eine Einfügemarke ^ oder ein senkrechter Strich |.

PhoneNumber (string)

String

Obligatorisch

Telefonnummer für die Zwei-Faktor-Authentifizierung (internationales Nummernformat, z.B. +18455639045)

PostSigningAction (string)

Text

Obligatorisch

Gibt an, wie ein signiertes Dokument im Archiv abgelegt wird.

• ClipBefore

• ClipAfter

• Replace

RecipientAuthenticationType (string)

Text

Spezifiziert im Workflow, welche Authentifizierung in DocuSign erforderlich ist

• None

• AccessCode

• Phone

• SMS

• KBA

RecipientMayProvideNumber (Boolean)

String

Obligatorisch für RecipientAuthenticationType = Phone or SMS

Nur für die Authentifizerung per Telefon. Mit „true" werden alle vom Benutzer gesetzten Werte ignoriert. Erst beim Signieren kann der Unterzeichner eine Telefonnummer eingeben, unter der ihm der Zugangscode mitgeteilt wird.

• True

• False

Report Language (string)

String

Obligatorisch für IncludeReport = True

Optional, kann nur angegeben werden, wenn IncludeReport auf "true" gesetzt ist. Er stellt sicher, dass der generierte Bericht, der an die signierte Datei angehängt wird, in der gewünschten Sprache vorliegt.

• de, en. es, fr, it, ja, ko, nl, pt, pt_BR, ru, zh_CH,zh_TW

SignerEmail (string)

Text

Obligatorisch

E-Mail-Adresse des unterzeichnenden Benutzers

SignerName (string)

Text

Obligatorisch

Name des unterzeichnenden Benutzers

StatusFieldName (string)

Text

Obligatorisch

Legt ein Indexfeld vom Dokument fest, dessen Wert verändert wird, wenn das Dokument unterzeichnet oder abgelehnt ist.

SuccessStatusValue (string)

Text

Obligatorisch

Wert, der beim Signieren eines Dokuments in das entsprechende Indexfeld gesetzt wird

Token (string)

Text

Obligatorisch

Kunde erhält Token bei der Anmeldung bei DocuSign. Es identifiziert die Kundenorganisation und stellt die Logindaten des Benutzers bereit.

Parametername

Variablentyp im Workflow

Beschreibung

Werte

DocId (int)

Integer

ID vom zu unterzeichnenden Dokument

FileCabinetId (string)

Text

GUID vom Archiv, in dem das signierende Dokument gespeichert ist

Token (string)

Text

Token wird bei der Registrierung des Signature Service erstellt und per Mail zugeschickt. Es identifiziert die Kundenorganisation und stellt die Logindaten des Benutzers bereit.