Oodrive-Sign (Vorschau)
Stellen Sie die Verbindung her und nutzen Sie den Dienst des Oodrive-Signierers über Ihre Workflows.
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 | Oodrive-Signatur |
| URL | https://www.oodrive.com/products/oodrive-sign/ |
| support-sign@oodrive.com |
| Connectormetadaten | |
|---|---|
| Herausgeber | Oodrive-Signatur |
| Webseite | https://www.oodrive.com/products/oodrive-sign/ |
| Datenschutzrichtlinie | https://www.oodrive.com/privacy-policy/ |
| Kategorien | IT-Vorgänge; Produktivität |
Mit dem Connector von Oodrive Sign können Sie Aufgaben automatisieren und Ihre Prozesse über das Ökosystem elektronischer Signaturen ganz einfach verwalten. Automatisierter Workflow kann so gestaltet werden, dass z. B. ein neuer Vertrag anhand einer Vorlage erstellt, Empfänger automatisch hinzugefügt und der Vertrag zur Signatur gesendet wird. Sie können auch alle Ihre Bündel, Empfänger, Schlüsselparameter und vieles mehr verwalten. Es bietet den Kunden die Möglichkeit, die Zeit zu reduzieren, die für manuelle Aktionen nach dem gesamten Signaturprozess verwendet wird. Alle in der Webanwendung verfügbaren Features können mithilfe des Connectors in Power Automate reproduziert werden.
Voraussetzungen
Sie benötigen ein Konto mit einem kostenpflichtigen Plan im Dienst von Oodrive Sign.
So erhalten Sie Anmeldeinformationen
Sie müssen auch Ihr API-Token abrufen, das zum Supportdienst aufgefordert werden kann, oder es kann in Ihrer begrüßungen E-Mail abgerufen werden, die beim Anwenden auf den Dienst "Sign" an Ihr Postfach gesendet wurde.
Note: If you are a employee, you can get the token by contacting your IT service.
Erste Schritte mit Ihrem Connector
Um mit der Verwendung des Connectors zu beginnen, müssen Sie zuerst Power Automate mit Ihrem Power Platform-Konto öffnen.
Note: you'll need to be premium on Power Automate in order to use the connector.
Führen Sie die folgenden Schritte aus, um einen neuen Workflow zu erstellen und unseren Connector zu verwenden:
- Klicken Sie in Ihrer Power Automate-Umgebung auf die Registerkarte "Erstellen".
- Wählen Sie bei Bedarf "Automatisierter Cloudfluss" oder "Sofortiger Cloudfluss" aus.
- Geben Sie Ihrem neuen Workflow einen Namen, und wählen Sie einen Trigger aus, der Ihren Anforderungen entspricht. Sie können eines der Oodrive-Zeichen verwenden.
- Beginnen Sie mit der Verwendung des Connectors, indem Sie eine Aktion daraus hinzufügen, indem Sie einfach im Katalog nach "Oodrive-Anmeldung" suchen.
- Wenn Sie zum ersten Mal eine Aktion oder einen Trigger von unserem Connector hinzufügen, fordert Power Automate Sie auf, eine Verbindung mit Ihrer Umgebung herzustellen: Dies ist vorhanden, dass Sie das von uns bereitgestellte API-Token verwenden.
- Klicken Sie dann auf "Verbinden": Alles ist erledigt, Sie können beliebig viele Aktionen aus dem gewünschten Connector verwenden.
Bekannte Probleme und Einschränkungen
Bei Problemen mit Oodrive Sign wenden Sie sich bitte an den Supportdienst.
Häufige Fehler und Abhilfemaßnahmen
HTTP-FEHLER 404
Im Allgemeinen wird angezeigt, wenn Sie einen Fehler 404 mit Oodrive Sign's erhalten, dass die Ressource, die Sie finden möchten, nicht in Ihrer Umgebung vorhanden ist. In der Regel kann es sich um einen Fehler in der ID handeln, die für einen bestimmten Vertrag oder einen bestimmten Empfänger vorgesehen ist, das nicht vorhanden ist. Um das Problem zu beheben, versuchen Sie, Ihre Aktion mit einer bekannten ID der Ressource zu verwenden, die Sie abrufen möchten.
HTTP-FEHLER 501
Der HTTP-Fehler 501 gibt an, dass der Dienst des Oodrive-Sign-Zeichens Ihre Anforderung nicht gut erkannt hat oder dass Sie einen falschen Datentyp an den Dienst übergeben haben. Versuchen Sie, die Dokumentation von Sign zu untersuchen, indem Sie die Daten, die Sie an Ihre Aktion oder den Trigger übergeben, lesen.
Häufig gestellte Fragen
1. Wie kann ich ein Dokument in einen bestimmten Vertrag hochladen?
Mit der Aktion "Dokument hochladen und an einen Vertrag anfügen" können Sie ganz einfach eine pdf-Datei hochladen, die remote gespeichert wird.
Der erste Schritt erfordert das Abrufen des Inhalts der Datei, die Sie hochladen möchten. Sie können es mithilfe vieler Connectors abrufen. Beispielsweise können Dateiinhalte mithilfe der Aktion "Dateiinhalt abrufen" des SharePoint-Connectors abgerufen werden.
- Rufen Sie den Inhalt der Datei ab, die Sie als Dokument für einen bestimmten Vertrag hochladen möchten. In diesem Beispiel verwenden wir die Aktion "Dateiinhalt abrufen" des SharePoint Online-Connectors.
- Fügen Sie dann eine neue "Verfassen"-Aktion hinzu. Verwenden Sie den Ausgabetext der Aktion "Dateiinhalt abrufen" als Eingabe für das erste Verfassen.
- Fügen Sie die Aktion "Dokument hochladen und einem Vertrag hinzufügen" aus dem Oodrive-Sign-Connector hinzu.
- Geben Sie in der Eingabe "Vertrags-ID" die ID des Vertrags an, für den Ihr Dokument angefügt werden soll.
- Fügen Sie in der Eingabe "Dateien" die Ausgabe der vorherigen Aktion "Verfassen" ein.
- Fügen Sie in der Eingabe "Dateien (Dateiname)" einen Namen für das Dokument ein, das hochgeladen wird.
- Sie haben das Hochladen des Dokuments abgeschlossen!
2. Kann ich alle Verträge in meiner Umgebung sehen?
Wenn Ihr Token ein "Administrator"-Token ist, ja. Andernfalls zeigen Sie nur den Vertrag an, auf den Sie normal zugreifen.
3. Ich habe einen Vorschlag für den Verbinder. Wo kann ich sie einreichen?
Sie können vorschläge zum Connector übermitteln, indem Sie sich an den Supportdienst wenden. Wir werden uns wirklich dankbar für Ihren Beitrag sein!
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 diese API | Richtig |
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Abrufen des Vertragsstatus |
Überprüfen Sie den Status eines bestimmten Vertrags. |
| Abrufen einer Liste aller Verträge |
Rufen Sie alle Verträge aus der zugehörigen Lizenz ab. |
| Abrufen eines bestimmten Empfängers |
Rufen Sie einen bestimmten Empfänger in der gespeicherten Liste der Empfänger der aktuellen Umgebung ab. |
| Abrufen eines bestimmten Vertrags |
Abrufen von Metadaten eines bestimmten Vertrags. |
| Abrufen von Signaturen eines Vertrags |
Listet alle Signatureninformationen aus einem bestimmten Vertrag auf. |
| Alle Empfänger auflisten |
Rufen Sie alle Empfänger ab, die der aktuellen Lizenz zugeordnet sind. |
| Alle Umkreise auflisten |
Rufen Sie alle Umkreise ab, die der verbundenen Umgebung zugeordnet sind. |
| Auflisten der Empfänger eines Vertrags |
Ruft alle Empfänger für einen bestimmten Vertrag ab. |
| Auflisten der Verträge eines Bündels |
Rufen Sie alle Verträge aus einem bestimmten Bundle ab. |
| Beenden der Transaktion eines Vertrags |
Beenden Sie die Transaktion des Vertrags, damit Sie Vertragsdokumente und/oder Unterzeichner ändern können. |
| Beenden einer Bündeltransaktion |
Beenden sie eine Bündeltransaktion. |
| Dokumente des Vertrags auflisten |
Rufen Sie alle Dokumente ab, die an einen Vertrag gebunden sind. |
| Erneutes Senden der Benachrichtigungs-E-Mail an alle Empfänger |
Senden Sie eine Benachrichtigungs-E-Mail an alle Empfänger eines bestimmten Vertrags. |
| Erneutes Senden von E-Mail-Nachrichten an einen Empfänger |
Senden Sie eine Benachrichtigungs-E-Mail an einen bestimmten Empfänger für den Vertrag. |
| Erstellen eines Bündels |
Erstellen Sie ein neues Bundle mit mindestens einem vorhandenen Vertrag. |
| Erstellen eines Vertrags |
Erstellen Sie einen neuen Vertrag in der Umgebung. |
| Herunterladen der Dokumente des Vertrags |
Rufen Sie eine PDF-Datei ab, die alle Dokumente aus einem Vertrag enthält. |
| Herunterladen der Dokumentprüfungsdatei eines Vertrags |
Laden Sie die Nachweisdatei des Vertrags herunter. |
| Herunterladen des signierten Dokuments eines Vertrags |
Rufen Sie eine PDF-Datei aus dem signierten Dokument des Vertrags ab. |
| Hinzufügen eines Empfängers zu einem Vertrag |
Fügen Sie einen vorhandenen Empfänger an den Vertrag an. |
| Hinzufügen eines Vertrags zu einem Bundle |
Fügen Sie einem vorhandenen Bundle einen vorhandenen Vertrag hinzu. |
| Hochladen einer Anlage und Hinzufügen zu einem Vertrag |
Laden Sie eine neue Anlage in die Umgebung hoch, und fügen Sie sie an einen bestimmten Vertrag an. |
| Hochladen eines Dokuments und Anfügen eines Dokuments an einen Vertrag |
Laden Sie ein Dokument in die Umgebung hoch, und fügen Sie es an einen bestimmten Vertrag an. |
| Löschen eines Empfängers für einen Vertrag |
Löschen Eines Empfängers aus einem Vertrag durch seinen Empfänger für die Vertrags-ID. Weitere Informationen in der Dokumentation. |
| Senden eines Bündels für die Signatur |
Senden Sie ein Bündel für die Signatur. |
| Senden eines Vertrags, der unterzeichnet werden soll |
Senden Sie einen bestimmten Vertrag und alle seine Dokumente, die von Empfängern signiert werden sollen. |
| Vertrag erstellen und zur Signatur senden |
Alles in einem Vorgang. Vertrag erstellen, Empfänger, Dokumente hinzufügen und zur Signatur an Empfänger senden. |
| Widerruf eines Vertrags |
Legen Sie den Status des Vertrags auf VERLASSEN fest, auch wenn der Vertrag zur Unterzeichnung gesendet wurde. |
| Zurückziehen eines Bündels |
Widerrufen sie den gesamten Vertrag in einem Bündel. |
| Überprüfen eines Vertrags |
Überprüfen (Gegenzeichen) eines Vertrags. |
| Überprüfen von Verträgen in einem Bündel |
Gegenzeichen (validieren) des gesamten Vertrags in einem Bündel. |
Abrufen des Vertragsstatus
Überprüfen Sie den Status eines bestimmten Vertrags.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vertrags-ID
|
id | True | integer |
ID des Vertrags zum Abrufen des Status. |
Gibt zurück
- Body
- Transaction
Abrufen einer Liste aller Verträge
Rufen Sie alle Verträge aus der zugehörigen Lizenz ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Größe des zurückgegebenen Arrays
|
size | integer |
Die maximale Größe des zurückgegebenen Arrays des Vertrags. |
|
|
Erste n Verträge überspringen
|
offset | integer |
Die Sequenznummer des Vertrags, der übersprungen wird. |
|
|
Vertragseigenschaften anzeigen
|
get_properties | boolean |
Wenn "true", werden Vertragseigenschaften in der Antwort aufgeführt. |
|
|
Anzeigen von Vertragsperimetern
|
get_perimeters | boolean |
Bei "true" werden Vertragsperimeter in der Antwort aufgeführt. |
|
|
Erstellt vor
|
before | integer |
Listet den Vertrag auf, der vor dem angegebenen Datum erstellt wurde. |
|
|
Erstellt nach
|
after | integer |
Listet den Vertrag auf, der nach dem angegebenen Datum erstellt wurde. |
|
|
Nur mit Umkreis
|
perimeter | string |
Verträge nur in einem bestimmten Umkreis auflisten. |
|
|
Nur mit Status
|
status | array |
Vertrag nur mit dem angegebenen Status abrufen. |
Gibt zurück
- Gegenstände
- ArrayOfContract
Abrufen eines bestimmten Empfängers
Rufen Sie einen bestimmten Empfänger in der gespeicherten Liste der Empfänger der aktuellen Umgebung ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Empfänger-ID
|
id | True | string |
ID des abzurufenden Empfängers. |
Gibt zurück
- Body
- Recipient
Abrufen eines bestimmten Vertrags
Abrufen von Metadaten eines bestimmten Vertrags.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vertrags-ID
|
id | True | string |
Die abzurufende Vertrags-ID. |
Gibt zurück
- Body
- Contract
Abrufen von Signaturen eines Vertrags
Listet alle Signatureninformationen aus einem bestimmten Vertrag auf.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vertrags-ID
|
id | True | string |
ID des Vertrags zum Auflisten aller Signaturen. |
Gibt zurück
Alle Empfänger auflisten
Rufen Sie alle Empfänger ab, die der aktuellen Lizenz zugeordnet sind.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Größe
|
size | integer |
Maximale Größe des zurückgegebenen Arrays. |
|
|
Offset
|
offset | integer |
Sequenznummer des ersten aufgelisteten Empfängers. |
|
|
Umfang
|
perimeter | string |
Suchen Sie nur im angegebenen Umkreis. |
|
|
Benutzerdefinierte Props abrufen
|
get_custom_props | boolean |
Benutzerdefinierte Eigenschaften von Empfängern auflisten (erhöht die Antwortzeit). |
|
|
Umkreise abrufen
|
get_perimeters | boolean |
Listen Sie die Umkreise des Empfängers in den Antworten auf (erhöht die Antwortzeit). |
|
|
Filter nachname (enthält)
|
name | string |
Filtert nach dem Nachnamen. |
|
|
Filtern von E-Mails (enthält)
|
string |
Filtern Sie nach der E-Mail. |
Gibt zurück
- Empfänger
- array of Recipient
Alle Umkreise auflisten
Rufen Sie alle Umkreise ab, die der verbundenen Umgebung zugeordnet sind.
Gibt zurück
- response
- array of Perimeter
Auflisten der Empfänger eines Vertrags
Ruft alle Empfänger für einen bestimmten Vertrag ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vertrags-ID
|
id | True | string |
ID des Vertrags zum Abrufen aller Empfänger. |
Gibt zurück
- response
- array of ContractRecipient
Auflisten der Verträge eines Bündels
Rufen Sie alle Verträge aus einem bestimmten Bundle ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Bündel-ID
|
id | True | string |
ID des Bundles zum Abrufen von Verträgen. |
Gibt zurück
- response
- array of ContractInBundle
Beenden der Transaktion eines Vertrags
Beenden Sie die Transaktion des Vertrags, damit Sie Vertragsdokumente und/oder Unterzeichner ändern können.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vertrags-ID
|
id | True | string |
ID des Vertrags, der beendet werden soll. |
|
Kraft
|
force | boolean |
Transaktionsabschluss erzwingen, auch wenn die Unterzeichner bereits signiert wurden. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
gelingen
|
succeed | boolean |
Geben Sie an, ob der Vertrag gekündigt wurde. |
Beenden einer Bündeltransaktion
Beenden sie eine Bündeltransaktion.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Bündel-ID
|
id | True | string |
ID des Bundles, um die Transaktion zu beenden. |
|
Schließen erzwingen
|
force | boolean |
Transaktionsabschluss erzwingen, auch wenn die Unterzeichner bereits signiert sind. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
gelingen
|
succeed | boolean |
Gibt an, dass das Bundle erfolgreich beendet wurde. |
Dokumente des Vertrags auflisten
Rufen Sie alle Dokumente ab, die an einen Vertrag gebunden sind.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vertrags-ID
|
id | True | string |
ID des Vertrags zum Abrufen von Dokumenten. |
Gibt zurück
- response
- array of DocumentAdded
Erneutes Senden der Benachrichtigungs-E-Mail an alle Empfänger
Senden Sie eine Benachrichtigungs-E-Mail an alle Empfänger eines bestimmten Vertrags.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vertrags-ID
|
id | True | string |
ID des Vertrags zum erneuten Senden der Benachrichtigung. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
gelingen
|
succeed | boolean |
Geben Sie an, ob die Benachrichtigung erfolgreich erneut gesendet wurde. |
Erneutes Senden von E-Mail-Nachrichten an einen Empfänger
Senden Sie eine Benachrichtigungs-E-Mail an einen bestimmten Empfänger für den Vertrag.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vertrags-ID
|
id | True | string |
ID des Vertrags zum erneuten Senden der Benachrichtigung. |
|
Empfänger für Vertrags-ID
|
cfc_id | True | string |
ID des Empfängers für vertragsobjekt zum Senden einer Benachrichtigung. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
gelingen
|
succeed | boolean |
Geben Sie an, ob die Benachrichtigung erfolgreich erneut gesendet wurde. |
Erstellen eines Bündels
Erstellen Sie ein neues Bundle mit mindestens einem vorhandenen Vertrag.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vertrags-ID
|
contract_id | integer |
Die ID des ersten Vertrags des Bündels. |
|
|
Gleiche Unterzeichner
|
same_signatories | boolean |
Auf "false" festgelegt, wenn Verträge im Bündel nicht über denselben Satz von Unterzeichnern verfügen. |
Gibt zurück
- Body
- BundleResponse
Erstellen eines Vertrags
Erstellen Sie einen neuen Vertrag in der Umgebung.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Name des Vertrags
|
name | string |
Name des neu erstellten Vertrags (Erforderlich). |
|
|
Vertragsdefinitions-ID
|
contract_definition_id | integer |
ID der Vertragsdefinition. Verweisen Sie auf die API-Variable Ihrer Lizenz. Standardvorlage für PDF AdHoc. |
|
|
E-Mail-Adresse des Anbieters
|
vendor_email | string |
E-Mail des Lizenzbesitzers. |
|
|
Erstellungsdatum
|
date | integer |
Datum des Vertrags. Default to Date.Now(). Muss in Millisekunden angegeben sein. |
|
|
Nachrichtentitel
|
message_title | string |
Objekt der gesendeten E-Mail. Lassen Sie für einen Standardtitel leer. |
|
|
Nachrichtentext
|
message_body | string |
Textkörper der gesendeten E-Mail. Für eine Standardnachricht leer lassen. |
|
|
Unterwegs bleiben
|
keep_on_move | boolean |
Aktivieren oder Nicht-Line-Signatur auf mobilen Geräten |
|
|
Automatisches Schließen
|
auto_close | integer |
Geben Sie an, ob die Gegensignatur ohne menschliche Intervention durchgeführt wird. |
|
|
Sequenziell
|
sequential | boolean |
Geben Sie an, ob sequenziell oder nicht. |
|
|
Kundennummer
|
customer_number | string |
Nur für ältere mobile Anwendungen kompatibilität. |
|
|
Liste des Perimeters
|
perimeters | array of string | ||
|
Elementdefinitions-ID
|
element_definition_id | integer |
Definitions-ID des Elements. |
|
|
Wert
|
value | string |
Wert der Elementoption. |
|
|
Eigenschaften-ID
|
id | integer |
ID der benutzerdefinierten Eigenschaft. |
|
|
Eigenschaftsschlüssel
|
key | string |
Schlüssel der benutzerdefinierten Eigenschaft. |
|
|
Eigenschaftsplatzhalter
|
placeholder | string |
Bezeichnung, die dem Empfänger angezeigt wird, wenn eingeladen wird, die Eigenschaft auszufüllen. |
|
|
Eigenschaftswert
|
value | string |
Wert der benutzerdefinierten Eigenschaft. |
|
|
Eigenschaftsvertrags-ID
|
contract_id | integer |
ID des Vertrags, der dieser benutzerdefinierten Eigenschaft zugeordnet ist. |
|
|
Eigenschaft ist erforderlich
|
to_fill_by_user | boolean |
Geben Sie an, ob der Benutzer die Eigenschaft ausfüllen muss oder nicht. |
|
|
Eigenschaftstyp
|
field_type | string |
Geben Sie den Typ der benutzerdefinierten Eigenschaft an. Weitere Informationen finden Sie in der Dokumentation. |
|
|
Eigenschaftenauswahl
|
input_filter | string |
Liste der möglichen Auswahlmöglichkeiten für die Eigenschaft. |
|
|
Eigenschaft wird von Vertrag verwendet
|
used_by_contract | boolean |
Auf "true" festgelegt, wenn die Informationen im Vertragsdokument angezeigt werden müssen. |
|
|
Eigenschaft ist erforderlich
|
required | boolean |
Geben Sie an, ob die Eigenschaft erforderlich ist oder nicht. |
Gibt zurück
- Body
- Contract
Herunterladen der Dokumente des Vertrags
Rufen Sie eine PDF-Datei ab, die alle Dokumente aus einem Vertrag enthält.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vertrags-ID
|
id | True | string |
ID des Vertrags zum Abrufen der PDF-Datei. |
|
Ausgabedateiname
|
filename | string |
Name der Datei, die heruntergeladen wird. |
Gibt zurück
- PDF-Dokument-Binärdatei
- file
Herunterladen der Dokumentprüfungsdatei eines Vertrags
Laden Sie die Nachweisdatei des Vertrags herunter.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vertrags-ID
|
id | True | string |
ID des Vertrags zum Herunterladen der Nachweisdatei. |
|
Ausgabedateiname
|
filename | string |
Name der Datei, die heruntergeladen wird. |
Gibt zurück
- response
- file
Herunterladen des signierten Dokuments eines Vertrags
Rufen Sie eine PDF-Datei aus dem signierten Dokument des Vertrags ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vertrags-ID
|
id | True | integer |
ID des Vertrags, der Dokumente enthält. |
|
Dateiname
|
filename | string |
Der Name, den Sie dem heruntergeladenen Dokument zuweisen möchten. |
Gibt zurück
Binärer Inhalt der PDF-Datei.
- Dokument-Binärdatei
- file
Hinzufügen eines Empfängers zu einem Vertrag
Fügen Sie einen vorhandenen Empfänger an den Vertrag an.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vertrags-ID
|
id | True | string |
ID des Vertrags zum Anfügen des Empfängers. |
|
Empfänger-ID
|
recipient_id | integer |
ID des Empfängers, der an den Vertrag angefügt werden soll. |
|
|
Signaturmodus
|
signature_mode | integer |
Signaturmodus. Weitere Informationen finden Sie in der Dokumentation. |
|
|
Nachrichtentitel
|
message_title | string |
Der Titel der Nachricht, die per E-Mail gesendet werden soll, wenn eine nachricht vorhanden ist. |
|
|
Nachrichteninhalt
|
message_body | string |
Textkörper der Nachricht, die per E-Mail gesendet werden soll, wenn eine nachricht vorhanden ist. |
|
|
Rang
|
rank | integer |
Ort des Empfängers im Signaturprozess. Rang und Smartrole schließen sich gegenseitig aus. Wählen Sie nur eine davon aus oder gar nicht. |
|
|
Intelligenter Rollenname
|
smartrole | string |
Intelligente Rolle, die dem Empfänger zugewiesen werden soll. Weitere Informationen finden Sie in der Dokumentation. |
|
|
Transportmodus
|
transport_mode | integer |
Transportmodus der Signatur. Weitere Informationen finden Sie in der Dokumentation. |
Gibt zurück
- response
- array of ContractRecipient
Hinzufügen eines Vertrags zu einem Bundle
Fügen Sie einem vorhandenen Bundle einen vorhandenen Vertrag hinzu.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Bündel-ID
|
id | True | string |
ID des Bundles zum Hinzufügen eines Vertrags. |
|
Vertrags-ID
|
contract_id | integer |
ID des Vertrags, der dem Bundle hinzugefügt werden soll. |
Gibt zurück
- Body
- BundleResponse
Hochladen einer Anlage und Hinzufügen zu einem Vertrag
Laden Sie eine neue Anlage in die Umgebung hoch, und fügen Sie sie an einen bestimmten Vertrag an.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vertrags-ID
|
id | True | string |
ID des Vertrags zum Hinzufügen einer Anlage. |
|
Vertragsdefinitions-ID
|
contract_definition_id | integer |
In Ihrer Umgebung definierte Vertragsdefinitions-ID. Der Standardwert ist pdfadhoc. |
|
|
Optionsdefinitionsname
|
option_definition_name | string |
Definitionsname. |
|
|
Dateien
|
file | array |
Dateien, die als Anlagen hinzugefügt werden sollen |
Gibt zurück
- Body
- AppendixAdded
Hochladen eines Dokuments und Anfügen eines Dokuments an einen Vertrag
Laden Sie ein Dokument in die Umgebung hoch, und fügen Sie es an einen bestimmten Vertrag an.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vertrags-ID
|
id | True | string |
ID des Vertrags zum Anfügen eines neuen Dokuments an. |
|
Datei
|
file | file |
Datei-Binärdatei, die hochgeladen werden soll. |
Gibt zurück
- response
- array of DocumentAdded
Löschen eines Empfängers für einen Vertrag
Löschen Eines Empfängers aus einem Vertrag durch seinen Empfänger für die Vertrags-ID. Weitere Informationen in der Dokumentation.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Empfänger für Vertrags-ID
|
cfc_id | True | string |
ID des Zu löschenden Vertragsobjekts des Empfängers. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
gelingen
|
succeed | boolean |
Geben Sie an, ob sie erfolgreich entfernt wurde. |
Senden eines Bündels für die Signatur
Senden Sie ein Bündel für die Signatur.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Bündel-ID
|
id | True | string |
ID des Bundles, das zur Signatur gesendet werden soll. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
gelingen
|
succeed | boolean |
Gibt an, ob die Transaktion gesendet wurde oder nicht. |
Senden eines Vertrags, der unterzeichnet werden soll
Senden Sie einen bestimmten Vertrag und alle seine Dokumente, die von Empfängern signiert werden sollen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vertrags-ID
|
id | True | string |
ID des Vertrags, der zur Signatur gesendet werden soll. |
Gibt zurück
- Body
- Transaction
Vertrag erstellen und zur Signatur senden
Alles in einem Vorgang. Vertrag erstellen, Empfänger, Dokumente hinzufügen und zur Signatur an Empfänger senden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vertrags-ID
|
contract_id | integer |
Die ID des Vertrags. |
|
|
Erstellungsdatum
|
date | integer |
Datum, zu dem der Vertrag erstellt wurde. |
|
|
E-Mail-Adresse des Anbieters
|
vendor_email | string |
E-Mail-Adresse des Lizenzbesitzers von Oodrive. |
|
|
Vertragsdefinitions-ID
|
contract_definition_id | integer |
ID der für diesen Vertrag verwendeten Vertragsdefinition. |
|
|
Nachrichtenbetreff
|
message_title | string |
E-Mail-Betreff, wenn er zur Signatur gesendet wird. |
|
|
Nachrichtentext
|
message_body | string |
E-Mail-Textkörper, wenn er zur Signatur gesendet wird. |
|
|
Vertragsname
|
name | True | string |
Der Hauptdokumentname des Vertrags. |
|
Offlinesignatur aktiviert
|
keep_on_move | boolean |
Ermitteln Sie, ob die Offlinesignatur auf mobilen Geräten aktiviert ist. |
|
|
Abschlussdatum des Vertrags
|
closed_date | integer |
Datum der Vertragsschließung, sofern vorhanden. |
|
|
Vertrag abgebrochener Grund
|
canceled_reason | string |
Grund für den Abbruch, falls vorhanden. |
|
|
Auto Schließen aktiviert
|
auto_close | integer |
Geben Sie an, ob der Vertrag automatisch gegengezeichnet wird oder einen menschlichen Eingriff benötigt. |
|
|
Ist gelöscht
|
deleted | integer |
Geben Sie an, ob der Vertrag gelöscht wurde oder nicht. |
|
|
Umkreisschlüssel
|
Perimeters | string |
Schlüssel des Perimeters. |
|
|
Options-ID
|
id | integer |
ID der Vertragsoption. |
|
|
Vertrags-ID
|
contract_id | integer |
ID des Vertrags, der an diese Option gebunden ist. |
|
|
Elementdefinitions-ID
|
element_definition_id | integer |
ID der Elementdefinition der Option. |
|
|
Synchronisierungszeitgeber
|
sync_timer | integer |
Timer, der für das Synchronisierungsproblem verwendet wird. |
|
|
Optionswert
|
value | string |
Wert der Option. |
|
|
Letzter Änderungsort
|
last_modification_place | string |
Gibt an, wo die letzte Änderung stattgefunden hat. |
|
|
Optionssteuerelement
|
control | string |
Kontrollfeld. |
|
|
Eigenschaften-ID
|
id | integer |
ID der benutzerdefinierten Eigenschaft. |
|
|
Eigenschaftsschlüssel
|
key | string |
Schlüssel der benutzerdefinierten Eigenschaft. |
|
|
Eigenschaftsplatzhalter
|
placeholder | string |
Bezeichnung, die dem Empfänger angezeigt wird, wenn eingeladen wird, die Eigenschaft auszufüllen. |
|
|
Eigenschaftswert
|
value | string |
Wert der benutzerdefinierten Eigenschaft. |
|
|
Eigenschaftsvertrags-ID
|
contract_id | integer |
ID des Vertrags, der dieser benutzerdefinierten Eigenschaft zugeordnet ist. |
|
|
Eigenschaft ist erforderlich
|
to_fill_by_user | boolean |
Geben Sie an, ob der Benutzer die Eigenschaft ausfüllen muss oder nicht. |
|
|
Eigenschaftstyp
|
field_type | string |
Geben Sie den Typ der benutzerdefinierten Eigenschaft an. Weitere Informationen finden Sie in der Dokumentation. |
|
|
Eigenschaftenauswahl
|
input_filter | string |
Liste der möglichen Auswahlmöglichkeiten für die Eigenschaft. |
|
|
Eigenschaft wird von Vertrag verwendet
|
used_by_contract | boolean |
Auf "true" festgelegt, wenn die Informationen im Vertragsdokument angezeigt werden müssen. |
|
|
Eigenschaft ist erforderlich
|
required | boolean |
Geben Sie an, ob die Eigenschaft erforderlich ist oder nicht. |
|
|
Signaturmodus
|
signature_mode | integer | ||
|
Vorname
|
firstname | string | ||
|
Nachname
|
lastname | string | ||
|
E-Mail
|
string | |||
|
cell_phone
|
cell_phone | string | ||
|
PDF-Webparts
|
pdfparts | string | ||
|
Anhangsteils
|
appendixparts | string |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
recipients
|
recipients | array of Recipient | |
|
recipientForcontract
|
recipientForcontract | array of ContractRecipient | |
|
Vertrag
|
contract | Contract | |
|
PDF
|
pdfparts | array of object |
Array von PDF-Dateien, die an den Vertrag gebunden sind. |
|
PDF-ID
|
pdfparts.id | integer |
ID der PDF. |
|
PDF-Rang
|
pdfparts.rank | integer |
Rang der PDF. |
|
Hat SmartFields
|
pdfparts.has_smart_field | boolean |
Geben Sie an, ob intelligente Felder im Vertrag vorhanden sind. |
|
PDF-Größe
|
pdfparts.size | integer |
Größe des Dokuments. |
|
Dateiname
|
pdfparts.filename | string |
Name der PDF. |
|
Anhangsteils
|
appendixparts | array of object | |
|
id
|
appendixparts.id | integer |
Widerruf eines Vertrags
Legen Sie den Status des Vertrags auf VERLASSEN fest, auch wenn der Vertrag zur Unterzeichnung gesendet wurde.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vertrags-ID
|
id | True | string |
ID des Vertrags, der zurückgenommen werden soll. |
|
Ursache
|
reason | string |
Der Grund des Widerrufs. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
gelingen
|
succeed | boolean |
Geben Sie an, ob der Vertrag gekündigt wurde. |
Zurückziehen eines Bündels
Widerrufen sie den gesamten Vertrag in einem Bündel.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Bündel-ID
|
id | True | string |
ID des Bundles, um den gesamten Vertrag zurückzuziehen. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
gelingen
|
succeed | boolean |
Gibt an, ob das Bündel zurückgezogen wurde. |
Überprüfen eines Vertrags
Überprüfen (Gegenzeichen) eines Vertrags.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vertrags-ID
|
id | True | string |
DIE ID des Vertrags, der überprüft werden soll. |
|
Kraft
|
force | boolean |
Geben Sie an, ob die Vertragsüberprüfung erzwungen werden muss, auch wenn einige Unterzeichner noch nicht signiert wurden. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gültigkeitsdatum
|
date | string |
Gültigkeitsdatum. |
|
Buchungskennung
|
id | string |
Transaktions-ID der Zertifizierungsstelle. |
Überprüfen von Verträgen in einem Bündel
Gegenzeichen (validieren) des gesamten Vertrags in einem Bündel.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Bündel-ID
|
id | True | string |
ID des Bundles, um den gesamten Vertrag zu überprüfen. |
|
Gültigkeitsprüfung erzwingen
|
force | boolean |
Erzwingen Sie die Überprüfung der Verträge, wenn einige Unterzeichner noch nicht unterzeichnet wurden (oder sich geweigert haben, zu unterzeichnen). |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of object | ||
|
date
|
date | string |
Datum des Abschlusszustands. |
|
Vertrags-ID
|
id | string |
Die ID des Vertrags wurde beendet. |
Auslöser
| Wenn sich der Status eines Vertrags ändert |
Dieser Vorgang wird ausgelöst, wenn sich der Status eines Vertrags geändert hat. |
Wenn sich der Status eines Vertrags ändert
Dieser Vorgang wird ausgelöst, wenn sich der Status eines Vertrags geändert hat.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Beschreibung
|
description | string |
Beschreibung |
|
|
events
|
events | array of string |
events |
|
|
contractDefinition
|
contractDefinition | array of integer |
contractDefinition |
|
|
Umfang
|
perimeter | array of integer |
Umfang |
|
|
concernedUserEmail
|
concernedUserEmail | string |
concernedUserEmail |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
type
|
type | string |
type |
|
contractId
|
contractId | integer |
contractId |
|
Zeitstempel
|
timestamp | integer |
Zeitstempel |
|
contractStatus
|
contractStatus | string |
contractStatus |
Definitionen
ArrayOfContract
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
Contract |
Vertrag
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Vertrags-ID
|
contract_id | integer |
Die ID des Vertrags. |
|
Erstellungsdatum
|
date | integer |
Datum, zu dem der Vertrag erstellt wurde. |
|
Dokumenttoken
|
document_token | string |
Token des Hauptdokuments des Vertrags. |
|
E-Mail-Adresse des Anbieters
|
vendor_email | string |
E-Mail-Adresse des Lizenzbesitzers von Oodrive. |
|
Ist geschlossen
|
closed | boolean |
Geben Sie an, ob der Vertrag geschlossen ist oder nicht. |
|
Vertragsstatus
|
status | string |
Der aktuelle Status des Vertrags. |
|
Vertragsdefinitions-ID
|
contract_definition_id | integer |
ID der für diesen Vertrag verwendeten Vertragsdefinition. |
|
Nachrichtenbetreff
|
message_title | string |
E-Mail-Betreff, wenn er zur Signatur gesendet wird. |
|
Nachrichtentext
|
message_body | string |
E-Mail-Textkörper, wenn er zur Signatur gesendet wird. |
|
Vertragsname
|
name | string |
Der Hauptdokumentname des Vertrags. |
|
Offlinesignatur aktiviert
|
keep_on_move | boolean |
Ermitteln Sie, ob die Offlinesignatur auf mobilen Geräten aktiviert ist. |
|
Abschlussdatum des Vertrags
|
closed_date | integer |
Datum der Vertragsschließung, sofern vorhanden. |
|
Vertrag abgebrochener Grund
|
canceled_reason | string |
Grund für den Abbruch, falls vorhanden. |
|
Vertragsversionsnummer
|
version_number | integer |
Versionsnummer des Vertrags. |
|
Vertragsgröße
|
size | integer |
Volle Größe des Vertrags. |
|
Auto Schließen aktiviert
|
auto_close | integer |
Geben Sie an, ob der Vertrag automatisch gegengezeichnet wird oder einen menschlichen Eingriff benötigt. |
|
Ist gelöscht
|
deleted | integer |
Geben Sie an, ob der Vertrag gelöscht wurde oder nicht. |
|
Umfänge
|
perimeters | array of ContractPerimeterKey |
Liste aller Umkreise des Vertrags (falls abgefragt). |
|
Options
|
options | array of ContractOption |
Liste aller spezifischen Optionen des Vertrags (falls abgefragt). |
|
Benutzerdefinierte Eigenschaften
|
contract_properties | array of ContractProperty |
Liste aller optionalen Vertragseigenschaften (falls abgefragt). |
ContractOption
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Options-ID
|
id | integer |
ID der Vertragsoption. |
|
Vertrags-ID
|
contract_id | integer |
ID des Vertrags, der an diese Option gebunden ist. |
|
Elementdefinitions-ID
|
element_definition_id | integer |
ID der Elementdefinition der Option. |
|
Synchronisierungszeitgeber
|
sync_timer | integer |
Timer, der für das Synchronisierungsproblem verwendet wird. |
|
Optionswert
|
value | string |
Wert der Option. |
|
Letzter Änderungsort
|
last_modification_place | string |
Gibt an, wo die letzte Änderung stattgefunden hat. |
|
Optionssteuerelement
|
control | string |
Kontrollfeld. |
ContractProperty
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Eigenschaften-ID
|
id | integer |
ID der benutzerdefinierten Eigenschaft. |
|
Eigenschaftsschlüssel
|
key | string |
Schlüssel der benutzerdefinierten Eigenschaft. |
|
Eigenschaftsplatzhalter
|
placeholder | string |
Bezeichnung, die dem Empfänger angezeigt wird, wenn eingeladen wird, die Eigenschaft auszufüllen. |
|
Eigenschaftswert
|
value | string |
Wert der benutzerdefinierten Eigenschaft. |
|
Eigenschaftsvertrags-ID
|
contract_id | integer |
ID des Vertrags, der dieser benutzerdefinierten Eigenschaft zugeordnet ist. |
|
Eigenschaft ist erforderlich
|
to_fill_by_user | boolean |
Geben Sie an, ob der Benutzer die Eigenschaft ausfüllen muss oder nicht. |
|
Eigenschaftstyp
|
field_type | string |
Geben Sie den Typ der benutzerdefinierten Eigenschaft an. Weitere Informationen finden Sie in der Dokumentation. |
|
Eigenschaftenauswahl
|
input_filter | string |
Liste der möglichen Auswahlmöglichkeiten für die Eigenschaft. |
|
Eigenschaft wird von Vertrag verwendet
|
used_by_contract | boolean |
Auf "true" festgelegt, wenn die Informationen im Vertragsdokument angezeigt werden müssen. |
|
Eigenschaft ist erforderlich
|
required | boolean |
Geben Sie an, ob die Eigenschaft erforderlich ist oder nicht. |
ContractPerimeterKey
ContractRecipient
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Empfänger für Vertrags-ID
|
recipient_for_contract_id | integer |
Eindeutiger Bezeichner des Paarvertrags und des Empfängers. |
|
Empfänger-ID
|
recipient_id | integer |
ID des Empfängers. |
|
Vertrags-ID
|
contract_id | integer |
ID des Vertrags. |
|
Signaturstatus
|
signature_status | string |
Status des Zeichenzeichens. |
|
Signaturdatum
|
signature_date | integer |
Zeitstempel des Datums der Zeichenmarke. |
|
Signaturmodus
|
signature_mode | integer |
Signierzeichenmodus. |
|
Nachrichtentitel
|
message_title | string |
Der Titel der Nachricht. |
|
Nachrichteninhalt
|
message_body | string |
Textkörper der Nachricht. |
|
Rang
|
rank | integer |
Rang im Signiervorgang. |
|
Intelligente Rolle
|
smartrole | string |
Intelligente Rolle, die dem Empfänger zugeordnet ist. |
|
Transportmodus
|
transport_mode | integer |
Transportmodus. |
|
Signatur-ID
|
signature_id | string |
ID der Signatur des Empfängers. |
DocumentAdded
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Dokument-ID
|
id | integer |
ID des Dokuments. |
|
Rang
|
rank | integer |
Platzieren Sie die Liste des Dokuments. |
|
Hat SmartField
|
has_smart_field | boolean |
Geben Sie an, ob das Dokument SmartFields aufweist. |
|
Dokumentgröße
|
size | integer |
Größe des Dokuments in Byte. |
|
Dokumentname
|
filename | string |
Name des Dokuments. |
Transaktion
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Vertragstransaktions-ID
|
transaction_id | string |
Geben Sie die Transaktions-ID an, die an den Vertrag gebunden ist. |
|
Ist geschlossen
|
is_closed | boolean |
Geben Sie an, ob der Vertrag geschlossen ist. |
|
Vertragsname
|
contract_name | string |
Name des Vertrags. |
|
Vertragsstatus
|
status | string |
Geben Sie den Status des Vertrags an. |
Umfang
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Umkreis-ID
|
id | integer |
ID des Umkreises. |
|
Umkreisschlüssel
|
key | string |
Schlüssel des Perimeters (verwendet von Verträgen). |
|
Beschreibung
|
description | string |
Beschreibung des Perimeters. |
RecipientForContractWithRefusal
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Empfänger für Vertrags-ID
|
recipient_for_contract_id | integer |
ID des Objekts, das den Vertrag und den Empfänger gebunden hat. |
|
Empfänger-ID
|
recipient_id | integer |
ID des Empfängers der Signatur. |
|
Signaturstatus
|
signature_status | string |
Status der Signatur. |
|
Signaturdatum
|
signature_date | integer |
Datum der letzten Änderungen der Signatur. |
|
Signaturmodus
|
signature_mode | integer |
Modus der Signatur. |
|
Nachrichtentitel
|
message_title | string |
Der Titel der Nachricht, die an die Unterschrift des Vertrags gebunden ist. |
|
Nachrichteninhalt
|
message_body | string |
Textkörper der Nachricht, die an die Unterschrift des Vertrags gebunden ist. |
|
Rang
|
rank | integer |
Rang des Empfängers der Signatur im Vertragsprozess. |
|
Intelligenter Rollenname
|
smartrole | string |
Rolle des Empfängers der Signatur im Vertrag. |
|
Transportmodus
|
transport_mode | integer |
Transportmodus des Vertrags, der an die Unterschrift gebunden ist. |
|
Signatur-ID
|
signature_id | string |
ID der Signatur. |
|
Hat Weigerung
|
has_refusal | boolean |
Geben Sie an, ob der Empfänger den Vertrag abgelehnt hat. |
|
Datum der letzten Ablehnung
|
last_refusal_date | integer |
Geben Sie das Datum der Ablehnung an. |
|
Letzte Ablehnungsnachricht
|
last_refusal_message | string |
Geben Sie die Ablehnungsnachricht an. |
ContractInBundle
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Vertrags-ID
|
id | integer |
ID des Vertrags. |
|
Vertragsname
|
name | string |
Name des Vertrags. |
|
Vertragsdefinitionstyp
|
contract_definition_type | string |
Typ der Definition des Vertrags. |
|
Vertragsdefinitions-ID
|
contract_definition_id | integer |
ID der Vertragsdefinition. |
|
Unternehmensname
|
company_name | string |
Name des an den Vertrag gebundenen Unternehmens. |
Recipient
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Empfänger-ID
|
id | integer |
ID des Empfängers. |
|
Höflichkeit
|
civility | string |
Zivilität des Empfängers |
|
Vorname
|
firstname | string |
Vorname des Empfängers. |
|
Nachname
|
lastname | string |
Nachname des Empfängers. |
|
Hauptadresse
|
address_1 | string |
Hauptpostadresse des Empfängers. |
|
Postleitzahl
|
postal_code | string |
Postleitzahl des Empfängers. |
|
Stadt
|
city | string |
Ort des Empfängers. |
|
Mobiltelefonnummer
|
cell_phone | string |
Mobiltelefonnummer des Empfängers. |
|
E-Mail-Adresse
|
string |
E-Mail-Adresse des Empfängers. |
|
|
Country
|
country | string |
Land des Empfängers. |
|
Sekundäre Adresse
|
address_2 | string |
Sekundäre Postadresse des Empfängers. |
|
Name des Unternehmens
|
company_name | string |
Firmenname des Empfängers. |
|
Telefonnummer
|
phone | string |
Telefonnummer des Empfängers. |
|
Position
|
job_title | string |
Position des Empfängers. |
|
Geburtsdatum
|
birthdate | integer |
Geburtsdatum (Zeitstempel) des Empfängers. |
|
Geburtsort
|
birthplace | string |
Geburtsort des Empfängers. |
|
custom_properties
|
custom_properties | array of RecipientProperty | |
|
Umfänge
|
perimeters | array of string |
RecipientProperty
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Eigenschaften-ID
|
id | integer |
ID der Eigenschaft. |
|
Eigenschaftsschlüssel
|
key | string |
Schlüssel der Eigenschaft. |
|
Eigenschaftswert
|
value | string |
Wert der Eigenschaft. |
|
Auftragnehmer-ID
|
contractor_id | integer |
ID des Auftragnehmers. |
|
Synchronisierungszeitgeber
|
sync_timer | integer |
Zeitgeber der letzten Synchronisierung. |
|
Letzter Änderungsort
|
last_modification_place | string |
Speicherort der letzten Änderung. |
AnhangAdded
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anhangs-ID
|
id | integer |
ID des Anhangs. |
|
Anhangsname
|
filename | string |
Name des Anhangs. |
|
Anhang Options-ID
|
option_id | integer |
Options-ID für den Anhang |
|
Inhaltstyp des Anhangs
|
content_type | string |
Inhaltstyp des Anhangs (z. B. Bild/JPEG). |
BundleResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Bündel-ID
|
id | integer |
ID des Bundles. |
|
Autor-ID
|
actor_id | integer |
ID des Erstellers des Bundles. |
|
Erste Vertrags-ID
|
contract_id | integer |
ID des ersten Vertrags des erstellten Bundles. |
|
Bundlestatus
|
status | integer |
Status des Bündels. |
|
Bündelmaster
|
master | integer |
Master des Bündels. |
file
Dies ist der grundlegende Datentyp "Datei".