Create Sign Request

Projektkompatibilität

Windows | Plattformübergreifend

Überblick

Beschreibung	API-Methode	API-Pfad
Erstellen Sie eine Signaturanforderung für ein Dokument mithilfe einer Box Sign-Vorlage.	Posten	/sign_requests/send

Hinweis:

Um eine Signaturanforderung mit der Aktivität Create Sign Request zu erstellen, müssen die im Prozess verwendeten Dokumente Vorlagen-Tags haben.

Vorlagen-Tags sind eine Möglichkeit, Daten zu einem Basisdokument hinzuzufügen, das Box Sign automatisch erkennt. Informationen zum Erstellen von Vorlagen mit Tags finden Sie in der offiziellen Box-Dokumentation.

Eingabe

Parameter	Beschreibung	Datentyp
E-Mails von Unterzeichnern	Die E-Mail-Adressen aller erforderlichen Unterzeichner. Die Reihenfolge der Unterzeichner kann angegeben werden, wobei der erste Unterzeichner als Index 0 bezeichnet wird.	string
Zu signierende Datei	Die Datei, für die die Signaturanforderung erstellt wird.	Datenliste
Zielordner	Der Ordner, in dem das signierte Dokument nach Fertigstellung gespeichert wird.	Datenliste
Vorlage	Die Box Sign-Vorlage, die für den Signaturprozess verwendet werden soll. Vorlagen können direkt in Box erstellt werden.	Datenliste
E-Mail-Betreff	Die Betreffzeile der E-Mail mit Signaturanforderung, die an die Empfänger gesendet wird.	string
EMailNachricht	Der in der E-Mail enthaltene Nachrichtentext, der an die Unterzeichner gesendet wird.	string
Erinnerungen	Wenn diese Option aktiviert ist, sendet Box an den Tagen 3, 8, 13 und 18 automatisch Erinnerungen an herausragende Unterzeichner.	boolean
Tage gültig	Die Anzahl der Tage, nach denen die Signaturanforderung automatisch abläuft, wenn sie nicht abgeschlossen ist.	Int32
Sind Textsignaturen aktiviert	Bestimmt, ob Unterzeichner durch Eingabe ihres Namens (Textsignaturen) signieren dürfen. Wenn diese Option deaktiviert ist, sind nur gezeichnete oder hochgeladene Signaturen zulässig.	boolean
Externe ID	Ein Bezeichner, der verwendet wird, um auf die Signaturanforderung in einem externen System zu verweisen.	string
Tags: Textwert vorab ausfüllen	Der Textwert zum Vorabausfüllen eines entsprechenden in der Vorlage definierten Text-Tags.	string
Datumswert der Tags vorab ausfüllen	Ein Datumswert, der verwendet wird, um ein in der Vorlage definiertes Datums-Tag vorab auszufüllen.	DateTime
Ist Dokumentvorbereitung erforderlich	Gibt an, ob die Dokumentvorbereitung (z. B. Einrichten von Feldern) vor dem Senden erforderlich ist.	boolean
Kontrollkästchenwert für Tags vorab ausfüllen	Ein boolescher Wert, der verwendet wird, um ein Kontrollkästchenfeld in der Vorlage vorab auszufüllen.	boolean
Tags vorab ausfüllen, Dokument-Tag-ID	Die Tag-ID des Feldes, das vorab ausgefüllt wird, wie in der Box-Sign-Vorlage definiert.	string

Hinweis: Vorlagen-Tags werden in der Reihenfolge zugewiesen, in der die E-Mail-Adressen dem Feld E- Mails des Unterzeichners hinzugefügt werden. Dies ist nicht dasselbe wie die Reihenfolge beim Signieren. Wenn das Dokument mehr Tags als tatsächliche Unterzeichner hat, werden diese Tags nicht aufgefüllt. Wenn Sie mehr Unterzeichner als Tags hinzufügen, können die zusätzlichen Unterzeichner das Dokument signieren, werden aber nicht an die Speicherorte im Dokument weitergeleitet. Sie können Text, Datumsangaben und Signaturen an jeder beliebigen Stelle im Dokument hinzufügen.

Ausgabe

Parameter	Beschreibung	Datentyp
ID der Signaturanforderung	Der eindeutige Bezeichner der neu erstellten Signaturanforderung.	string
Create Sign Request	Das vollständige Antwortobjekt mit Details zur erstellten Signaturanforderung.	object

Hinweis:

• In API-Workflows wird als Ausgabe ein einzelnes Antwortobjekt zurückgegeben. Alle Pflichtfelder können direkt aus diesem Objekt extrahiert werden.
• In RPA-Workflows können sich einige Ausgabeparameter unterscheiden, aber die erforderlichen Werte können weiterhin aus dem Antwortobjekt abgerufen werden, auch wenn sie nicht explizit verfügbar gemacht werden.