Adobe Acrobat-Zeichen
Adobe ist der vertrauenswürdigste digitale Dokumentanmeldungsdienst der Welt. Mit Adobe Acrobat Sign können Sie manuelle Prozesse in alle digitalen Erfahrungen umwandeln. Integrieren Sie adobe Acrobat Sign-Funktionen in Ihre bevorzugten Anwendungen, um den Status von Vereinbarungen zu erstellen, zu senden und zu überwachen.
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 | Adobe Acrobat Sign Support |
| URL | https://helpx.adobe.com/contact/enterprise-support.dc.html#sign |
| support@echosign.zendesk.com |
| Connectormetadaten | |
|---|---|
| Herausgeber | ADOBE INC. |
| Webseite | https://acrobat.adobe.com/us/en/sign.html |
| Datenschutzrichtlinie | https://www.adobe.com/privacy/policy.html |
| Kategorien | Webseite |
Adobe Acrobat-Zeichen
Adobe ist der vertrauenswürdigste digitale Dokumentanmeldungsdienst der Welt. Mit Adobe Acrobat Sign können Sie manuelle Prozesse in alle digitalen Erfahrungen umwandeln. Integrieren Sie adobe Acrobat Sign-Funktionen in Ihre bevorzugten Anwendungen, um den Status von Vereinbarungen zu erstellen, zu senden und zu überwachen.
Publisher: Adobe, Inc.
Voraussetzungen
Adobe Acrobat Sign-Konto ist erforderlich.
So erhalten Sie Anmeldeinformationen
N/A
Erste Schritte mit Ihrem Connector
Connector-Benutzerhandbuch https://helpx.adobe.com/sign/integrations/microsoft-powerapps-flow.html
Bekannte Probleme und Einschränkungen
N/A
Häufige Fehler und Abhilfemaßnahmen
N/A
Häufig gestellte Fragen
Connector-Benutzerhandbuch https://helpx.adobe.com/sign/integrations/microsoft-powerapps-flow.html
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 250 | 60 Sekunden |
Aktionen
| Abrufen der detaillierten Informationen des Workflows |
Dieser Vorgang ruft detaillierte Informationen zum Workflow ab. |
| Abrufen der Signatur-URL |
Dieser Vorgang ruft die URL für die E-Signierseite für die aktuellen Signierer einer Vereinbarung ab. |
| Abrufen der URL der Vereinbarungsansicht |
Ruft die neueste Statusansichts-URL der Vereinbarung ab. |
| Abrufen des Status einer Vereinbarung |
Dieser Vorgang ruft alle aktuellen Informationen einer Vereinbarung ab, z. B. den Status. |
| Abrufen des Status einer Vereinbarung [VERALTET] |
Diese Aktion ist veraltet. Verwenden Sie stattdessen den Status einer Vereinbarung .
|
| Abrufen einer Liste aller Bibliotheksvorlagen |
Mit diesem Vorgang wird die Liste aller Dokumente abgerufen, die als Vorlagen in der Adobe Acrobat Sign-Bibliothek des Benutzers gespeichert sind. |
| Abrufen einer Liste aller Bibliotheksvorlagen (Alt) [VERALTET] |
Mit diesem Vorgang wird die Liste aller Dokumente abgerufen, die als Vorlagen in der Adobe Acrobat Sign-Bibliothek des Benutzers gespeichert sind. |
| Abrufen einer Liste aller Dokument-IDs aus einer Vereinbarung |
Dieser Vorgang ruft die IDs aller Dokumente und unterstützenden Dokumente einer Vereinbarung ab. |
| Abrufen einer Liste aller Dokument-IDs aus einer Vereinbarung [VERALTET] |
Diese Aktion ist veraltet. Verwenden Sie stattdessen eine Liste aller Dokument-IDs aus einer Vereinbarung .
|
| Abrufen einer Liste aller Gruppen, zu der der Benutzer gehört |
Dieser Vorgang ruft die Liste aller Gruppenbenutzer ab. |
| Abrufen einer Liste aller Vereinbarungen |
Dieser Vorgang ruft die Liste aller Vereinbarungen des Benutzers ab. |
| Abrufen einer Liste aller Vereinbarungen (Alt) [VERALTET] |
Dieser Vorgang ruft die Liste aller Vereinbarungen des Benutzers ab. |
| Abrufen einer Liste aller Vereinbarungen basierend auf Suchkriterien |
Bei diesem Vorgang werden Vereinbarungen nach Kriterien wie Workflow-ID usw. durchsucht. |
| Abrufen einer Liste aller Webformulare |
Dieser Vorgang ruft die Liste aller Webformulare des Benutzers ab. |
| Abrufen einer Liste aller Workflows |
Dieser Vorgang ruft die Liste aller Workflows des Benutzers ab. |
| Abrufen einer PDF-Datei des Überwachungspfads des Vertrags |
Mit diesem Vorgang wird der PDF-Dateidatenstrom des Überwachungspfads des Vertrags abgerufen. Beachten Sie, dass der Dateidatenstrom mit einem Dateinamen gespeichert werden soll, der auf .pdf Dateierweiterung endet. |
| Abrufen einer PDF-Datei einer unterzeichneten Vereinbarung |
Mit diesem Vorgang wird der PDF-Dateidatenstrom der kombinierten oder unterzeichneten Vereinbarung abgerufen. Beachten Sie, dass der Dateidatenstrom mit einem Dateinamen gespeichert werden soll, der auf .pdf Dateierweiterung endet. |
| Abrufen einer PDF-Datei einer unterzeichneten Vereinbarung [VERALTET] |
Diese Aktion ist veraltet. Verwenden Sie stattdessen eine PDF-Datei einer signierten Vereinbarung .
|
| Abrufen eines Dokuments aus einer Vereinbarung |
Dieser Vorgang ruft den Dateidatenstrom eines bestimmten Dokuments der Vereinbarung ab. |
| Abrufen eines Dokuments aus einer Vereinbarung [VERALTET] |
Diese Aktion ist veraltet. Verwenden Sie stattdessen ein Dokument aus einer Vereinbarung abrufen.
|
| Abrufen von Formularfelddaten der Vereinbarung (Alt) [VERALTET] |
Ruft Daten ab, die in die interaktiven Formularfelder der Vereinbarung eingegeben wurden. |
| Abrufen von Formularfelddaten der Vereinbarung im CSV-Format |
Ruft Daten ab, die in die interaktiven Formularfelder der Vereinbarung eingegeben wurden. |
| Abrufen von Formularfelddaten der Vereinbarung im JSON-Format |
Ruft Daten ab, die in die interaktiven Formularfelder der Vereinbarung eingegeben wurden. |
| Erstellen einer Bibliotheksvorlage aus einem hochgeladenen Dokument |
Dieser Vorgang erstellt eine Vorlage in der Adobe Acrobat Sign-Bibliothek aus einem hochgeladenen Dokument. Verwenden Sie diese Vorlage zum Senden von Vereinbarungen. |
| Erstellen einer Bibliotheksvorlage aus einem hochgeladenen Dokument (Alt) [VERALTET] |
Dieser Vorgang erstellt eine Vorlage in der Adobe Acrobat Sign-Bibliothek aus einem hochgeladenen Dokument. Verwenden Sie diese Vorlage zum Senden von Vereinbarungen. |
| Erstellen einer Bibliotheksvorlage aus einer Dokument-URL |
Dieser Vorgang erstellt eine Vorlage in der Adobe Acrobat Sign-Bibliothek aus einer Dokument-URL. Verwenden Sie diese Vorlage zum Senden von Vereinbarungen. |
| Erstellen einer Bibliotheksvorlage aus einer Dokument-URL (Alt) [VERALTET] |
Dieser Vorgang erstellt eine Vorlage in der Adobe Acrobat Sign-Bibliothek aus einer Dokument-URL. Verwenden Sie diese Vorlage zum Senden von Vereinbarungen. |
| Erstellen einer Vereinbarung aus einem Dateiinhalt und Senden einer Signatur |
Dieser Vorgang erstellt eine Vereinbarung aus einer Datei in Adobe Acrobat Sign und sendet sie zur Signatur. |
| Erstellen einer Vereinbarung aus einem hochgeladenen Dokument und Senden einer Signatur |
Dieser Vorgang erstellt eine Vereinbarung aus einem Dokument, das in Adobe Acrobat Sign hochgeladen wurde, und sendet es zur Signatur. |
| Erstellen einer Vereinbarung aus einem hochgeladenen Dokument und Senden einer Signatur (alt) [VERALTET] |
Dieser Vorgang erstellt eine Vereinbarung aus einem Dokument, das in Adobe Acrobat Sign hochgeladen wurde, und sendet es zur Signatur. |
| Erstellen einer Vereinbarung aus einem Workflow und Senden einer Signatur |
Dieser Vorgang erstellt eine Vereinbarung aus einem Workflow in Adobe Acrobat Sign und sendet ihn zur Signatur. |
| Erstellen einer Vereinbarung aus einer Bibliotheksvorlage und Senden einer Signatur |
Dieser Vorgang erstellt eine Vereinbarung aus einer Vorlage, die in der Adobe Acrobat Sign-Bibliothek des Benutzers gespeichert ist, und sendet sie zur Signatur. |
| Erstellen einer Vereinbarung aus einer Bibliotheksvorlage und Senden einer Signatur (Alt) [VERALTET] |
Dieser Vorgang erstellt eine Vereinbarung aus einer Vorlage, die in der Adobe Acrobat Sign-Bibliothek des Benutzers gespeichert ist, und sendet sie zur Signatur. |
| Erstellen einer Vereinbarung aus einer Dokument-URL und Senden einer Signatur |
Dieser Vorgang erstellt eine Vereinbarung aus einem Dokument, das in Adobe Acrobat Sign hochgeladen wurde, und sendet es zur Signatur. |
| Erstellen einer Vereinbarung aus einer Dokument-URL und Senden einer Signatur (Alt) [VERALTET] |
Dieser Vorgang erstellt eine Vereinbarung aus einem Dokument, das in Adobe Acrobat Sign hochgeladen wurde, und sendet es zur Signatur. |
| Hochladen eines Dokuments und Abrufen einer Dokument-ID |
Dieser Vorgang lädt ein Dokument in Ihr Adobe Acrobat Sign-Konto hoch und gibt eine Dokument-ID dafür zurück. Dieses Dokument wird vorübergehend in Adobe Acrobat Sign gespeichert, und die Dokument-ID kann für weitere Vorgänge wie das Erstellen einer Vereinbarung verwendet werden. |
| Hochladen eines Dokuments und Abrufen einer Dokument-ID (Alt) [VERALTET] |
Dieser Vorgang lädt ein Dokument in Ihr Adobe Acrobat Sign-Konto hoch und gibt eine Dokument-ID dafür zurück. Dieses Dokument wird vorübergehend in Adobe Acrobat Sign gespeichert, und die Dokument-ID kann für weitere Vorgänge wie das Erstellen einer Vereinbarung verwendet werden. |
| Kündigen einer Vereinbarung |
Bricht die vereinbarung, die durch agreementId im Pfad identifiziert wurde. |
Abrufen der detaillierten Informationen des Workflows
Dieser Vorgang ruft detaillierte Informationen zum Workflow ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Workflow-ID
|
workflowId | True | string |
Die Workflow-ID des Workflows, deren Informationen benötigt werden |
|
Im Namen von
|
x-api-user | string |
Die E-Mail des API-Aufrufers im Format: E-Mail:adobesignuser@domain.com |
|
|
Gruppenname/ID
|
groupId | string |
ID der Gruppe. Um dies zu verwenden – Feld "In The Name Of" muss ausgewählt werden |
Gibt zurück
Ein JSON mit detaillierten Informationen zum Workflow
Abrufen der Signatur-URL
Dieser Vorgang ruft die URL für die E-Signierseite für die aktuellen Signierer einer Vereinbarung ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vereinbarungs-ID
|
agreementId | True | string |
Die Vereinbarungs-ID gemäß der Aktion, die die Vereinbarung erstellt |
|
Im Namen von
|
x-api-user | string |
Die E-Mail des API-Aufrufers im Format: E-Mail:adobesignuser@domain.com |
Gibt zurück
- Body
- SigningUrlResponse
Abrufen der URL der Vereinbarungsansicht
Ruft die neueste Statusansichts-URL der Vereinbarung ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vereinbarungs-ID
|
agreementId | True | string |
Die Vereinbarungs-ID der Vereinbarung, deren Informationen erforderlich sind |
|
Im Namen von
|
x-api-user | string |
Die E-Mail des API-Aufrufers im Format: E-Mail:adobesignuser@domain.com |
|
|
Ansichtsname
|
name | True | string |
Name der angeforderten Vereinbarungsansicht |
|
Auto LogIn
|
autoLoginUser | boolean |
Bei "true" protokolliert die zurückgegebene URL den Benutzer automatisch in |
|
|
Kein Chrome-Flag
|
noChrome | boolean |
Wenn wahr, wird die eingebettete Seite ohne Kopf- oder Fußzeile angezeigt. |
|
|
Übergeordnetes Frame-Element
|
frameParent | string |
durch Trennzeichen getrennte Liste von Domänen-URLs, bei denen die URLs möglicherweise iframed sind |
Gibt zurück
Liste der Vereinbarungsansichten
- Body
- AgreementViews
Abrufen des Status einer Vereinbarung
Dieser Vorgang ruft alle aktuellen Informationen einer Vereinbarung ab, z. B. den Status.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vereinbarungs-ID
|
agreementId | True | string |
Die Vereinbarungs-ID der Vereinbarung, deren Informationen erforderlich sind |
|
Im Namen von
|
x-api-user | string |
Die E-Mail des API-Aufrufers im Format: E-Mail:adobesignuser@domain.com |
Gibt zurück
Vollständige Vereinbarungsdetails
- Body
- AgreementInfoV6
Abrufen des Status einer Vereinbarung [VERALTET]
Diese Aktion ist veraltet. Verwenden Sie stattdessen den Status einer Vereinbarung .
Dieser Vorgang ruft alle aktuellen Informationen einer Vereinbarung ab, z. B. den Status.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vereinbarungs-ID
|
agreementId | True | string |
Die Vereinbarungs-ID der Vereinbarung, deren Informationen erforderlich sind |
Gibt zurück
Die vollständigen Details zur Vereinbarung
- Body
- AgreementInfo
Abrufen einer Liste aller Bibliotheksvorlagen
Mit diesem Vorgang wird die Liste aller Dokumente abgerufen, die als Vorlagen in der Adobe Acrobat Sign-Bibliothek des Benutzers gespeichert sind.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Mauszeiger
|
cursor | string |
Wird verwendet, um durch die Seiten zu navigieren. Wenn nicht angegeben, wird die erste Seite zurückgegeben. |
|
|
Seitenformat
|
pageSize | integer |
Anzahl der Elemente auf der Antwortseite. Standardmäßig: 100; Max: 10000 |
|
|
Im Namen von
|
x-api-user | string |
Die E-Mail des API-Aufrufers im Format: E-Mail:adobesignuser@domain.com |
|
|
Gruppenname/ID
|
groupId | string |
ID der Gruppe. Um dies zu verwenden – Feld "In The Name Of" muss ausgewählt werden |
Gibt zurück
Ein JSON-Objekt, das das Arrayobjekt der Bibliotheksvorlage enthält
- Body
- LibraryDocuments
Abrufen einer Liste aller Bibliotheksvorlagen (Alt) [VERALTET]
Mit diesem Vorgang wird die Liste aller Dokumente abgerufen, die als Vorlagen in der Adobe Acrobat Sign-Bibliothek des Benutzers gespeichert sind.
Gibt zurück
Ein JSON-Objekt, das das Arrayobjekt der Bibliotheksvorlage enthält
- Body
- DocumentLibraryItems
Abrufen einer Liste aller Dokument-IDs aus einer Vereinbarung
Dieser Vorgang ruft die IDs aller Dokumente und unterstützenden Dokumente einer Vereinbarung ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vereinbarungs-ID
|
agreementId | True | string |
Die Vereinbarungs-ID der Vereinbarung, deren Dokumente erforderlich sind |
|
Unterstützende Dokumente – Inhaltstyp
|
supportingDocumentContentFormat | string |
Inhaltstyp der unterstützenden Dokumente des Vertrags |
|
|
Im Namen von
|
x-api-user | string |
Die E-Mail des API-Aufrufers im Format: E-Mail:adobesignuser@domain.com |
Gibt zurück
Ein JSON-Code, der sowohl die Dokumente als auch unterstützende Dokumentarrayobjekte enthält
- Body
- AgreementDocumentsV6
Abrufen einer Liste aller Dokument-IDs aus einer Vereinbarung [VERALTET]
Diese Aktion ist veraltet. Verwenden Sie stattdessen eine Liste aller Dokument-IDs aus einer Vereinbarung .
Dieser Vorgang ruft die IDs aller Dokumente und unterstützenden Dokumente einer Vereinbarung ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vereinbarungs-ID
|
agreementId | True | string |
Die Vereinbarungs-ID der Vereinbarung, deren Dokumente erforderlich sind |
|
Unterstützende Dokumente – Inhaltstyp
|
supportingDocumentContentFormat | string |
Inhaltstyp der unterstützenden Dokumente des Vertrags |
Gibt zurück
Ein JSON-Code, der sowohl die Dokumente als auch unterstützende Dokumentarrayobjekte enthält
- Body
- AgreementDocuments
Abrufen einer Liste aller Gruppen, zu der der Benutzer gehört
Dieser Vorgang ruft die Liste aller Gruppenbenutzer ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Im Namen von
|
x-api-user | string |
Die E-Mail des API-Aufrufers im Format: E-Mail:adobesignuser@domain.com |
|
|
Benutzer-ID
|
userId | True | string |
Um das Ergebnis für autorisierte Benutzer zu erhalten, kann die Benutzer-ID durch "ich" ohne Anführungszeichen ersetzt werden. |
Gibt zurück
Ein JSON-Code, der die Liste der Gruppen für einen bestimmten Benutzer enthält
- Body
- UserGroupsInfoV6
Abrufen einer Liste aller Vereinbarungen
Dieser Vorgang ruft die Liste aller Vereinbarungen des Benutzers ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Mauszeiger
|
cursor | string |
Wird verwendet, um durch die Seiten zu navigieren. Wenn nicht angegeben, wird die erste Seite zurückgegeben. |
|
|
Seitenformat
|
pageSize | integer |
Anzahl der Elemente auf der Antwortseite. Standardmäßig: 100; Max: 10000 |
|
|
Im Namen von
|
x-api-user | string |
Die E-Mail des API-Aufrufers im Format: E-Mail:adobesignuser@domain.com |
|
|
Gruppenname/ID
|
groupId | string |
ID der Gruppe. Um dies zu verwenden – Feld "In The Name Of" muss ausgewählt werden |
Gibt zurück
Ein JSON-Objekt, das das Arrayobjekt der Benutzervereinbarung enthält
- Body
- userAgreementListV6
Abrufen einer Liste aller Vereinbarungen (Alt) [VERALTET]
Dieser Vorgang ruft die Liste aller Vereinbarungen des Benutzers ab.
Gibt zurück
Ein JSON-Objekt, das das Arrayobjekt der Benutzervereinbarung enthält
- Body
- UserAgreements
Abrufen einer Liste aller Vereinbarungen basierend auf Suchkriterien
Bei diesem Vorgang werden Vereinbarungen nach Kriterien wie Workflow-ID usw. durchsucht.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Im Namen von
|
x-api-user | string |
Die E-Mail des API-Aufrufers im Format: E-Mail:adobesignuser@domain.com |
|
|
Gruppenname/ID
|
groupId | string |
ID der Gruppe. Um dies zu verwenden – Feld "In The Name Of" muss ausgewählt werden |
|
|
Workflowname/ID
|
workflowId | string |
Wählen Sie benutzerdefinierten Workflow aus der Liste aus, oder geben Sie die benutzerdefinierte Workflow-ID ein. |
|
|
Erstellt nach
|
gt | string |
Die mindest zulässige Datums-/Uhrzeit. Beispiel: 2020-12-31T23:59:00Z |
|
|
Erstellt vor
|
lt | string |
Die maximal zulässige Datums-/Uhrzeit. Beispiel: 2023-12-31T23:59:00Z |
|
|
Seitenformat
|
pageSize | integer |
Anzahl der Elemente auf der Antwortseite. Standardmäßig: 50; Max: 500 |
|
|
Startindex
|
startIndex | integer |
0-basierte erste Zeile (Offset) der Suchergebnisse, die zurückgegeben werden sollen. |
Gibt zurück
Ein JSON-Objekt, das das Arrayobjekt der Benutzervereinbarung enthält
- Body
- userAgreementListV6
Abrufen einer Liste aller Webformulare
Dieser Vorgang ruft die Liste aller Webformulare des Benutzers ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Mauszeiger
|
cursor | string |
Wird verwendet, um durch die Seiten zu navigieren. Wenn nicht angegeben, wird die erste Seite zurückgegeben. |
|
|
Seitenformat
|
pageSize | integer |
Anzahl der Elemente auf der Antwortseite. Standardmäßig: 100; Max: 10000 |
|
|
Im Namen von
|
x-api-user | string |
Die E-Mail des API-Aufrufers im Format: E-Mail:adobesignuser@domain.com |
|
|
Gruppenname/ID
|
groupId | string |
ID der Gruppe. Um dies zu verwenden – Feld "In The Name Of" muss ausgewählt werden |
Gibt zurück
Ein JSON-Objekt, das das Arrayobjekt des Benutzerwebformulars enthält
- Body
- userWidgetListV6
Abrufen einer Liste aller Workflows
Dieser Vorgang ruft die Liste aller Workflows des Benutzers ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Entwurfsworkflows einschließen
|
includeDraftWorkflows | boolean |
Einfügen von Entwurfsworkflows |
|
|
Inaktive Workflows einschließen
|
includeInactiveWorkflows | boolean |
Inaktive Workflows einschließen |
|
|
Im Namen von
|
x-api-user | string |
Die E-Mail des API-Aufrufers im Format: E-Mail:adobesignuser@domain.com |
|
|
Gruppenname/ID
|
groupId | string |
ID der Gruppe. Um dies zu verwenden – Feld "In The Name Of" muss ausgewählt werden |
Gibt zurück
Ein JSON-Code, der das Objekt des Benutzerworkflowarrays enthält
- Body
- userWorkflowListV6
Abrufen einer PDF-Datei des Überwachungspfads des Vertrags
Mit diesem Vorgang wird der PDF-Dateidatenstrom des Überwachungspfads des Vertrags abgerufen. Beachten Sie, dass der Dateidatenstrom mit einem Dateinamen gespeichert werden soll, der auf .pdf Dateierweiterung endet.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Im Namen von
|
x-api-user | string |
Die E-Mail des API-Aufrufers im Format: E-Mail:adobesignuser@domain.com |
|
|
Vereinbarungs-ID
|
agreementId | True | string |
Die Vereinbarungs-ID der Vereinbarung, deren Informationen erforderlich sind |
Gibt zurück
Der Dateidatenstrom des Überwachungspfads der Vereinbarung
- response
- AgreementAuditTrailResponse
Abrufen einer PDF-Datei einer unterzeichneten Vereinbarung
Mit diesem Vorgang wird der PDF-Dateidatenstrom der kombinierten oder unterzeichneten Vereinbarung abgerufen. Beachten Sie, dass der Dateidatenstrom mit einem Dateinamen gespeichert werden soll, der auf .pdf Dateierweiterung endet.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vereinbarungs-ID
|
agreementId | True | string |
Die Vereinbarungs-ID gemäß der Aktion, die die Vereinbarung erstellt |
|
Unterstützende Dokumente anfügen?
|
attachSupportingDocuments | boolean |
Wenn wahr, fügen Sie unterstützende Dokumente an die PDF-Datei des signierten Vertrags an. |
|
|
Überwachungsbericht anfügen?
|
attachAuditReport | boolean |
Wenn wahr, fügen Sie einen Prüfbericht an die PDF-Datei des signierten Vertrags an. |
|
|
Im Namen von
|
x-api-user | string |
Die E-Mail des API-Aufrufers im Format: E-Mail:adobesignuser@domain.com |
Gibt zurück
Der Dateidatenstrom des Dokuments
- response
- CombinedDocumentResponse
Abrufen einer PDF-Datei einer unterzeichneten Vereinbarung [VERALTET]
Diese Aktion ist veraltet. Verwenden Sie stattdessen eine PDF-Datei einer signierten Vereinbarung .
Mit diesem Vorgang wird der PDF-Dateidatenstrom der kombinierten oder unterzeichneten Vereinbarung abgerufen. Beachten Sie, dass der Dateidatenstrom mit einem Dateinamen gespeichert werden soll, der auf .pdf Dateierweiterung endet.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vereinbarungs-ID
|
agreementId | True | string |
Die Vereinbarungs-ID gemäß der Aktion, die die Vereinbarung erstellt |
|
Unterstützende Dokumente anfügen?
|
attachSupportingDocuments | boolean |
Wenn wahr, fügen Sie unterstützende Dokumente an die PDF-Datei des signierten Vertrags an. |
|
|
Überwachungsbericht anfügen?
|
auditReport | boolean |
Wenn wahr, fügen Sie einen Prüfbericht an die PDF-Datei des signierten Vertrags an. |
Gibt zurück
Der Dateidatenstrom des Dokuments
- response
- CombinedDocumentResponse
Abrufen eines Dokuments aus einer Vereinbarung
Dieser Vorgang ruft den Dateidatenstrom eines bestimmten Dokuments der Vereinbarung ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vereinbarungs-ID
|
agreementId | True | string |
Die Vereinbarungs-ID der Vereinbarung, deren Dokument erforderlich ist |
|
Dokument-ID
|
documentId | True | string |
Die Dokument-ID des spezifischen Dokuments des Vertrags |
|
Im Namen von
|
x-api-user | string |
Die E-Mail des API-Aufrufers im Format: E-Mail:adobesignuser@domain.com |
Gibt zurück
Der Dateidatenstrom des Dokuments
- response
- DocumentResponse
Abrufen eines Dokuments aus einer Vereinbarung [VERALTET]
Diese Aktion ist veraltet. Verwenden Sie stattdessen ein Dokument aus einer Vereinbarung abrufen.
Dieser Vorgang ruft den Dateidatenstrom eines bestimmten Dokuments der Vereinbarung ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vereinbarungs-ID
|
agreementId | True | string |
Die Vereinbarungs-ID der Vereinbarung, deren Dokument erforderlich ist |
|
Dokument-ID
|
documentId | True | string |
Die Dokument-ID des spezifischen Dokuments des Vertrags |
Gibt zurück
Der Dateidatenstrom des Dokuments
- response
- DocumentResponse
Abrufen von Formularfelddaten der Vereinbarung (Alt) [VERALTET]
Ruft Daten ab, die in die interaktiven Formularfelder der Vereinbarung eingegeben wurden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vereinbarungs-ID
|
agreementId | True | string |
Die Vereinbarungs-ID der Vereinbarung, deren Informationen erforderlich sind |
Gibt zurück
- response
- file
Abrufen von Formularfelddaten der Vereinbarung im CSV-Format
Ruft Daten ab, die in die interaktiven Formularfelder der Vereinbarung eingegeben wurden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vereinbarungs-ID
|
agreementId | True | string |
Die Vereinbarungs-ID der Vereinbarung, deren Informationen erforderlich sind |
|
Im Namen von
|
x-api-user | string |
Die E-Mail des API-Aufrufers im Format: E-Mail:adobesignuser@domain.com |
Gibt zurück
Der Inhalt der Formulardaten
- Formulardateninhalt
- binary
Abrufen von Formularfelddaten der Vereinbarung im JSON-Format
Ruft Daten ab, die in die interaktiven Formularfelder der Vereinbarung eingegeben wurden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vereinbarungs-ID
|
agreementId | True | string |
Die Vereinbarungs-ID der Vereinbarung, deren Informationen erforderlich sind |
|
Im Namen von
|
x-api-user | string |
Die E-Mail des API-Aufrufers im Format: E-Mail:adobesignuser@domain.com |
Gibt zurück
Der Inhalt der Formulardaten
- Formulardateninhalt
- object
Erstellen einer Bibliotheksvorlage aus einem hochgeladenen Dokument
Dieser Vorgang erstellt eine Vorlage in der Adobe Acrobat Sign-Bibliothek aus einem hochgeladenen Dokument. Verwenden Sie diese Vorlage zum Senden von Vereinbarungen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Im Namen von
|
x-api-user | string |
Die E-Mail des API-Aufrufers im Format: E-Mail:adobesignuser@domain.com |
|
|
Vorlagenname
|
name | True | string |
Vereinbarungsname, der zum Identifizieren der Vorlage verwendet wird |
|
Vorlagentyp
|
templateTypes | True | array of string |
Eine Liste mit einem oder mehreren Bibliotheksvorlagentypen |
|
Freigabemodus
|
sharingMode | True | string |
Gibt an, wer Zugriff auf dieses Bibliotheksdokument haben soll. |
|
ID
|
transientDocumentId | True | string |
Die Dokument-ID, die durch Hochladen eines vorübergehenden Dokuments empfangen wurde |
|
Vorlagenstatus
|
state | True | string |
Status des Bibliotheksdokuments. |
|
Gruppenname/ID
|
groupId | string |
ID der Gruppe. Um dies zu verwenden – Feld "In The Name Of" muss ausgewählt werden |
Gibt zurück
Ein JSON-Objekt, das die Bibliotheksvorlage beschreibt
Erstellen einer Bibliotheksvorlage aus einem hochgeladenen Dokument (Alt) [VERALTET]
Dieser Vorgang erstellt eine Vorlage in der Adobe Acrobat Sign-Bibliothek aus einem hochgeladenen Dokument. Verwenden Sie diese Vorlage zum Senden von Vereinbarungen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vorlagenname
|
name | True | string |
Vereinbarungsname, der zum Identifizieren der Vorlage verwendet wird |
|
Vorlagentyp
|
libraryTemplateTypes | True | string |
Eine Liste mit einem oder mehreren Bibliotheksvorlagentypen |
|
Freigeben für
|
librarySharingMode | True | string |
Gibt an, wer Zugriff auf dieses Bibliotheksdokument haben soll. |
|
Dokument-ID
|
transientDocumentId | True | string |
Die vom Hochladen eines Dokuments empfangene Dokument-ID |
|
Dokument-ID (2)
|
transientDocumentId | string |
Die vom Hochladen eines Dokuments empfangene Dokument-ID |
|
|
Dokument-ID (3)
|
transientDocumentId | string |
Die vom Hochladen eines Dokuments empfangene Dokument-ID |
|
|
Dokument-ID (4)
|
transientDocumentId | string |
Die vom Hochladen eines Dokuments empfangene Dokument-ID |
|
|
Dokument-ID (5)
|
transientDocumentId | string |
Die vom Hochladen eines Dokuments empfangene Dokument-ID |
|
|
Dokument-ID (6)
|
transientDocumentId | string |
Die vom Hochladen eines Dokuments empfangene Dokument-ID |
|
|
Dokument-ID (7)
|
transientDocumentId | string |
Die vom Hochladen eines Dokuments empfangene Dokument-ID |
|
|
Dokument-ID (8)
|
transientDocumentId | string |
Die vom Hochladen eines Dokuments empfangene Dokument-ID |
|
|
Dokument-ID (9)
|
transientDocumentId | string |
Die vom Hochladen eines Dokuments empfangene Dokument-ID |
|
|
Dokument-ID (10)
|
transientDocumentId | string |
Die vom Hochladen eines Dokuments empfangene Dokument-ID |
Gibt zurück
Ein JSON-Objekt, das die Bibliotheksvorlage beschreibt
Erstellen einer Bibliotheksvorlage aus einer Dokument-URL
Dieser Vorgang erstellt eine Vorlage in der Adobe Acrobat Sign-Bibliothek aus einer Dokument-URL. Verwenden Sie diese Vorlage zum Senden von Vereinbarungen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Im Namen von
|
x-api-user | string |
Die E-Mail des API-Aufrufers im Format: E-Mail:adobesignuser@domain.com |
|
|
Vorlagenname
|
name | True | string |
Vereinbarungsname, der zum Identifizieren der Vorlage verwendet wird |
|
Vorlagentyp
|
templateTypes | True | array of string |
Eine Liste mit einem oder mehreren Bibliotheksvorlagentypen |
|
Freigabemodus
|
sharingMode | True | string |
Gibt an, wer Zugriff auf dieses Bibliotheksdokument haben soll. |
|
URL
|
url | True | string |
Eine öffentlich zugängliche URL zum Abrufen des Rohdateiinhalts |
|
Name
|
name | True | string |
Der ursprüngliche Systemdateiname des gesendeten Dokuments |
|
Typ
|
mimeType | True | string |
Der MIME-Typ der referenzierten Datei, z. B. Anwendung/PDF |
|
Vorlagenstatus
|
state | True | string |
Status des Bibliotheksdokuments. |
|
Gruppenname/ID
|
groupId | string |
ID der Gruppe. Um dies zu verwenden – Feld "In The Name Of" muss ausgewählt werden |
Gibt zurück
Ein JSON-Objekt, das die Bibliotheksvorlage beschreibt
Erstellen einer Bibliotheksvorlage aus einer Dokument-URL (Alt) [VERALTET]
Dieser Vorgang erstellt eine Vorlage in der Adobe Acrobat Sign-Bibliothek aus einer Dokument-URL. Verwenden Sie diese Vorlage zum Senden von Vereinbarungen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vorlagenname
|
name | True | string |
Vereinbarungsname, der zum Identifizieren der Vorlage verwendet wird |
|
Vorlagentyp
|
libraryTemplateTypes | True | string |
Eine Liste mit einem oder mehreren Bibliotheksvorlagentypen |
|
Freigeben für
|
librarySharingMode | True | string |
Gibt an, wer Zugriff auf dieses Bibliotheksdokument haben soll. |
|
URL
|
url | True | string |
Eine öffentlich zugängliche URL zum Abrufen des Dokuments |
|
Name
|
name | True | string |
Der Name des dokuments, auf das verwiesen wird, mit Erweiterung |
|
URL (2)
|
url | string |
Eine öffentlich zugängliche URL zum Abrufen des Dokuments |
|
|
Name (2)
|
name | string |
Der Name des dokuments, auf das verwiesen wird, mit Erweiterung |
|
|
URL (3)
|
url | string |
Eine öffentlich zugängliche URL zum Abrufen des Dokuments |
|
|
Name (3)
|
name | string |
Der Name des dokuments, auf das verwiesen wird, mit Erweiterung |
|
|
URL (4)
|
url | string |
Eine öffentlich zugängliche URL zum Abrufen des Dokuments |
|
|
Name (4)
|
name | string |
Der Name des dokuments, auf das verwiesen wird, mit Erweiterung |
|
|
URL (5)
|
url | string |
Eine öffentlich zugängliche URL zum Abrufen des Dokuments |
|
|
Name (5)
|
name | string |
Der Name des dokuments, auf das verwiesen wird, mit Erweiterung |
|
|
URL (6)
|
url | string |
Eine öffentlich zugängliche URL zum Abrufen des Dokuments |
|
|
Name (6)
|
name | string |
Der Name des dokuments, auf das verwiesen wird, mit Erweiterung |
|
|
URL (7)
|
url | string |
Eine öffentlich zugängliche URL zum Abrufen des Dokuments |
|
|
Name (7)
|
name | string |
Der Name des dokuments, auf das verwiesen wird, mit Erweiterung |
|
|
URL (8)
|
url | string |
Eine öffentlich zugängliche URL zum Abrufen des Dokuments |
|
|
Name (8)
|
name | string |
Der Name des dokuments, auf das verwiesen wird, mit Erweiterung |
|
|
URL (9)
|
url | string |
Eine öffentlich zugängliche URL zum Abrufen des Dokuments |
|
|
Name (9)
|
name | string |
Der Name des dokuments, auf das verwiesen wird, mit Erweiterung |
|
|
URL (10)
|
url | string |
Eine öffentlich zugängliche URL zum Abrufen des Dokuments |
|
|
Name (10)
|
name | string |
Der Name des dokuments, auf das verwiesen wird, mit Erweiterung |
Gibt zurück
Ein JSON-Objekt, das die Bibliotheksvorlage beschreibt
Erstellen einer Vereinbarung aus einem Dateiinhalt und Senden einer Signatur
Dieser Vorgang erstellt eine Vereinbarung aus einer Datei in Adobe Acrobat Sign und sendet sie zur Signatur.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Im Namen von
|
x-api-user | string |
Die E-Mail des API-Aufrufers im Format: E-Mail:adobesignuser@domain.com |
|
|
Vertragsname
|
name | True | string |
Der Name der Vereinbarung |
|
Name
|
fileName | True | string |
Der Name des dokuments, das hochgeladen werden soll, mit Erweiterung |
|
Content
|
formData | True | byte |
Der Dateidatenstrom des Dokuments, der hochgeladen werden soll |
|
Signaturtyp
|
signatureType | True | string |
Der Signaturtyp, den Sie anfordern möchten – E-Signatur oder schriftlich |
|
Email
|
True | string |
Die E-Mail des Teilnehmers |
|
|
Authentifizierung
|
authenticationMethod | string |
Standardauthentifizierung: E-Mail (Keine) |
|
|
Kennwort
|
password | string |
Das für den Teilnehmer erforderliche Kennwort |
|
|
Ländercode
|
countryCode | string |
Telefonlandcode des Empfängers, der zum Anzeigen und Signieren des Dokuments erforderlich ist |
|
|
Telefon Nr.
|
phone | string |
Die Telefonnummer des Empfängers, die zum Anzeigen und Signieren der Vereinbarung erforderlich ist |
|
|
Anbieter-ID
|
providerId | string |
Id des Anbieters des digitalen Identitätsgateways. |
|
|
Bestellung
|
order | True | integer |
Index beginnend mit 1, der die Position angibt, an der sich die Signiergruppe signieren muss. |
|
Rolle
|
role | True | string |
Die aktuellen Rollen des Teilnehmersatzes (Signierer, Genehmigender usw.). |
|
Gruppenname/ID
|
groupId | string |
ID der Gruppe. Um dies zu verwenden – Feld "In The Name Of" muss ausgewählt werden |
|
|
Nachricht
|
message | string |
Eine optionale Nachricht an die Empfänger, die ihre Aktion anfordern |
|
|
Sendetyp
|
sendType | string |
Die Art der Erfahrung, die vom Absender verwendet wird, um eine Vereinbarung zu senden |
|
|
Email
|
string |
Die E-Mail des CC des Vertrags |
||
|
Ablaufzeit
|
expirationTime | string |
Zeitpunkt, zu dem die Vereinbarung abläuft. Beispiel: 2020-12-31T23:59:00Z |
|
|
Externe ID
|
externalId | string |
Ein beliebiger Wert aus Ihrem System |
|
|
Erinnerungshäufigkeit
|
reminderFrequency | string |
Wie oft möchten Sie Erinnerungen senden? |
|
|
Dokumentkennwort
|
openPassword | string |
Das Kennwort, das zum Verschlüsseln der PDF-Datei des signierten Vertrags verwendet werden soll |
|
|
Name
|
fieldName | string |
Der Name des Felds |
|
|
Wert
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Umleitungsverzögerung
|
redirectDelay | string |
Die Verzögerung (in Sekunden), bevor der Benutzer zur Erfolgsseite weitergeleitet wird. |
|
|
Umleitungs-URL
|
redirectUrl | string |
URL, die nach Abschluss des Signaturvorgangs umgeleitet werden soll, z. B. https://adobe.com |
|
|
Anfängliche E-Mails
|
initEmails | string |
Steuern von Benachrichtigungsmails für Vereinbarungsinitiierungsereignisse. |
|
|
Staat
|
state | True | string |
Der Staat, in dem das Abkommen landen sollte. |
Gibt zurück
Ein JSON-Code, der die ID der neu erstellten Vereinbarung enthält
Erstellen einer Vereinbarung aus einem hochgeladenen Dokument und Senden einer Signatur
Dieser Vorgang erstellt eine Vereinbarung aus einem Dokument, das in Adobe Acrobat Sign hochgeladen wurde, und sendet es zur Signatur.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Im Namen von
|
x-api-user | string |
Die E-Mail des API-Aufrufers im Format: E-Mail:adobesignuser@domain.com |
|
|
Vertragsname
|
name | True | string |
Der Name der Vereinbarung |
|
ID
|
transientDocumentId | True | string |
Die Dokument-ID, die durch Hochladen eines vorübergehenden Dokuments empfangen wurde |
|
Signaturtyp
|
signatureType | True | string |
Der Signaturtyp, den Sie anfordern möchten – E-Signatur oder schriftlich |
|
Email
|
True | string |
Die E-Mail des Teilnehmers |
|
|
Authentifizierung
|
authenticationMethod | string |
Standardauthentifizierung: E-Mail (Keine) |
|
|
Kennwort
|
password | string |
Das für den Teilnehmer erforderliche Kennwort |
|
|
Ländercode
|
countryCode | string |
Telefonlandcode des Empfängers, der zum Anzeigen und Signieren des Dokuments erforderlich ist |
|
|
Telefon Nr.
|
phone | string |
Die Telefonnummer des Empfängers, die zum Anzeigen und Signieren der Vereinbarung erforderlich ist |
|
|
Anbieter-ID
|
providerId | string |
Id des Anbieters des digitalen Identitätsgateways. |
|
|
Bestellung
|
order | True | integer |
Index beginnend mit 1, der die Position angibt, an der sich die Signiergruppe signieren muss. |
|
Rolle
|
role | True | string |
Die aktuellen Rollen des Teilnehmersatzes (Signierer, Genehmigender usw.). |
|
Gruppenname/ID
|
groupId | string |
ID der Gruppe. Um dies zu verwenden – Feld "In The Name Of" muss ausgewählt werden |
|
|
Nachricht
|
message | string |
Eine optionale Nachricht an die Empfänger, die ihre Aktion anfordern |
|
|
Sendetyp
|
sendType | string |
Die Art der Erfahrung, die vom Absender verwendet wird, um eine Vereinbarung zu senden |
|
|
Email
|
string |
Die E-Mail des CC des Vertrags |
||
|
Ablaufzeit
|
expirationTime | string |
Zeitpunkt, zu dem die Vereinbarung abläuft. Beispiel: 2020-12-31T23:59:00Z |
|
|
Externe ID
|
externalId | string |
Ein beliebiger Wert aus Ihrem System |
|
|
Erinnerungshäufigkeit
|
reminderFrequency | string |
Wie oft möchten Sie Erinnerungen senden? |
|
|
Dokumentkennwort
|
openPassword | string |
Das Kennwort, das zum Verschlüsseln der PDF-Datei des signierten Vertrags verwendet werden soll |
|
|
Name
|
fieldName | string |
Der Name des Felds |
|
|
Wert
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Umleitungsverzögerung
|
redirectDelay | string |
Die Verzögerung (in Sekunden), bevor der Benutzer zur Erfolgsseite weitergeleitet wird. |
|
|
Umleitungs-URL
|
redirectUrl | string |
URL, die nach Abschluss des Signaturvorgangs umgeleitet werden soll, z. B. https://adobe.com |
|
|
Anfängliche E-Mails
|
initEmails | string |
Steuern von Benachrichtigungsmails für Vereinbarungsinitiierungsereignisse. |
|
|
Staat
|
state | True | string |
Der Staat, in dem das Abkommen landen sollte. |
Gibt zurück
Ein JSON-Code, der die ID der neu erstellten Vereinbarung enthält
Erstellen einer Vereinbarung aus einem hochgeladenen Dokument und Senden einer Signatur (alt) [VERALTET]
Dieser Vorgang erstellt eine Vereinbarung aus einem Dokument, das in Adobe Acrobat Sign hochgeladen wurde, und sendet es zur Signatur.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vertragsname
|
name | True | string |
Der Name der Vereinbarung |
|
Dokument-ID
|
transientDocumentId | True | string |
Die vom Hochladen eines Dokuments empfangene Dokument-ID |
|
Signaturtyp
|
signatureType | True | string |
Der Signaturtyp, den Sie anfordern möchten – E-Signatur oder schriftlich |
|
Empfänger-E-Mail
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignierreihenfolge
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Nachricht
|
message | string |
Eine optionale Nachricht an die Empfänger, die ihre Aktion anfordern |
|
|
Tage bis Stichtag
|
daysUntilSigningDeadline | integer |
Die Anzahl der Tage, die vor Ablauf des Dokuments verbleiben |
|
|
Erinnerungshäufigkeit
|
reminderFrequency | string |
Wie oft möchten Sie Erinnerungen senden? |
|
|
Dokumentkennwort
|
openPassword | string |
Das Kennwort, das zum Verschlüsseln der PDF-Datei des signierten Vertrags verwendet werden soll |
|
|
Dokument-ID (2)
|
transientDocumentId | string |
Die vom Hochladen eines Dokuments empfangene Dokument-ID |
|
|
Dokument-ID (3)
|
transientDocumentId | string |
Die vom Hochladen eines Dokuments empfangene Dokument-ID |
|
|
Dokument-ID (4)
|
transientDocumentId | string |
Die vom Hochladen eines Dokuments empfangene Dokument-ID |
|
|
Dokument-ID (5)
|
transientDocumentId | string |
Die vom Hochladen eines Dokuments empfangene Dokument-ID |
|
|
Dokument-ID (6)
|
transientDocumentId | string |
Die vom Hochladen eines Dokuments empfangene Dokument-ID |
|
|
Dokument-ID (7)
|
transientDocumentId | string |
Die vom Hochladen eines Dokuments empfangene Dokument-ID |
|
|
Dokument-ID (8)
|
transientDocumentId | string |
Die vom Hochladen eines Dokuments empfangene Dokument-ID |
|
|
Dokument-ID (9)
|
transientDocumentId | string |
Die vom Hochladen eines Dokuments empfangene Dokument-ID |
|
|
Dokument-ID (10)
|
transientDocumentId | string |
Die vom Hochladen eines Dokuments empfangene Dokument-ID |
|
|
Empfänger-E-Mail (2)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignierreihenfolge (2)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (2)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (3)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignierreihenfolge (3)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (3)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (4)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (4)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (4)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (5)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (5)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (5)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (6)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignierreihenfolge (6)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (6)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (7)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (7)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (7)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (8)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (8)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (8)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (9)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignierreihenfolge (9)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (9)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (10)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (10)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (10)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (11)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignierreihenfolge (11)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (11)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (12)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (12)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (12)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (13)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (13)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (13)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (14)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (14)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (14)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (15)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (15)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (15)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (16)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignierreihenfolge (16)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (16)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (17)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (17)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (17)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (18)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (18)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (18)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (19)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturauftrag (19)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (19)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (20)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignierreihenfolge (20)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (20)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (21)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturauftrag (21)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (21)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (22)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (22)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (22)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (23)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (23)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (23)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (24)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (24)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (24)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
E-Mail-Adresse des Empfängers (25)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (25)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (25)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Formularfeldname (1)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (1)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (2)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (2)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (3)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (3)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (4)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (4)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (5)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (5)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (6)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (6)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (7)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (7)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (8)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (8)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (9)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (9)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (10)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (10)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (11)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (11)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (12)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (12)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (13)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (13)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (14)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (14)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (15)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (15)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (16)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (16)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (17)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (17)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (18)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (18)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (19)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (19)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (20)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (20)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (21)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (21)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (22)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (22)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (23)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (23)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (24)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (24)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (25)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (25)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (26)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (26)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (27)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (27)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (28)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (28)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (29)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (29)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (30)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (30)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (31)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (31)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (32)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (32)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (33)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (33)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (34)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (34)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (35)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (35)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (36)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (36)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (37)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (37)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (38)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (38)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (39)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (39)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (40)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (40)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (41)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (41)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (42)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (42)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (43)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (43)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (44)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (44)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (45)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (45)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (46)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (46)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (47)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (47)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (48)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (48)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (49)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (49)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (50)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (50)
|
defaultValue | string |
Der Standardwert des Felds |
Gibt zurück
Ein JSON-Code, der die ID der neu erstellten Vereinbarung enthält
Erstellen einer Vereinbarung aus einem Workflow und Senden einer Signatur
Dieser Vorgang erstellt eine Vereinbarung aus einem Workflow in Adobe Acrobat Sign und sendet ihn zur Signatur.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Im Namen von
|
x-api-user | True | string |
Die E-Mail des API-Aufrufers im Format: E-Mail:adobesignuser@domain.com |
|
Gruppenname/ID
|
groupId | True | string |
ID der Gruppe. Um dies zu verwenden – Feld "In The Name Of" muss ausgewählt werden |
|
Workflowname/ID
|
workflowIdParam | True | string |
Wählen Sie benutzerdefinierten Workflow aus der Liste aus, oder geben Sie die benutzerdefinierte Workflow-ID ein. |
|
agreementWorkflowSchema
|
agreementWorkflowSchema | True | dynamic |
Details für das ausgewählte Ereignis. |
Gibt zurück
Ein JSON-Code, der die ID der neu erstellten Vereinbarung enthält
Erstellen einer Vereinbarung aus einer Bibliotheksvorlage und Senden einer Signatur
Dieser Vorgang erstellt eine Vereinbarung aus einer Vorlage, die in der Adobe Acrobat Sign-Bibliothek des Benutzers gespeichert ist, und sendet sie zur Signatur.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Im Namen von
|
x-api-user | string |
Die E-Mail des API-Aufrufers im Format: E-Mail:adobesignuser@domain.com |
|
|
Vertragsname
|
name | True | string |
Der Name der Vereinbarung |
|
Template
|
libraryDocumentId | True | string |
Auswählen eines Dokuments aus den in Ihrer Bibliothek gespeicherten Vorlagen |
|
Signaturtyp
|
signatureType | True | string |
Der Signaturtyp, den Sie anfordern möchten – E-Signatur oder schriftlich |
|
Email
|
True | string |
Die E-Mail des Teilnehmers |
|
|
Authentifizierung
|
authenticationMethod | string |
Standardauthentifizierung: E-Mail (Keine) |
|
|
Kennwort
|
password | string |
Das für den Teilnehmer erforderliche Kennwort |
|
|
Ländercode
|
countryCode | string |
Telefonlandcode des Empfängers, der zum Anzeigen und Signieren des Dokuments erforderlich ist |
|
|
Telefon Nr.
|
phone | string |
Die Telefonnummer des Empfängers, die zum Anzeigen und Signieren der Vereinbarung erforderlich ist |
|
|
Anbieter-ID
|
providerId | string |
Id des Anbieters des digitalen Identitätsgateways. |
|
|
Bestellung
|
order | True | integer |
Index beginnend mit 1, der die Position angibt, an der sich die Signiergruppe signieren muss. |
|
Rolle
|
role | True | string |
Die aktuellen Rollen des Teilnehmersatzes (Signierer, Genehmigender usw.). |
|
Gruppenname/ID
|
groupId | string |
ID der Gruppe. Um dies zu verwenden – Feld "In The Name Of" muss ausgewählt werden |
|
|
Nachricht
|
message | string |
Eine optionale Nachricht an die Empfänger, die ihre Aktion anfordern |
|
|
Sendetyp
|
sendType | string |
Die Art der Erfahrung, die vom Absender verwendet wird, um eine Vereinbarung zu senden |
|
|
Email
|
string |
Die E-Mail des CC des Vertrags |
||
|
Ablaufzeit
|
expirationTime | string |
Zeitpunkt, zu dem die Vereinbarung abläuft. Beispiel: 2020-12-31T23:59:00Z |
|
|
Externe ID
|
externalId | string |
Ein beliebiger Wert aus Ihrem System |
|
|
Erinnerungshäufigkeit
|
reminderFrequency | string |
Wie oft möchten Sie Erinnerungen senden? |
|
|
Dokumentkennwort
|
openPassword | string |
Das Kennwort, das zum Verschlüsseln der PDF-Datei des signierten Vertrags verwendet werden soll |
|
|
Name
|
fieldName | string |
Der Name des Felds |
|
|
Wert
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Umleitungsverzögerung
|
redirectDelay | string |
Die Verzögerung (in Sekunden), bevor der Benutzer zur Erfolgsseite weitergeleitet wird. |
|
|
Umleitungs-URL
|
redirectUrl | string |
URL, die nach Abschluss des Signaturvorgangs umgeleitet werden soll, z. B. https://adobe.com |
|
|
Anfängliche E-Mails
|
initEmails | string |
Steuern von Benachrichtigungsmails für Vereinbarungsinitiierungsereignisse. |
|
|
Staat
|
state | True | string |
Der Staat, in dem das Abkommen landen sollte. |
Gibt zurück
Ein JSON-Code, der die ID der neu erstellten Vereinbarung enthält
Erstellen einer Vereinbarung aus einer Bibliotheksvorlage und Senden einer Signatur (Alt) [VERALTET]
Dieser Vorgang erstellt eine Vereinbarung aus einer Vorlage, die in der Adobe Acrobat Sign-Bibliothek des Benutzers gespeichert ist, und sendet sie zur Signatur.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vertragsname
|
name | True | string |
Der Name der Vereinbarung |
|
Dokumentbibliotheksvorlage
|
libraryDocumentId | True | string |
Auswählen eines Dokuments aus den in Ihrer Bibliothek gespeicherten Vorlagen |
|
Signaturtyp
|
signatureType | True | string |
Der Signaturtyp, den Sie anfordern möchten – E-Signatur oder schriftlich |
|
Empfänger-E-Mail
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignierreihenfolge
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Nachricht
|
message | string |
Eine optionale Nachricht an die Empfänger, die ihre Aktion anfordern |
|
|
Tage bis Stichtag
|
daysUntilSigningDeadline | integer |
Die Anzahl der Tage, die vor Ablauf des Dokuments verbleiben |
|
|
Erinnerungshäufigkeit
|
reminderFrequency | string |
Wie oft möchten Sie Erinnerungen senden? |
|
|
Dokumentkennwort
|
openPassword | string |
Das Kennwort, das zum Verschlüsseln der PDF-Datei des signierten Vertrags verwendet werden soll |
|
|
Dokumentbibliotheksvorlage (2)
|
libraryDocumentId | string |
Auswählen eines Dokuments aus den in Ihrer Bibliothek gespeicherten Vorlagen |
|
|
Dokumentbibliotheksvorlage (3)
|
libraryDocumentId | string |
Auswählen eines Dokuments aus den in Ihrer Bibliothek gespeicherten Vorlagen |
|
|
Dokumentbibliotheksvorlage (4)
|
libraryDocumentId | string |
Auswählen eines Dokuments aus den in Ihrer Bibliothek gespeicherten Vorlagen |
|
|
Dokumentbibliotheksvorlage (5)
|
libraryDocumentId | string |
Auswählen eines Dokuments aus den in Ihrer Bibliothek gespeicherten Vorlagen |
|
|
Dokumentbibliotheksvorlage (6)
|
libraryDocumentId | string |
Auswählen eines Dokuments aus den in Ihrer Bibliothek gespeicherten Vorlagen |
|
|
Dokumentbibliotheksvorlage (7)
|
libraryDocumentId | string |
Auswählen eines Dokuments aus den in Ihrer Bibliothek gespeicherten Vorlagen |
|
|
Dokumentbibliotheksvorlage (8)
|
libraryDocumentId | string |
Auswählen eines Dokuments aus den in Ihrer Bibliothek gespeicherten Vorlagen |
|
|
Dokumentbibliotheksvorlage (9)
|
libraryDocumentId | string |
Auswählen eines Dokuments aus den in Ihrer Bibliothek gespeicherten Vorlagen |
|
|
Dokumentbibliotheksvorlage (10)
|
libraryDocumentId | string |
Auswählen eines Dokuments aus den in Ihrer Bibliothek gespeicherten Vorlagen |
|
|
Empfänger-E-Mail (2)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignierreihenfolge (2)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (2)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (3)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignierreihenfolge (3)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (3)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (4)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (4)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (4)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (5)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (5)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (5)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (6)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignierreihenfolge (6)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (6)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (7)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (7)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (7)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (8)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (8)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (8)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (9)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignierreihenfolge (9)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (9)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (10)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (10)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (10)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (11)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignierreihenfolge (11)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (11)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (12)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (12)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (12)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (13)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (13)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (13)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (14)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (14)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (14)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (15)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (15)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (15)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (16)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignierreihenfolge (16)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (16)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (17)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (17)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (17)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (18)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (18)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (18)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (19)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturauftrag (19)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (19)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (20)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignierreihenfolge (20)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (20)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (21)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturauftrag (21)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (21)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (22)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (22)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (22)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (23)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (23)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (23)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (24)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (24)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (24)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
E-Mail-Adresse des Empfängers (25)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (25)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (25)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Formularfeldname (1)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (1)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (2)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (2)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (3)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (3)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (4)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (4)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (5)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (5)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (6)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (6)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (7)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (7)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (8)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (8)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (9)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (9)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (10)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (10)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (11)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (11)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (12)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (12)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (13)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (13)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (14)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (14)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (15)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (15)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (16)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (16)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (17)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (17)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (18)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (18)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (19)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (19)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (20)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (20)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (21)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (21)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (22)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (22)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (23)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (23)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (24)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (24)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (25)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (25)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (26)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (26)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (27)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (27)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (28)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (28)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (29)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (29)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (30)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (30)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (31)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (31)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (32)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (32)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (33)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (33)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (34)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (34)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (35)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (35)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (36)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (36)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (37)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (37)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (38)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (38)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (39)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (39)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (40)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (40)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (41)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (41)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (42)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (42)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (43)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (43)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (44)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (44)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (45)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (45)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (46)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (46)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (47)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (47)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (48)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (48)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (49)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (49)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (50)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (50)
|
defaultValue | string |
Der Standardwert des Felds |
Gibt zurück
Ein JSON-Code, der die ID der neu erstellten Vereinbarung enthält
Erstellen einer Vereinbarung aus einer Dokument-URL und Senden einer Signatur
Dieser Vorgang erstellt eine Vereinbarung aus einem Dokument, das in Adobe Acrobat Sign hochgeladen wurde, und sendet es zur Signatur.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Im Namen von
|
x-api-user | string |
Die E-Mail des API-Aufrufers im Format: E-Mail:adobesignuser@domain.com |
|
|
Vertragsname
|
name | True | string |
Der Name der Vereinbarung |
|
URL
|
url | True | string |
Eine öffentlich zugängliche URL zum Abrufen des Rohdateiinhalts |
|
Name
|
name | True | string |
Der ursprüngliche Systemdateiname des gesendeten Dokuments |
|
Typ
|
mimeType | True | string |
Der MIME-Typ der referenzierten Datei, z. B. Anwendung/PDF |
|
Signaturtyp
|
signatureType | True | string |
Gibt den angeforderten Signaturtyp an – E-Signatur oder geschrieben |
|
Email
|
True | string |
Die E-Mail des Teilnehmers |
|
|
Authentifizierung
|
authenticationMethod | string |
Standardauthentifizierung: E-Mail (Keine) |
|
|
Kennwort
|
password | string |
Das für den Teilnehmer erforderliche Kennwort |
|
|
Ländercode
|
countryCode | string |
Telefonlandcode des Empfängers, der zum Anzeigen und Signieren des Dokuments erforderlich ist |
|
|
Telefon Nr.
|
phone | string |
Die Telefonnummer des Empfängers, die zum Anzeigen und Signieren der Vereinbarung erforderlich ist |
|
|
Anbieter-ID
|
providerId | string |
Id des Anbieters des digitalen Identitätsgateways. |
|
|
Bestellung
|
order | True | integer |
Index beginnend mit 1, der die Position angibt, an der sich die Signiergruppe signieren muss. |
|
Rolle
|
role | True | string |
Die aktuellen Rollen des Teilnehmersatzes (Signierer, Genehmigender usw.). |
|
Gruppenname/ID
|
groupId | string |
ID der Gruppe. Um dies zu verwenden – Feld "In The Name Of" muss ausgewählt werden |
|
|
Nachricht
|
message | string |
Eine optionale Nachricht an die Empfänger, die ihre Aktion anfordern |
|
|
Sendetyp
|
sendType | string |
Die Art der Erfahrung, die vom Absender verwendet wird, um eine Vereinbarung zu senden |
|
|
Email
|
string |
Die E-Mail des CC des Vertrags |
||
|
Ablaufzeit
|
expirationTime | string |
Zeitpunkt, zu dem die Vereinbarung abläuft. Beispiel: 2020-12-31T23:59:00Z |
|
|
Externe ID
|
externalId | string |
Ein beliebiger Wert aus Ihrem System |
|
|
Erinnerungshäufigkeit
|
reminderFrequency | string |
Wie oft möchten Sie Erinnerungen senden? |
|
|
Dokumentkennwort
|
openPassword | string |
Das Kennwort, das zum Verschlüsseln der PDF-Datei des signierten Vertrags verwendet werden soll |
|
|
Name
|
fieldName | string |
Der Name des Felds |
|
|
Wert
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Umleitungsverzögerung
|
redirectDelay | string |
Die Verzögerung (in Sekunden), bevor der Benutzer zur Erfolgsseite weitergeleitet wird. |
|
|
Umleitungs-URL
|
redirectUrl | string |
URL, die nach Abschluss des Signaturvorgangs umgeleitet werden soll, z. B. https://adobe.com |
|
|
Anfängliche E-Mails
|
initEmails | string |
Steuern von Benachrichtigungsmails für Vereinbarungsinitiierungsereignisse. |
|
|
Staat
|
state | True | string |
Der Staat, in dem das Abkommen landen sollte. |
Gibt zurück
Ein JSON-Code, der die ID der neu erstellten Vereinbarung enthält
Erstellen einer Vereinbarung aus einer Dokument-URL und Senden einer Signatur (Alt) [VERALTET]
Dieser Vorgang erstellt eine Vereinbarung aus einem Dokument, das in Adobe Acrobat Sign hochgeladen wurde, und sendet es zur Signatur.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vertragsname
|
name | True | string |
Der Name der Vereinbarung |
|
URL
|
url | True | string |
Eine öffentlich zugängliche URL zum Abrufen des Dokuments |
|
Name
|
name | True | string |
Der Name des dokuments, auf das verwiesen wird, mit Erweiterung |
|
Signaturtyp
|
signatureType | True | string |
Der Signaturtyp, den Sie anfordern möchten – E-Signatur oder schriftlich |
|
Empfänger-E-Mail
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignierreihenfolge
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Nachricht
|
message | string |
Eine optionale Nachricht an die Empfänger, die ihre Aktion anfordern |
|
|
Tage bis Stichtag
|
daysUntilSigningDeadline | integer |
Die Anzahl der Tage, die vor Ablauf des Dokuments verbleiben |
|
|
Erinnerungshäufigkeit
|
reminderFrequency | string |
Wie oft möchten Sie Erinnerungen senden? |
|
|
Dokumentkennwort
|
openPassword | string |
Das Kennwort, das zum Verschlüsseln der PDF-Datei des signierten Vertrags verwendet werden soll |
|
|
URL (2)
|
url | string |
Eine öffentlich zugängliche URL zum Abrufen des Dokuments |
|
|
Name (2)
|
name | string |
Der Name des dokuments, auf das verwiesen wird, mit Erweiterung |
|
|
URL (3)
|
url | string |
Eine öffentlich zugängliche URL zum Abrufen des Dokuments |
|
|
Name (3)
|
name | string |
Der Name des dokuments, auf das verwiesen wird, mit Erweiterung |
|
|
URL (4)
|
url | string |
Eine öffentlich zugängliche URL zum Abrufen des Dokuments |
|
|
Name (4)
|
name | string |
Der Name des dokuments, auf das verwiesen wird, mit Erweiterung |
|
|
URL (5)
|
url | string |
Eine öffentlich zugängliche URL zum Abrufen des Dokuments |
|
|
Name (5)
|
name | string |
Der Name des dokuments, auf das verwiesen wird, mit Erweiterung |
|
|
URL (6)
|
url | string |
Eine öffentlich zugängliche URL zum Abrufen des Dokuments |
|
|
Name (6)
|
name | string |
Der Name des dokuments, auf das verwiesen wird, mit Erweiterung |
|
|
URL (7)
|
url | string |
Eine öffentlich zugängliche URL zum Abrufen des Dokuments |
|
|
Name (7)
|
name | string |
Der Name des dokuments, auf das verwiesen wird, mit Erweiterung |
|
|
URL (8)
|
url | string |
Eine öffentlich zugängliche URL zum Abrufen des Dokuments |
|
|
Name (8)
|
name | string |
Der Name des dokuments, auf das verwiesen wird, mit Erweiterung |
|
|
URL (9)
|
url | string |
Eine öffentlich zugängliche URL zum Abrufen des Dokuments |
|
|
Name (9)
|
name | string |
Der Name des dokuments, auf das verwiesen wird, mit Erweiterung |
|
|
URL (10)
|
url | string |
Eine öffentlich zugängliche URL zum Abrufen des Dokuments |
|
|
Name (10)
|
name | string |
Der Name des dokuments, auf das verwiesen wird, mit Erweiterung |
|
|
Empfänger-E-Mail (2)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignierreihenfolge (2)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (2)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (3)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignierreihenfolge (3)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (3)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (4)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (4)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (4)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (5)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (5)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (5)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (6)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignierreihenfolge (6)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (6)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (7)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (7)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (7)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (8)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (8)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (8)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (9)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignierreihenfolge (9)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (9)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (10)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (10)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (10)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (11)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignierreihenfolge (11)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (11)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (12)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (12)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (12)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (13)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (13)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (13)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (14)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (14)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (14)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (15)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (15)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (15)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (16)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignierreihenfolge (16)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (16)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (17)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (17)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (17)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (18)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (18)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (18)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (19)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturauftrag (19)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (19)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (20)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignierreihenfolge (20)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (20)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (21)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturauftrag (21)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (21)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (22)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (22)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (22)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (23)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (23)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (23)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Empfänger-E-Mail (24)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (24)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (24)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
E-Mail-Adresse des Empfängers (25)
|
True | string |
E-Mail des Empfängers |
|
|
Empfängersignaturreihenfolge (25)
|
signingOrder | True | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Empfängerrolle (25)
|
recipientSetRole | True | string |
Angeben der Rolle des Empfängers |
|
Formularfeldname (1)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (1)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (2)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (2)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (3)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (3)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (4)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (4)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (5)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (5)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (6)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (6)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (7)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (7)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (8)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (8)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (9)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (9)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (10)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (10)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (11)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (11)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (12)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (12)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (13)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (13)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (14)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (14)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (15)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (15)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (16)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (16)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (17)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (17)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (18)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (18)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (19)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (19)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (20)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (20)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (21)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (21)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (22)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (22)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (23)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (23)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (24)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (24)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (25)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (25)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (26)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (26)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (27)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (27)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (28)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (28)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (29)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (29)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (30)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (30)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (31)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (31)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (32)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (32)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (33)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (33)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (34)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (34)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (35)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (35)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (36)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (36)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (37)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (37)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (38)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (38)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (39)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (39)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (40)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (40)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (41)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (41)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (42)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (42)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (43)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (43)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (44)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (44)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (45)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (45)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (46)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (46)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (47)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (47)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (48)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (48)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (49)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (49)
|
defaultValue | string |
Der Standardwert des Felds |
|
|
Formularfeldname (50)
|
fieldName | string |
Der Name des Felds |
|
|
Formularfeldwert (50)
|
defaultValue | string |
Der Standardwert des Felds |
Gibt zurück
Ein JSON-Code, der die ID der neu erstellten Vereinbarung enthält
Hochladen eines Dokuments und Abrufen einer Dokument-ID
Dieser Vorgang lädt ein Dokument in Ihr Adobe Acrobat Sign-Konto hoch und gibt eine Dokument-ID dafür zurück. Dieses Dokument wird vorübergehend in Adobe Acrobat Sign gespeichert, und die Dokument-ID kann für weitere Vorgänge wie das Erstellen einer Vereinbarung verwendet werden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dateiname
|
File-Name | True | string |
Der Name des dokuments, das hochgeladen werden soll, mit Erweiterung |
|
Inhalt der Datei
|
File | True | contentOnly |
Der Dateidatenstrom des Dokuments, der hochgeladen werden soll |
|
Im Namen von
|
x-api-user | string |
Die E-Mail des API-Aufrufers im Format: E-Mail:adobesignuser@domain.com |
Gibt zurück
Ein JSON-Code, der die ID des hochgeladenen Dokuments enthält
Hochladen eines Dokuments und Abrufen einer Dokument-ID (Alt) [VERALTET]
Dieser Vorgang lädt ein Dokument in Ihr Adobe Acrobat Sign-Konto hoch und gibt eine Dokument-ID dafür zurück. Dieses Dokument wird vorübergehend in Adobe Acrobat Sign gespeichert, und die Dokument-ID kann für weitere Vorgänge wie das Erstellen einer Vereinbarung verwendet werden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dateiname
|
File-Name | True | string |
Der Name des dokuments, das hochgeladen werden soll, mit Erweiterung |
|
Inhalt der Datei
|
File | True | contentOnly |
Der Dateidatenstrom des Dokuments, der hochgeladen werden soll |
Gibt zurück
Ein JSON-Code, der die ID des hochgeladenen Dokuments enthält
Kündigen einer Vereinbarung
Bricht die vereinbarung, die durch agreementId im Pfad identifiziert wurde.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vereinbarungs-ID
|
agreementId | True | string |
Die Vereinbarungs-ID des Vertrags, der gekündigt werden soll. |
|
Im Namen von
|
x-api-user | string |
Die E-Mail des API-Aufrufers im Format: E-Mail:adobesignuser@domain.com |
|
|
Agrement State
|
state | string |
Der Staat, in dem das Abkommen landen sollte. |
|
|
Kommentar
|
comment | string |
Ein optionaler Kommentar, der den Grund der Kündigung für die Empfänger beschreibt. |
|
|
Andere
|
notifyOthers | boolean |
Gibt an, ob die Empfänger benachrichtigt werden sollen. |
Trigger
| Tritt ein Webformularvertragsereignis auf |
Löst einen neuen Fluss aus, wenn das Webformularvertragsereignis eintritt. Deckt die häufigsten Vereinbarungsereignisse wie Erstellung, Fertigstellung usw. ab. |
| Wenn ein Ereignis auftritt |
Löst einen neuen Fluss aus, wenn ein Ereignis auftritt. Umfasst alle Vereinbarungs-, Mega sign- und Web Form-Ereignisse. |
| Wenn ein Gruppenereignis auftritt |
Löst einen neuen Fluss aus, wenn ein Gruppenereignis auftritt. Umfasst alle Vereinbarungs-, Mega sign- und Web Form-Ereignisse. |
| Wenn ein Vereinbarungsworkflow erfolgreich abgeschlossen wurde |
Löst einen neuen Fluss aus, wenn ein Vereinbarungsworkflow erfolgreich abgeschlossen wird |
| Wenn eine neue Vereinbarung erstellt wird |
Löst einen neuen Fluss aus, wenn eine neue Vereinbarung erstellt wird. |
| Wenn eine Vereinbarung an einen Teilnehmer gesendet wird |
Löst einen neuen Fluss aus, wenn eine Vereinbarung an einen Teilnehmer gesendet wird. |
| Wenn sich der Status einer Vereinbarung ändert |
Löst einen neuen Fluss aus, wenn sich der Status einer Vereinbarung ändert. Deckt die häufigsten Vereinbarungsereignisse wie Erstellung, Fertigstellung usw. ab. |
Tritt ein Webformularvertragsereignis auf
Löst einen neuen Fluss aus, wenn das Webformularvertragsereignis eintritt. Deckt die häufigsten Vereinbarungsereignisse wie Erstellung, Fertigstellung usw. ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Name
|
name | True | string |
Der Name des Triggers |
|
Web Forms-Seitengröße
|
pageSize | integer |
Wählen Sie die Anzahl der Webformulare aus, die in der Dropdownliste angezeigt werden sollen. |
|
|
Webformularname/ID
|
resourceId | True | string |
Wählen Sie webformular aus der Liste aus, oder geben Sie die Webformular-ID ein. |
|
webhookSubscriptionEvents
|
webhookSubscriptionEvents | True | array of string |
Die Ereignisse, für die der Fluss ausgelöst werden soll |
|
Vereinbarungsinformationen einschließen?
|
includeDetailedInfo | boolean |
Sollten detaillierte Vereinbarungsinformationen in der Benachrichtigung gesendet werden? |
|
|
Vertragsteilnehmerinformationen einschließen?
|
includeParticipantsInfo | boolean |
Sollen Teilnehmerinformationen des Vertragsteilnehmers in der Benachrichtigung gesendet werden? |
|
|
Vereinbarungsdokumentinformationen einschließen?
|
includeDocumentsInfo | boolean |
Sollen Dokumentinformationen für Vereinbarungen in der Benachrichtigung gesendet werden? |
|
|
Vereinbarung unterzeichnete Dokumentinformationen einschließen?
|
includeSignedDocuments | boolean |
Sollte eine endgültige Kopie des unterzeichneten Dokuments in Benachrichtigung über den Abschluss der Vereinbarung gesendet werden? |
Gibt zurück
Wenn ein Ereignis auftritt
Löst einen neuen Fluss aus, wenn ein Ereignis auftritt. Umfasst alle Vereinbarungs-, Mega sign- und Web Form-Ereignisse.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Name
|
name | True | string |
Der Name des Triggers |
|
Umfang
|
scope | True | string |
Der Bereich des Triggers |
|
Ressourcentyp
|
resourceType | string |
Geben Sie nur an, wenn "Bereich" "Eine bestimmte Ressource" ist. Wählen Sie den Ressourcentyp aus, für den der Fluss ausgelöst werden soll. |
|
|
Ressourcen-ID
|
resourceId | string |
Geben Sie nur an, wenn "Bereich" "Eine bestimmte Ressource" ist. Geben Sie die Vereinbarung oder Mega-Signatur oder Webformular- oder Gruppen-ID ein, für die der Fluss ausgelöst werden soll. |
|
|
webhookSubscriptionEvents
|
webhookSubscriptionEvents | True | array of string |
Die Ereignisse, für die der Fluss ausgelöst werden soll |
|
Vereinbarungsinformationen einschließen?
|
includeDetailedInfo | boolean |
Sollten detaillierte Vereinbarungsinformationen in der Benachrichtigung gesendet werden? |
|
|
Vertragsteilnehmerinformationen einschließen?
|
includeParticipantsInfo | boolean |
Sollen Teilnehmerinformationen des Vertragsteilnehmers in der Benachrichtigung gesendet werden? |
|
|
Vereinbarungsdokumentinformationen einschließen?
|
includeDocumentsInfo | boolean |
Sollen Dokumentinformationen für Vereinbarungen in der Benachrichtigung gesendet werden? |
|
|
Vereinbarung unterzeichnete Dokumentinformationen einschließen?
|
includeSignedDocuments | boolean |
Sollte eine endgültige Kopie des unterzeichneten Dokuments über den Abschluss der Vereinbarung in der Benachrichtigung gesendet werden? |
|
|
MegaSign-Informationen einschließen?
|
includeDetailedInfo | boolean |
Sollen detaillierte Megazeicheninformationen in der Benachrichtigung gesendet werden? |
|
|
Webformularinformationen einschließen?
|
includeDetailedInfo | boolean |
Sollten detaillierte Webformularinformationen in der Benachrichtigung gesendet werden? |
|
|
Webformularteilnehmerinformationen einschließen?
|
includeParticipantsInfo | boolean |
Sollen Webformularteilnehmerinformationen in der Benachrichtigung gesendet werden? |
|
|
Webformular-Dokumentinformationen einschließen?
|
includeDocumentsInfo | boolean |
Sollen Webformular-Dokumentinformationen in der Benachrichtigung gesendet werden? |
Gibt zurück
Wenn ein Gruppenereignis auftritt
Löst einen neuen Fluss aus, wenn ein Gruppenereignis auftritt. Umfasst alle Vereinbarungs-, Mega sign- und Web Form-Ereignisse.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Name
|
name | True | string |
Der Name des Triggers |
|
Gruppenname/ID
|
resourceId | string |
ID der Gruppe |
|
|
webhookSubscriptionEvents
|
webhookSubscriptionEvents | True | array of string |
Die Ereignisse, für die der Fluss ausgelöst werden soll |
|
Vereinbarungsinformationen einschließen?
|
includeDetailedInfo | boolean |
Sollten detaillierte Vereinbarungsinformationen in der Benachrichtigung gesendet werden? |
|
|
Vertragsteilnehmerinformationen einschließen?
|
includeParticipantsInfo | boolean |
Sollen Teilnehmerinformationen des Vertragsteilnehmers in der Benachrichtigung gesendet werden? |
|
|
Vereinbarungsdokumentinformationen einschließen?
|
includeDocumentsInfo | boolean |
Sollen Dokumentinformationen für Vereinbarungen in der Benachrichtigung gesendet werden? |
|
|
Vereinbarung unterzeichnete Dokumentinformationen einschließen?
|
includeSignedDocuments | boolean |
Sollte eine endgültige Kopie des unterzeichneten Dokuments über den Abschluss der Vereinbarung in der Benachrichtigung gesendet werden? |
|
|
MegaSign-Informationen einschließen?
|
includeDetailedInfo | boolean |
Sollen detaillierte Megazeicheninformationen in der Benachrichtigung gesendet werden? |
|
|
Webformularinformationen einschließen?
|
includeDetailedInfo | boolean |
Sollten detaillierte Webformularinformationen in der Benachrichtigung gesendet werden? |
|
|
Webformularteilnehmerinformationen einschließen?
|
includeParticipantsInfo | boolean |
Sollen Webformularteilnehmerinformationen in der Benachrichtigung gesendet werden? |
|
|
Webformular-Dokumentinformationen einschließen?
|
includeDocumentsInfo | boolean |
Sollen Webformular-Dokumentinformationen in der Benachrichtigung gesendet werden? |
Gibt zurück
Wenn ein Vereinbarungsworkflow erfolgreich abgeschlossen wurde
Löst einen neuen Fluss aus, wenn ein Vereinbarungsworkflow erfolgreich abgeschlossen wird
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Name
|
name | True | string |
Der Name des Triggers |
|
Umfang
|
scope | True | string |
Der Bereich des Triggers |
|
Vertragsname/ID
|
resourceId | string |
Geben Sie nur an, wenn "Scope" "A specific agreement" ist. Wählen Sie einen Vertrag aus der Liste aus, oder geben Sie die Vereinbarungs-ID ein. |
|
|
Subscription
|
webhookSubscriptionEvents | True | array of string |
Die Ereignisse, für die der Fluss ausgelöst werden soll |
|
Vereinbarungsinformationen einschließen?
|
includeDetailedInfo | boolean |
Sollten detaillierte Vereinbarungsinformationen in der Benachrichtigung gesendet werden? |
|
|
Vertragsteilnehmerinformationen einschließen?
|
includeParticipantsInfo | boolean |
Sollen Teilnehmerinformationen des Vertragsteilnehmers in der Benachrichtigung gesendet werden? |
|
|
Vereinbarungsdokumentinformationen einschließen?
|
includeDocumentsInfo | boolean |
Sollen Dokumentinformationen für Vereinbarungen in der Benachrichtigung gesendet werden? |
|
|
Vereinbarung unterzeichnete Dokumentinformationen einschließen?
|
includeSignedDocuments | boolean |
Sollte eine endgültige Kopie des unterzeichneten Dokuments über den Abschluss der Vereinbarung in der Benachrichtigung gesendet werden? |
Gibt zurück
Wenn eine neue Vereinbarung erstellt wird
Löst einen neuen Fluss aus, wenn eine neue Vereinbarung erstellt wird.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Name
|
name | True | string |
Der Name des Triggers |
|
Umfang
|
scope | True | string |
Der Bereich des Triggers |
|
Subscription
|
webhookSubscriptionEvents | True | array of string |
Die Ereignisse, für die der Fluss ausgelöst werden soll |
|
Vereinbarungsinformationen einschließen?
|
includeDetailedInfo | boolean |
Sollten detaillierte Vereinbarungsinformationen in der Benachrichtigung gesendet werden? |
|
|
Vertragsteilnehmerinformationen einschließen?
|
includeParticipantsInfo | boolean |
Sollen Teilnehmerinformationen des Vertragsteilnehmers in der Benachrichtigung gesendet werden? |
Gibt zurück
Wenn eine Vereinbarung an einen Teilnehmer gesendet wird
Löst einen neuen Fluss aus, wenn eine Vereinbarung an einen Teilnehmer gesendet wird.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Name
|
name | True | string |
Der Name des Triggers |
|
Umfang
|
scope | True | string |
Der Bereich des Triggers |
|
Vertragsname/ID
|
resourceId | string |
Geben Sie nur an, wenn "Scope" "A specific agreement" ist. Wählen Sie einen Vertrag aus der Liste aus, oder geben Sie die Vereinbarungs-ID ein. |
|
|
Subscription
|
webhookSubscriptionEvents | True | array of string |
Die Ereignisse, für die der Fluss ausgelöst werden soll |
|
Vereinbarungsinformationen einschließen?
|
includeDetailedInfo | boolean |
Sollten detaillierte Vereinbarungsinformationen in der Benachrichtigung gesendet werden? |
|
|
Vertragsteilnehmerinformationen einschließen?
|
includeParticipantsInfo | boolean |
Sollen Teilnehmerinformationen des Vertragsteilnehmers in der Benachrichtigung gesendet werden? |
|
|
Vereinbarungsdokumentinformationen einschließen?
|
includeDocumentsInfo | boolean |
Sollen Dokumentinformationen für Vereinbarungen in der Benachrichtigung gesendet werden? |
Gibt zurück
- Body
- WebhookPayload
Wenn sich der Status einer Vereinbarung ändert
Löst einen neuen Fluss aus, wenn sich der Status einer Vereinbarung ändert. Deckt die häufigsten Vereinbarungsereignisse wie Erstellung, Fertigstellung usw. ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Name
|
name | True | string |
Der Name des Triggers |
|
Umfang
|
scope | True | string |
Der Bereich des Triggers |
|
Vertragsname/ID
|
resourceId | string |
Geben Sie nur an, wenn "Scope" "A specific agreement" ist. Wählen Sie einen Vertrag aus der Liste aus, oder geben Sie die Vereinbarungs-ID ein. |
|
|
webhookSubscriptionEvents
|
webhookSubscriptionEvents | True | array of string |
Die Ereignisse, für die der Fluss ausgelöst werden soll |
|
Vereinbarungsinformationen einschließen?
|
includeDetailedInfo | boolean |
Sollten detaillierte Vereinbarungsinformationen in der Benachrichtigung gesendet werden? |
|
|
Vertragsteilnehmerinformationen einschließen?
|
includeParticipantsInfo | boolean |
Sollen Teilnehmerinformationen des Vertragsteilnehmers in der Benachrichtigung gesendet werden? |
|
|
Vereinbarungsdokumentinformationen einschließen?
|
includeDocumentsInfo | boolean |
Sollen Dokumentinformationen für Vereinbarungen in der Benachrichtigung gesendet werden? |
|
|
Vereinbarung unterzeichnete Dokumentinformationen einschließen?
|
includeSignedDocuments | boolean |
Sollte eine endgültige Kopie des unterzeichneten Dokuments in Benachrichtigung über den Abschluss der Vereinbarung gesendet werden? |
Gibt zurück
Definitionen
AgreementCreationResponse
Ein JSON-Code, der die ID der neu erstellten Vereinbarung enthält
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Vereinbarungs-ID
|
agreementId | string |
Die eindeutige ID der Vereinbarung, die verwendet werden kann, um den Status abzufragen und signierte Dokumente herunterzuladen |
AgreementCreationResponseV6
Ein JSON-Code, der die ID der neu erstellten Vereinbarung enthält
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Vereinbarungs-ID
|
id | string |
Die eindeutige ID der Vereinbarung, die verwendet werden kann, um den Status abzufragen und signierte Dokumente herunterzuladen |
AgreementDocuments
Ein JSON-Code, der sowohl die Dokumente als auch unterstützende Dokumentarrayobjekte enthält
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Dokumente
|
documents | array of Document |
Eine Liste von Objekten, die die Dokumente darstellen |
|
Belege
|
supportingDocuments | array of SupportingDocument |
Eine Liste der unterstützenden Dokumente. Dies wird nur zurückgegeben, wenn in der Vereinbarung ein Unterstützendes Dokument vorhanden ist. |
AgreementDocumentsV6
Ein JSON-Code, der sowohl die Dokumente als auch unterstützende Dokumentarrayobjekte enthält
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Dokumente
|
documents | array of DocumentV6 |
Eine Liste von Objekten, die die Dokumente darstellen |
|
Belege
|
supportingDocuments | array of SupportingDocumentV6 |
Eine Liste der unterstützenden Dokumente. Dies wird nur zurückgegeben, wenn in der Vereinbarung ein Unterstützendes Dokument vorhanden ist. |
AgreementInfo
Die vollständigen Details zur Vereinbarung
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Vereinbarungs-ID
|
agreementId | string |
Eine eindeutige ID, die verwendet werden kann, um die Vereinbarung eindeutig zu identifizieren |
|
Ereignisse
|
events | array of DocumentHistoryEvent |
Eine sortierte Liste der Ereignisse im Überwachungspfad dieses Dokuments |
|
Ablaufdatum
|
expiration | date |
Das Datum, an dem die Vereinbarung nicht mehr unterzeichnet werden kann |
|
Neueste Versions-ID
|
latestVersionId | string |
Eine eindeutige ID, die die aktuelle Version des Vertrags eindeutig identifiziert |
|
Nachricht
|
message | string |
Die Nachricht, die der Vereinbarung zugeordnet ist, die der Absender bereitgestellt hat |
|
Vertragsname
|
name | string |
Der Name der Vereinbarung, die vom Absender angegeben wird |
|
Nächste Teilnehmersätze
|
nextParticipantSetInfos | array of NextParticipantSetInfo |
Informationen darüber, wer als Nächstes für diese Vereinbarung handeln muss |
|
Teilnehmersätze
|
participantSetInfos | array of ParticipantSetInfo |
Informationen zu allen Teilnehmergruppen dieses Dokuments |
|
Signaturtyp
|
signatureType | string |
Gibt den angeforderten Signaturtyp an – E-Signatur oder geschrieben |
|
Dokumentschutz
|
securityOptions | string |
Sicherheitsinformationen zum Dokument, das angibt, ob zum Anzeigen und Signieren eines Kennworts ein Kennwort erforderlich ist. |
|
Der Status
|
status | string |
Der aktuelle Status der Vereinbarung |
AgreementInfoV6
Vollständige Vereinbarungsdetails
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Vereinbarungs-ID
|
id | string |
Eine eindeutige ID, die verwendet werden kann, um die Vereinbarung eindeutig zu identifizieren |
|
Erstellt am
|
createdDate | date |
Datum der Erstellung der Vereinbarung |
|
Erste Erinnerungsverzögerung
|
firstReminderDelay | integer |
Ganze Zahl, die die Verzögerung in Stunden vor dem Senden der ersten Erinnerung angibt. |
|
Erinnerungshäufigkeit
|
reminderFrequency | string |
Wie oft möchten Sie Erinnerungen senden? |
|
Ablaufdatum
|
expiration | date |
Das Datum, an dem die Vereinbarung nicht mehr unterzeichnet werden kann |
|
Gebietsschema
|
locale | string |
Das Gebietsschema, das dieser Vereinbarung zugeordnet ist , z. B. en_US oder fr_FR |
|
Nachricht
|
message | string |
Die Nachricht, die der Vereinbarung zugeordnet ist, die der Absender bereitgestellt hat |
|
Vertragsname
|
name | string |
Der Name der Vereinbarung, die vom Absender angegeben wird |
|
Dokumentsichtbarkeit?
|
documentVisibilityEnabled | boolean |
Ist die Dokumentsichtbarkeit aktiviert? |
|
Teilnehmersätze
|
participantSetsInfo | array of ParticipantSetInfoV6 |
Informationen zu allen Teilnehmergruppen dieses Dokuments |
|
Signaturtyp
|
signatureType | string |
Gibt den angeforderten Signaturtyp an – E-Signatur oder geschrieben |
|
Sicherheitsoptionen
|
securityOptions | string |
Sicherheitsinformationen zum Dokument, das angibt, ob zum Anzeigen und Signieren eines Kennworts ein Kennwort erforderlich ist. |
|
Der Status
|
status | string |
Der aktuelle Status der Vereinbarung |
|
Absender-E-Mail
|
senderEmail | string |
Die E-Mail des Absenders |
|
Workflow-ID
|
workflowId | string |
Die ID des benutzerdefinierten Workflows, der den Routingpfad einer Vereinbarung definiert. |
|
Ccs
|
ccs | array of CcInfo |
Eine Liste mit einem oder mehreren CCs, die in der Vereinbarungstransaktion kopiert werden. |
|
Gruppen-ID
|
groupId | string |
Der eindeutige Bezeichner der Gruppe, zu der die Vereinbarung gehört. |
CombinedDocumentResponse
AgreementAuditTrailResponse
Der Dateidatenstrom des Überwachungspfads der Vereinbarung
Der Dateidatenstrom des Überwachungspfads der Vereinbarung
- Inhalt des Vereinbarungsüberwachungspfads
- binary
DisplayUserInfo
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Firma
|
company | string |
Zeigt den Namen des Unternehmens des Benutzers an, sofern verfügbar. |
|
Email
|
string |
Zeigt die E-Mail des Benutzers an. |
|
|
Vollständiger Name
|
fullName | string |
Zeigt den vollständigen Namen des Benutzers an, falls verfügbar. |
DisplayUserSetInfo
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Benutzersatzinformationen anzeigen
|
displayUserSetMemberInfos | array of DisplayUserInfo |
Zeigt die Informationen zum Benutzersatz an. |
|
Anzeige des Benutzernamens
|
displayUserSetName | string |
Dokument
Die Informationen zum Dokument
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Dokument-ID
|
documentId | string |
Die eindeutige ID des Dokuments |
|
MIME-Typ
|
mimeType | string |
Der MIME-Typ des Dokuments |
|
Name
|
name | string |
Der Name des Dokuments |
|
Seitenzahl
|
numPages | integer |
Anzahl der Seiten im Dokument |
DocumentV6
Die Informationen zum Dokument
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Dokument-ID
|
id | string |
Die eindeutige ID des Dokuments |
|
MIME-Typ
|
mimeType | string |
Der MIME-Typ des Dokuments |
|
Name
|
name | string |
Der Name des Dokuments |
|
Seitenzahl
|
numPages | integer |
Anzahl der Seiten im Dokument |
DocumentHistoryEvent
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Ereignisinitiator
|
actingUserEmail | string |
E-Mail-Adresse des Benutzers, der das Ereignis initiiert hat |
|
Ereignisdatum
|
date | date |
Das Datum des Überwachungsereignisses |
|
Ereignisbeschreibung
|
description | string |
Eine Beschreibung des Überwachungsereignisses |
|
Teilnehmer-E-Mail
|
participantEmail | string |
E-Mail-Adresse des Benutzers, der das Ereignis initiiert hat |
|
Ereignistyp
|
type | string |
Art des Vertragsereignisses |
DocumentLibraryItem
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Bibliotheksvorlagen-ID
|
libraryDocumentId | string |
Die eindeutige ID des Bibliotheksdokuments, das beim Senden des zu signierten Dokuments verwendet wird |
|
Bibliotheksvorlagentypen
|
libraryTemplateTypes | array of string |
Eine Liste mit einem oder mehreren Bibliotheksvorlagentypen |
|
Änderungsdatum
|
modifiedDate | date |
Der Tag, an dem die Bibliotheksvorlage zuletzt geändert wurde |
|
Name der Bibliotheksvorlage
|
name | string |
Der Name der Bibliotheksvorlage |
|
Vorlagenfreigabemodus
|
scope | string |
Der Bereich der Sichtbarkeit der Bibliotheksvorlage |
DocumentLibraryItems
Ein JSON-Objekt, das das Arrayobjekt der Bibliotheksvorlage enthält
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Bibliotheksvorlagenliste
|
libraryDocumentList | array of DocumentLibraryItem |
Eine Liste der Bibliotheksvorlagenelemente |
DocumentResponse
LibraryDocumentCreationResponse
Ein JSON-Objekt, das die Bibliotheksvorlage beschreibt
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Bibliotheksvorlagen-ID
|
libraryDocumentId | string |
Die eindeutige ID, die verwendet werden kann, um auf die Bibliotheksvorlage zu verweisen |
NextParticipantInfo
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Email
|
string |
Die E-Mail-Adresse des nächsten Teilnehmers |
|
|
Name
|
name | string |
Der Name des nächsten Teilnehmers, falls verfügbar |
|
Warten seit
|
waitingSince | date |
Das Datum, ab dem das Dokument auf die Aktion des Teilnehmers wartet |
NextParticipantSetInfo
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Infos zum nächsten Teilnehmersatz-Mitglied
|
nextParticipantSetMemberInfos | array of NextParticipantInfo |
Informationen zu den Mitgliedern des nächsten Teilnehmersatzes |
ParticipantInfo
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Firma
|
company | string |
Die Firma des Teilnehmers, sofern verfügbar |
|
Email
|
string |
Die E-Mail-Adresse des Teilnehmers |
|
|
Name
|
name | string |
Der Name des Teilnehmers, falls verfügbar |
|
Teilnehmer-ID
|
participantId | string |
Die eindeutige ID des Teilnehmers |
|
Sicherheitsoptionen
|
securityOptions | array of string |
Sicherheitsoptionen, die für den Teilnehmer gelten |
|
Title
|
title | string |
Der Titel des Teilnehmers, sofern verfügbar |
ParticipantSetInfo
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Teilnehmersatz-ID
|
participantSetId | string |
Die eindeutige ID des Teilnehmersatzes |
|
Teilnehmersatz-Memberinfos
|
participantSetMemberInfos | array of ParticipantInfo |
Informationen zu den Mitgliedern des Empfängersatzes |
|
Private Nachricht
|
privateMessage | string |
Private Nachricht für die Teilnehmer im Satz |
|
Rolle
|
roles | array of string |
Die aktuellen Rollen des Teilnehmersatzes. Ein Teilnehmersatz kann über eine oder mehrere Rollen verfügen. |
|
securityOptions
|
securityOptions | array of string |
Sicherheitsoptionen, die für den Teilnehmer gelten |
|
Signierreihenfolge
|
signingOrder | integer |
Index beginnend mit 1, der die Reihenfolge angibt, in der dieser Empfänger signiert |
|
Teilnehmersatzstatus
|
status | string |
Der Teilnehmer hat den Status im Hinblick auf das Dokument festgelegt. |
ParticipantSetInfoV6
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Teilnehmersatz-Memberinfos
|
memberInfos | array of MemberInfosV6 |
Informationen zu den Mitgliedern des Empfängersatzes |
|
Bestellung
|
order | integer |
Index, der angibt, an welcher Position die Signiergruppe signieren muss. |
|
Rolle
|
role | string |
Die aktuellen Rollen des Teilnehmersatzes (Signierer, Genehmigender usw.). |
|
Name des Teilnehmersatzes
|
name | string |
Der Name des Teilnehmersatzes |
|
Teilnehmer festlegen private Message
|
privateMessage | string |
Private Nachricht für die Teilnehmer im Satz |
|
Sichtbare Seiten für Teilnehmer festlegen
|
visiblePages | array of string |
Die Seiten, die für den Teilnehmersatz sichtbar sind |
MemberInfosV6
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Email
|
string |
Die E-Mail des Teilnehmers |
|
|
Authentifizierung
|
securityOption.authenticationMethod | string |
Standardauthentifizierung: E-Mail (Keine) |
|
Kennwort
|
securityOption.password | string |
Das für den Teilnehmer erforderliche Kennwort |
|
Ländercode
|
securityOption.phoneInfo.countryCode | string |
Telefonlandcode des Empfängers, der zum Anzeigen und Signieren des Dokuments erforderlich ist |
|
Telefon Nr.
|
securityOption.phoneInfo.phone | string |
Die Telefonnummer des Empfängers, die zum Anzeigen und Signieren der Vereinbarung erforderlich ist |
|
Anbieter-ID
|
securityOption.digAuthInfo.providerId | string |
Id des Anbieters des digitalen Identitätsgateways. |
SigningUrl
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
E-Mail für Signier-URL
|
string |
Die E-Mail-Adresse des Signierers, der dieser Signatur-URL zugeordnet ist |
|
|
Signieren-URL
|
esignUrl | string |
Die URL-Adresse des Signierers, der dieser Signatur-URL zugeordnet ist |
SigningUrlResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Array von URLs für Signierersätze
|
signingUrlSetInfos | array of SigningUrlSetInfo |
Ein Array von URLs für Signierersätze, die an dieser Vereinbarung beteiligt sind |
SigningUrlSetInfo
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
- Signieren des URL-Arrays
|
signingUrls | array of SigningUrl |
Ein Array von URLs für den aktuellen Signierersatz |
|
- Name des Signier-URL-Satzes
|
signingUrlSetName | string |
Der Name des aktuellen Signierersatzes |
SupportingDocument
Die Informationen zum Unterstützenden Dokument
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Unterstützender Dokumentname
|
displayLabel | string |
Anzeigename des unterstützenden Dokuments |
|
Name des unterstützenden Dokumentfelds
|
fieldName | string |
Der Name des unterstützenden Dokumentfelds |
|
Unterstützen des Dokument-MIME-Typs
|
mimeType | string |
Der MIME-Typ des unterstützenden Dokuments |
|
Unterstützen von Dokumentseiten
|
numPages | integer |
Anzahl der Seiten im Unterstützenden Dokument |
|
Unterstützende Dokument-ID
|
supportingDocumentId | string |
Eindeutige ID, die das unterstützende Dokument darstellt |
SupportingDocumentV6
Die Informationen zum Unterstützenden Dokument
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Unterstützender Dokumentname
|
displayLabel | string |
Anzeigename des unterstützenden Dokuments |
|
Name des unterstützenden Dokumentfelds
|
fieldName | string |
Der Name des unterstützenden Dokumentfelds |
|
Unterstützen des Dokument-MIME-Typs
|
mimeType | string |
Der MIME-Typ des unterstützenden Dokuments |
|
Unterstützen von Dokumentseiten
|
numPages | integer |
Anzahl der Seiten im Unterstützenden Dokument |
|
Unterstützende Dokument-ID
|
id | string |
Eindeutige ID, die das unterstützende Dokument darstellt |
TransientDocumentResponse
Ein JSON-Code, der die ID des hochgeladenen Dokuments enthält
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Dokument-ID
|
transientDocumentId | string |
Die Dokument-ID des hochgeladenen Dokuments |
UserAgreement
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Vereinbarungs-ID
|
agreementId | string |
Eine eindeutige ID, die verwendet werden kann, um die Vereinbarung eindeutig zu identifizieren |
|
Benutzersatzinformationen anzeigen
|
displayUserSetInfos | array of DisplayUserSetInfo |
Der relevanteste aktuelle Benutzer, der für die Vereinbarung festgelegt ist. Dies ist in der Regel der nächste Signierer, wenn der Vertrag vom aktuellen Benutzer stammt, oder der Absender, wenn er von einem anderen Benutzer empfangen wird. |
|
Anzeigedatum
|
displayDate | date |
Das Anzeigedatum für die Vereinbarung |
|
Esign
|
esign | boolean |
True, wenn es sich um ein E-Sign-Dokument handelt |
|
Neueste Versions-ID
|
latestVersionId | string |
Eine Versions-ID, die die aktuelle Version des Vertrags eindeutig identifiziert |
|
Name
|
name | string |
Name der Vereinbarung |
|
Der Status
|
status | string |
Der aktuelle Status der Vereinbarung |
UserAgreements
Ein JSON-Objekt, das das Arrayobjekt der Benutzervereinbarung enthält
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Vereinbarungsliste
|
userAgreementList | array of UserAgreement |
Ein Array von Vereinbarungselementen |
UserAgreementV6
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Benutzersatzinformationen anzeigen
|
displayParticipantSetInfos | array of DisplayUserSetInfo |
Der relevanteste aktuelle Benutzer, der für die Vereinbarung festgelegt ist. Dies ist in der Regel der nächste Signierer, wenn der Vertrag vom aktuellen Benutzer stammt, oder der Absender, wenn er von einem anderen Benutzer empfangen wird. |
|
Anzeigedatum
|
displayDate | string |
Das Anzeigedatum für die Vereinbarung |
|
Esign
|
esign | boolean |
True, wenn es sich um ein E-Sign-Dokument handelt |
|
Versteckt
|
hidden | boolean |
True, wenn die Vereinbarung für den Benutzer ausgeblendet ist |
|
Gruppen-ID
|
groupId | string |
Eindeutiger Bezeichner der Gruppe |
|
Neueste Versions-ID
|
latestVersionId | string |
Eine Versions-ID, die die aktuelle Version des Vertrags eindeutig identifiziert |
|
Name
|
name | string |
Name der Vereinbarung |
|
Übergeordnete ID
|
parentId | string |
Die übergeordnete ID eines untergeordneten MegaSign-Elements ODER die Ursprungs-ID einer Webformularvertragsinstanz |
|
Vereinbarungs-ID
|
id | string |
Der eindeutige Bezeichner der Vereinbarung |
|
Der Status
|
status | string |
Der aktuelle Status der Vereinbarung |
|
Typ
|
type | string |
Art der Vereinbarung |
userAgreementListV6
Ein JSON-Objekt, das das Arrayobjekt der Benutzervereinbarung enthält
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Seite
|
page | page |
Paginierungsinformationen zum Navigieren durch die Antwort |
|
Vereinbarungsliste
|
userAgreementList | array of UserAgreementV6 |
Ein Array von Vereinbarungselementen |
Seite
Paginierungsinformationen zum Navigieren durch die Antwort
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
nextCursor
|
nextCursor | string |
Wird verwendet, um zur nächsten Seite zu navigieren. Wenn sie nicht zurückgegeben wird, gibt es keine weiteren Seiten. |
WebhookPayload
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Event
|
event | string |
Das Ereignis, das für die Ressource aufgetreten ist. |
|
Ereignisdatum
|
eventDate | date |
Das Datum des Ereignisses. Format wäre yyyy-MM-dd'T'HH:mm:ssZ. Beispiel: 2016-02-25T18:46:19Z stellt UTC-Zeit dar. |
|
Ereignisressourcentyp
|
eventResourceType | string |
Die Ressource, für die das Ereignis aufgetreten ist. |
|
Übergeordneter Vereinbarungstyp
|
eventResourceParentType | string |
Informationen zur Ressource, aus der die Vereinbarung erstellt wird. Mögliche Werte: Webformular oder Megazeichen |
|
Übergeordnete Vereinbarungs-ID
|
eventResourceParentId | string |
Eine eindeutige ID der Ressource, aus der diese Vereinbarung erstellt wird |
|
Rolle "Ereignisteilnehmer"
|
participantRole | string |
Die Rolle des Teilnehmers für das Ereignis. |
|
Ereignisteilnehmer-ID
|
participantUserId | string |
Die ID des Teilnehmers für das Ereignis. |
|
Ereignisteilnehmer-E-Mail
|
participantUserEmail | string |
Die E-Mail des Teilnehmers für das Ereignis. |
|
Ereignis-Handelnde Benutzer-ID
|
actingUserId | string |
Die ID des Benutzers, der das Ereignis erstellt hat. |
|
Ereignis-Handelnde Benutzer-E-Mail
|
actingUserEmail | string |
Die E-Mail des Benutzers, der das Ereignis erstellt hat. |
|
Ereignis-handelnde Benutzer-IP-Adresse
|
actingUserIpAddress | string |
Die IP-Adresse des Benutzers, der das Ereignis erstellt hat |
|
Ereignisinitiierung der Benutzer-ID
|
initiatingUserId | string |
Die ID des Benutzers, der das Ereignis im Auftrag des handelnden Benutzers initiiert hat. |
|
Ereignis, das Benutzer-E-Mail initiiert
|
initiatingUserEmail | string |
Die E-Mail des Benutzers, der das Ereignis im Auftrag des handelnden Benutzers initiiert hat. |
|
Benachrichtigung anwendbare Benutzer
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
Eine Liste der Benutzer, für die diese Benachrichtigung anwendbar ist |
|
Vereinbarung
|
agreement | WebhookAgreementInfo |
Die vollständigen Informationen der Vereinbarung |
ApplicableUsers
Die Informationen zu den Benutzern, für die diese Benachrichtigung gilt
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Benachrichtigung anwendbare Benutzer-ID
|
id | string |
Die eindeutige ID des Benutzers, für den diese Benachrichtigung anwendbar ist |
|
Benachrichtigung anwendbare Benutzer-E-Mail
|
string |
Die E-Mail des Benutzers, für den diese Benachrichtigung anwendbar ist |
|
|
Benachrichtigung zutreffende Benutzerrolle
|
role | string |
Die Rolle des Benutzers im Workflow, für den diese Benachrichtigung generiert wird |
|
Ist Nutzlast anwendbarer Benutzer
|
payloadApplicable | boolean |
Gibt an, ob die in dieser Benachrichtigung bereitgestellten Daten für diesen Benutzer gelten oder nicht. |
WebhookPayloadWithoutNextParticipantSet
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Event
|
event | string |
Das Ereignis, das für die Ressource aufgetreten ist. |
|
Ereignisdatum
|
eventDate | date |
Das Datum des Ereignisses. Format wäre yyyy-MM-dd'T'HH:mm:ssZ. Beispiel: 2016-02-25T18:46:19Z stellt UTC-Zeit dar. |
|
Ereignisressourcentyp
|
eventResourceType | string |
Die Ressource, für die das Ereignis aufgetreten ist. |
|
Übergeordneter Vereinbarungstyp
|
eventResourceParentType | string |
Informationen zur Ressource, aus der die Vereinbarung erstellt wird. Mögliche Werte: Webformular oder Megazeichen |
|
Übergeordnete Vereinbarungs-ID
|
eventResourceParentId | string |
Eine eindeutige ID der Ressource, aus der diese Vereinbarung erstellt wird |
|
Ereignisteilnehmer-ID
|
participantUserId | string |
Die ID des Teilnehmers für das Ereignis. |
|
Ereignisteilnehmer-E-Mail
|
participantUserEmail | string |
Die E-Mail des Teilnehmers für das Ereignis. |
|
Ereignis-Handelnde Benutzer-ID
|
actingUserId | string |
Die ID des Benutzers, der das Ereignis erstellt hat. |
|
Ereignis-Handelnde Benutzer-E-Mail
|
actingUserEmail | string |
Die E-Mail des Benutzers, der das Ereignis erstellt hat. |
|
Ereignis-handelnde Benutzer-IP-Adresse
|
actingUserIpAddress | string |
Die IP-Adresse des Benutzers, der das Ereignis erstellt hat |
|
Ereignisinitiierung der Benutzer-ID
|
initiatingUserId | string |
Die ID des Benutzers, der das Ereignis im Auftrag des handelnden Benutzers initiiert hat |
|
Ereignis, das Benutzer-E-Mail initiiert
|
initiatingUserEmail | string |
Die E-Mail des Benutzers, der das Ereignis im Auftrag des handelnden Benutzers initiiert hat. |
|
Benachrichtigung anwendbare Benutzer
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
Eine Liste der Benutzer, für die diese Benachrichtigung anwendbar ist |
|
Vereinbarung
|
agreement | WebhookAgreementInfoWithoutNextParticipantSet |
Die vollständigen Informationen der Vereinbarung |
WebhookPayloadWithSignedDocumentForStatusChange
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Event
|
event | string |
Das Ereignis, das für die Ressource aufgetreten ist. |
|
Ereignisdatum
|
eventDate | date |
Das Datum des Ereignisses. Format wäre yyyy-MM-dd'T'HH:mm:ssZ. Beispiel: 2016-02-25T18:46:19Z stellt UTC-Zeit dar. |
|
Sub-Ereignis
|
subEvent | string |
Das Unterereignis, das für eine Ressource aufgetreten ist. |
|
Übergeordneter Vereinbarungstyp
|
eventResourceParentType | string |
Informationen zur Ressource, aus der die Vereinbarung erstellt wird. Mögliche Werte: Webformular oder Megazeichen |
|
Übergeordnete Vereinbarungs-ID
|
eventResourceParentId | string |
Eine eindeutige ID der Ressource, aus der diese Vereinbarung erstellt wird |
|
Ereignisteilnehmer-ID
|
participantUserId | string |
Die ID des Teilnehmers für das Ereignis. |
|
Ereignisteilnehmer-E-Mail
|
participantUserEmail | string |
Die E-Mail des Teilnehmers für das Ereignis. |
|
Ereignis-Handelnde Benutzer-ID
|
actingUserId | string |
Die ID des Benutzers, der das Ereignis erstellt hat. |
|
Ereignis-Handelnde Benutzer-E-Mail
|
actingUserEmail | string |
Die E-Mail des Benutzers, der das Ereignis erstellt hat. |
|
Ereignis-handelnde Benutzer-IP-Adresse
|
actingUserIpAddress | string |
Die IP-Adresse des Benutzers, der das Ereignis erstellt hat |
|
Aktionstyp
|
actionType | string |
Die Aktion, für die das Ereignis aufgetreten ist. |
|
Ereignisinitiierung der Benutzer-ID
|
initiatingUserId | string |
Die ID des Benutzers, der das Ereignis im Auftrag des handelnden Benutzers initiiert hat |
|
Ereignis, das Benutzer-E-Mail initiiert
|
initiatingUserEmail | string |
Die E-Mail des Benutzers, der das Ereignis im Auftrag des handelnden Benutzers initiiert hat. |
|
Ereignisressourcentyp
|
eventResourceType | string |
Die Ressource, für die das Ereignis aufgetreten ist. |
|
Rolle "Ereignisteilnehmer"
|
participantRole | string |
Die Rolle des Teilnehmers für das Ereignis. |
|
Benachrichtigung anwendbare Benutzer
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
Eine Liste der Benutzer, für die diese Benachrichtigung anwendbar ist |
|
Vereinbarung
|
agreement | WebhookAgreementInfoWithSignedDocument |
Die vollständigen Informationen der Vereinbarung |
WebhookPayloadWithSignedDocument
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Event
|
event | string |
Das Ereignis, das für die Ressource aufgetreten ist. |
|
Ereignisdatum
|
eventDate | date |
Das Datum des Ereignisses. Format wäre yyyy-MM-dd'T'HH:mm:ssZ. Beispiel: 2016-02-25T18:46:19Z stellt UTC-Zeit dar. |
|
Übergeordneter Vereinbarungstyp
|
eventResourceParentType | string |
Informationen zur Ressource, aus der die Vereinbarung erstellt wird. Mögliche Werte: Webformular oder Megazeichen |
|
Übergeordnete Vereinbarungs-ID
|
eventResourceParentId | string |
Eine eindeutige ID der Ressource, aus der diese Vereinbarung erstellt wird |
|
Ereignisressourcentyp
|
eventResourceType | string |
Die Ressource, für die das Ereignis aufgetreten ist. |
|
Rolle "Ereignisteilnehmer"
|
participantRole | string |
Die Rolle des Teilnehmers für das Ereignis. |
|
Ereignisteilnehmer-ID
|
participantUserId | string |
Die ID des Teilnehmers für das Ereignis. |
|
Ereignisteilnehmer-E-Mail
|
participantUserEmail | string |
Die E-Mail des Teilnehmers für das Ereignis. |
|
Ereignis-Handelnde Benutzer-ID
|
actingUserId | string |
Die ID des Benutzers, der das Ereignis erstellt hat. |
|
Ereignis-Handelnde Benutzer-E-Mail
|
actingUserEmail | string |
Die E-Mail des Benutzers, der das Ereignis erstellt hat. |
|
Ereignis-handelnde Benutzer-IP-Adresse
|
actingUserIpAddress | string |
Die IP-Adresse des Benutzers, der das Ereignis erstellt hat |
|
Ereignisinitiierung der Benutzer-ID
|
initiatingUserId | string |
Die ID des Benutzers, der das Ereignis im Auftrag des handelnden Benutzers initiiert hat |
|
Ereignis, das Benutzer-E-Mail initiiert
|
initiatingUserEmail | string |
Die E-Mail des Benutzers, der das Ereignis im Auftrag des handelnden Benutzers initiiert hat. |
|
Benachrichtigung anwendbare Benutzer
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
Eine Liste der Benutzer, für die diese Benachrichtigung anwendbar ist |
|
Vereinbarung
|
agreement | WebhookAgreementInfoWithSignedDocument |
Die vollständigen Informationen der Vereinbarung |
WebhookPayloadGeneric
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Event
|
event | string |
Das Ereignis, das für die Ressource aufgetreten ist. |
|
Ereignisdatum
|
eventDate | date |
Das Datum des Ereignisses. Format wäre yyyy-MM-dd'T'HH:mm:ssZ. Beispiel: 2016-02-25T18:46:19Z stellt UTC-Zeit dar. |
|
Sub-Ereignis
|
subEvent | string |
Das Unterereignis, das für eine Ressource aufgetreten ist. |
|
Übergeordneter Vereinbarungstyp
|
eventResourceParentType | string |
Informationen zur Ressource, aus der die Vereinbarung erstellt wird. Mögliche Werte: Webformular oder Megazeichen |
|
Übergeordnete Vereinbarungs-ID
|
eventResourceParentId | string |
Eine eindeutige ID der Ressource, aus der diese Vereinbarung erstellt wird |
|
Ereignisressourcentyp
|
eventResourceType | string |
Die Ressource, für die das Ereignis aufgetreten ist. |
|
Rolle "Ereignisteilnehmer"
|
participantRole | string |
Die Rolle des Teilnehmers für das Ereignis. |
|
Ereignisteilnehmer-ID
|
participantUserId | string |
Die ID des Teilnehmers für das Ereignis. |
|
Ereignisteilnehmer-E-Mail
|
participantUserEmail | string |
Die E-Mail des Teilnehmers für das Ereignis. |
|
Ereignis-Handelnde Benutzer-ID
|
actingUserId | string |
Die ID des Benutzers, der das Ereignis erstellt hat. |
|
Ereignis-Handelnde Benutzer-E-Mail
|
actingUserEmail | string |
Die E-Mail des Benutzers, der das Ereignis erstellt hat. |
|
Ereignisinitiierung der Benutzer-ID
|
initiatingUserId | string |
Die ID des Benutzers, der das Ereignis im Auftrag des handelnden Benutzers initiiert hat |
|
Ereignis, das Benutzer-E-Mail initiiert
|
initiatingUserEmail | string |
Die E-Mail des Benutzers, der das Ereignis im Auftrag des handelnden Benutzers initiiert hat. |
|
Aktionstyp
|
actionType | string |
Die Aktion, für die das Ereignis aufgetreten ist. |
|
Ereignis-handelnde Benutzer-IP-Adresse
|
actingUserIpAddress | string |
Die IP-Adresse des Benutzers, der das Ereignis erstellt hat |
|
Benachrichtigung anwendbare Benutzer
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
Eine Liste der Benutzer, für die diese Benachrichtigung anwendbar ist |
|
Vereinbarung
|
agreement | WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo |
Die vollständigen Informationen der Vereinbarung |
|
Megazeichen
|
megaSign | WebhookMegaSignInfo |
Die vollständigen Informationen des Megazeichens |
|
Webformular
|
widget | WebhookWidgetInfo |
Die vollständigen Informationen des Webformulars |
WebFormWebhookAgreementEventPayload
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Event
|
event | string |
Das Vereinbarungsereignis, das im Webformular aufgetreten ist. |
|
Ereignisdatum
|
eventDate | date |
Das Datum des Ereignisses. Format wäre yyyy-MM-dd'T'HH:mm:ssZ. Beispiel: 2016-02-25T18:46:19Z stellt UTC-Zeit dar. |
|
Sub-Ereignis
|
subEvent | string |
Das Unterereignis, das in einem Webformular aufgetreten ist. |
|
Übergeordneter Vertragstyp - Webformular
|
eventResourceParentType | string |
Wert, der angibt, dass eine Vereinbarung aus dem Webformular erstellt wird. |
|
Webformular-ID
|
eventResourceParentId | string |
Eine eindeutige ID des Webformulars, aus dem diese Vereinbarung erstellt wird |
|
Ereignisressourcentyp – Vereinbarung
|
eventResourceType | string |
Die Ressource, für die das Ereignis aufgetreten ist. |
|
Rolle "Ereignisteilnehmer"
|
participantRole | string |
Die Rolle des Teilnehmers für das Ereignis. |
|
Ereignisteilnehmer-ID
|
participantUserId | string |
Die ID des Teilnehmers für das Ereignis. |
|
Ereignisteilnehmer-E-Mail
|
participantUserEmail | string |
Die E-Mail des Teilnehmers für das Ereignis. |
|
Ereignis-Handelnde Benutzer-ID
|
actingUserId | string |
Die ID des Benutzers, der das Ereignis erstellt hat. |
|
Ereignis-Handelnde Benutzer-E-Mail
|
actingUserEmail | string |
Die E-Mail des Benutzers, der das Ereignis erstellt hat. |
|
Ereignisinitiierung der Benutzer-ID
|
initiatingUserId | string |
Die ID des Benutzers, der das Ereignis im Auftrag des handelnden Benutzers initiiert hat |
|
Ereignis, das Benutzer-E-Mail initiiert
|
initiatingUserEmail | string |
Die E-Mail des Benutzers, der das Ereignis im Auftrag des handelnden Benutzers initiiert hat. |
|
Aktionstyp
|
actionType | string |
Die Aktion, für die das Ereignis aufgetreten ist. |
|
Ereignis-handelnde Benutzer-IP-Adresse
|
actingUserIpAddress | string |
Die IP-Adresse des Benutzers, der das Ereignis erstellt hat |
|
Benachrichtigung anwendbare Benutzer
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
Eine Liste der Benutzer, für die diese Benachrichtigung anwendbar ist |
|
Vereinbarung
|
agreement | WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo |
Die vollständigen Informationen der Vereinbarung |
GroupWebhookEventPayload
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Event
|
event | string |
Das Ereignis, das für eine Gruppe aufgetreten ist. |
|
Ereignisdatum
|
eventDate | date |
Das Datum des Ereignisses. Format wäre yyyy-MM-dd'T'HH:mm:ssZ. Beispiel: 2016-02-25T18:46:19Z stellt UTC-Zeit dar. |
|
Sub-Ereignis
|
subEvent | string |
Das Unterereignis, das für eine Gruppe aufgetreten ist. |
|
Übergeordneter Vertragstyp - Webformular
|
eventResourceParentType | string |
Informationen zur Gruppe, aus der die Vereinbarung erstellt wird. |
|
Webformular-ID
|
eventResourceParentId | string |
Eine eindeutige ID der Gruppe, aus der diese Vereinbarung erstellt wird |
|
Ereignisressourcentyp – Vereinbarung
|
eventResourceType | string |
Die Gruppe, für die das Ereignis aufgetreten ist. |
|
Rolle "Ereignisteilnehmer"
|
participantRole | string |
Die Rolle des Teilnehmers für das Ereignis. |
|
Ereignisteilnehmer-ID
|
participantUserId | string |
Die ID des Teilnehmers für das Ereignis. |
|
Ereignisteilnehmer-E-Mail
|
participantUserEmail | string |
Die E-Mail des Teilnehmers für das Ereignis. |
|
Ereignis-Handelnde Benutzer-ID
|
actingUserId | string |
Die ID des Benutzers, der das Ereignis erstellt hat. |
|
Ereignis-Handelnde Benutzer-E-Mail
|
actingUserEmail | string |
Die E-Mail des Benutzers, der das Ereignis erstellt hat. |
|
Ereignisinitiierung der Benutzer-ID
|
initiatingUserId | string |
Die ID des Benutzers, der das Ereignis im Auftrag des handelnden Benutzers initiiert hat |
|
Ereignis, das Benutzer-E-Mail initiiert
|
initiatingUserEmail | string |
Die E-Mail des Benutzers, der das Ereignis im Auftrag des handelnden Benutzers initiiert hat. |
|
Aktionstyp
|
actionType | string |
Die Aktion, für die das Ereignis aufgetreten ist. |
|
Ereignis-handelnde Benutzer-IP-Adresse
|
actingUserIpAddress | string |
Die IP-Adresse des Benutzers, der das Ereignis erstellt hat |
|
Benachrichtigung anwendbare Benutzer
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
Eine Liste der Benutzer, für die diese Benachrichtigung anwendbar ist |
|
Vereinbarung
|
agreement | WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo |
Die vollständigen Informationen der Vereinbarung |
|
Megazeichen
|
megaSign | WebhookMegaSignInfo |
Die vollständigen Informationen des Megazeichens |
|
Webformular
|
widget | WebhookWidgetInfo |
Die vollständigen Informationen des Webformulars |
WebhookAgreementInfo
Die vollständigen Informationen der Vereinbarung
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die eindeutige ID des Vertrags |
|
Name
|
name | string |
Der Name der Vereinbarung |
|
Signaturtyp
|
signatureType | string |
Gibt den angeforderten Signaturtyp an – E-Signatur oder geschrieben |
|
Der Status
|
status | string |
Der aktuelle Status der Vereinbarung |
|
Ccs
|
ccs | array of CcInfo |
Eine Liste mit einem oder mehreren CCs, die in der Vereinbarungstransaktion kopiert werden. |
|
Erstellungsdatum
|
createdDate | date |
Datum der Erstellung der Vereinbarung |
|
Ablaufzeit
|
expirationTime | string |
Zeitpunkt, zu dem die Vereinbarung abläuft und vor derEn Unterzeichnung erforderlich ist |
|
Externe ID
|
externalId.id | string |
Ein beliebiger Wert aus Ihrem System, der zur Sendezeit angegeben und dann später zurückgegeben oder abgefragt werden kann |
|
Externe Gruppe
|
externalId.group | string |
Ein beliebiger Wert aus Ihrem System, der zur Sendezeit angegeben und dann später zurückgegeben oder abgefragt werden kann |
|
Erste Erinnerungsverzögerung
|
firstReminderDelay | integer |
Ganze Zahl, die die Verzögerung in Stunden vor dem Senden der ersten Erinnerung angibt. |
|
Gebietsschema
|
locale | string |
Das Gebietsschema, das dieser Vereinbarung zugeordnet ist |
|
Nachricht
|
message | string |
Eine optionale Nachricht an die Teilnehmer, die beschreibt, was gesendet wird oder warum ihre Signatur erforderlich ist |
|
Erinnerungshäufigkeit
|
reminderFrequency | string |
Optionaler Parameter, der festlegt, wie oft Erinnerungen an die Teilnehmer gesendet werden sollen. Wenn sie nicht angegeben ist, wird die für das Konto festgelegte Standardhäufigkeit verwendet. |
|
Absender-E-Mail
|
senderEmail | string |
E-Mail-Absender des Vertrags |
|
Tresor aktiviert?
|
vaultingInfo.enabled | boolean |
Bei Konten, die für das Dokumententresoring eingerichtet sind, und die Option, die pro Vereinbarung aktiviert werden soll, bestimmt dies, ob das Dokument tresoriert werden soll. |
|
Dokumentsichtbarkeit?
|
documentVisibilityEnabled | boolean |
Ist die Dokumentsichtbarkeit aktiviert |
|
Workflow-ID
|
workflowId | string |
Die ID des benutzerdefinierten Workflows, der den Routingpfad einer Vereinbarung definiert. |
|
Url der Umleitung nach dem Signieren
|
postSignOption.redirectUrl | string |
Eine öffentlich zugängliche URL, an die der Benutzer gesendet wird, nachdem der Signiervorgang erfolgreich abgeschlossen wurde |
|
Teilnehmersätze
|
participantSetsInfo.participantSets | array of WebhookParticipantSets |
Der Teilnehmer legt Informationen fest |
|
Nächste Teilnehmersätze
|
participantSetsInfo.nextParticipantSets | array of WebhookParticipantSets |
Der nächste Teilnehmer legt Informationen fest |
|
Dokumente
|
documentsInfo.documents | array of WebhookDocument |
Eine Liste von Objekten, die die Dokumente darstellen |
|
Belege
|
documentsInfo.supportingDocuments | array of WebhookSupportingDocument |
Eine Liste der unterstützenden Dokumente |
WebhookAgreementInfoWithoutNextParticipantSet
Die vollständigen Informationen der Vereinbarung
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die eindeutige ID des Vertrags |
|
Name
|
name | string |
Der Name der Vereinbarung |
|
Signaturtyp
|
signatureType | string |
Gibt den angeforderten Signaturtyp an – E-Signatur oder geschrieben |
|
Der Status
|
status | string |
Der aktuelle Status der Vereinbarung |
|
Ccs
|
ccs | array of CcInfo |
Eine Liste mit einem oder mehreren CCs, die in der Vereinbarungstransaktion kopiert werden. |
|
Erstellungsdatum
|
createdDate | date |
Datum der Erstellung der Vereinbarung |
|
Dokumentsichtbarkeit?
|
documentVisibilityEnabled | boolean |
Ist die Dokumentsichtbarkeit aktiviert |
|
Ablaufzeit
|
expirationTime | string |
Zeitpunkt, zu dem die Vereinbarung abläuft und vor derEn Unterzeichnung erforderlich ist |
|
Externe ID
|
externalId.id | string |
Ein beliebiger Wert aus Ihrem System, der zur Sendezeit angegeben und dann später zurückgegeben oder abgefragt werden kann |
|
Externe Gruppe
|
externalId.group | string |
Ein beliebiger Wert aus Ihrem System, der zur Sendezeit angegeben und dann später zurückgegeben oder abgefragt werden kann |
|
Erste Erinnerungsverzögerung
|
firstReminderDelay | integer |
Ganze Zahl, die die Verzögerung in Stunden vor dem Senden der ersten Erinnerung angibt. |
|
Gebietsschema
|
locale | string |
Das Gebietsschema, das dieser Vereinbarung zugeordnet ist |
|
Nachricht
|
message | string |
Eine optionale Nachricht an die Teilnehmer, die beschreibt, was gesendet wird oder warum ihre Signatur erforderlich ist |
|
Erinnerungshäufigkeit
|
reminderFrequency | string |
Optionaler Parameter, der festlegt, wie oft Erinnerungen an die Teilnehmer gesendet werden sollen. Wenn sie nicht angegeben ist, wird die für das Konto festgelegte Standardhäufigkeit verwendet. |
|
Absender-E-Mail
|
senderEmail | string |
E-Mail-Absender des Vertrags |
|
Tresor aktiviert?
|
vaultingInfo.enabled | boolean |
Bei Konten, die für das Dokumententresoring eingerichtet sind, und die Option, die pro Vereinbarung aktiviert werden soll, bestimmt dies, ob das Dokument tresoriert werden soll. |
|
Url der Umleitung nach dem Signieren
|
postSignOption.redirectUrl | string |
Eine öffentlich zugängliche URL, an die der Benutzer gesendet wird, nachdem der Signiervorgang erfolgreich abgeschlossen wurde |
|
Workflow-ID
|
workflowId | string |
Die ID des benutzerdefinierten Workflows, der den Routingpfad einer Vereinbarung definiert. |
|
Teilnehmersätze
|
participantSetsInfo.participantSets | array of WebhookParticipantSets |
Der Teilnehmer legt Informationen fest |
WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo
Die vollständigen Informationen der Vereinbarung
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die eindeutige ID des Vertrags |
|
Name
|
name | string |
Der Name der Vereinbarung |
|
Signaturtyp
|
signatureType | string |
Gibt den angeforderten Signaturtyp an – E-Signatur oder geschrieben |
|
Der Status
|
status | string |
Der aktuelle Status der Vereinbarung |
|
Ccs
|
ccs | array of CcInfo |
Eine Liste mit einem oder mehreren CCs, die in der Vereinbarungstransaktion kopiert werden. |
|
Erstellungsdatum
|
createdDate | date |
Datum der Erstellung der Vereinbarung |
|
Ablaufzeit
|
expirationTime | string |
Zeitpunkt, zu dem die Vereinbarung abläuft und vor derEn Unterzeichnung erforderlich ist |
|
Externe ID
|
externalId.id | string |
Ein beliebiger Wert aus Ihrem System, der zur Sendezeit angegeben und dann später zurückgegeben oder abgefragt werden kann |
|
Externe Gruppe
|
externalId.group | string |
Ein beliebiger Wert aus Ihrem System, der zur Sendezeit angegeben und dann später zurückgegeben oder abgefragt werden kann |
|
Erste Erinnerungsverzögerung
|
firstReminderDelay | integer |
Ganze Zahl, die die Verzögerung in Stunden vor dem Senden der ersten Erinnerung angibt. |
|
Gebietsschema
|
locale | string |
Das Gebietsschema, das dieser Vereinbarung zugeordnet ist |
|
Nachricht
|
message | string |
Eine optionale Nachricht an die Teilnehmer, die beschreibt, was gesendet wird oder warum ihre Signatur erforderlich ist |
|
Erinnerungshäufigkeit
|
reminderFrequency | string |
Optionaler Parameter, der festlegt, wie oft Erinnerungen an die Teilnehmer gesendet werden sollen. Wenn sie nicht angegeben ist, wird die für das Konto festgelegte Standardhäufigkeit verwendet. |
|
Url der Umleitung nach dem Signieren
|
postSignOption.redirectUrl | string |
Eine öffentlich zugängliche URL, an die der Benutzer gesendet wird, nachdem der Signiervorgang erfolgreich abgeschlossen wurde |
|
Workflow-ID
|
workflowId | string |
Die ID des benutzerdefinierten Workflows, der den Routingpfad einer Vereinbarung definiert. |
|
Absender-E-Mail
|
senderEmail | string |
E-Mail-Absender des Vertrags |
|
Dokumentsichtbarkeit?
|
documentVisibilityEnabled | boolean |
Ist die Dokumentsichtbarkeit aktiviert |
|
Tresor aktiviert?
|
vaultingInfo.enabled | boolean |
Bei Konten, die für das Dokumententresoring eingerichtet sind, und die Option, die pro Vereinbarung aktiviert werden soll, bestimmt dies, ob das Dokument tresoriert werden soll. |
|
Teilnehmersätze
|
participantSetsInfo.participantSets | array of WebhookParticipantSets |
Der Teilnehmer legt Informationen fest |
|
Nächste Teilnehmersätze
|
participantSetsInfo.nextParticipantSets | array of WebhookParticipantSets |
Der nächste Teilnehmer legt Informationen fest |
|
Dokumente
|
documentsInfo.documents | array of WebhookDocument |
Eine Liste von Objekten, die die Dokumente darstellen |
|
Belege
|
documentsInfo.supportingDocuments | array of WebhookSupportingDocument |
Eine Liste der Unterstützenden Dokumente Dies wird nur zurückgegeben, wenn in der Vereinbarung unterstützende Dokumente vorhanden sind. |
|
Signierte Dokumentinformationen
|
signedDocumentInfo.document | string |
Eine base64-codierte Zeichenfolge des signierten Dokuments |
WebhookAgreementInfoWithSignedDocument
Die vollständigen Informationen der Vereinbarung
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die eindeutige ID des Vertrags |
|
Name
|
name | string |
Der Name der Vereinbarung |
|
Signaturtyp
|
signatureType | string |
Gibt den angeforderten Signaturtyp an – E-Signatur oder geschrieben |
|
Der Status
|
status | string |
Der aktuelle Status der Vereinbarung |
|
Ccs
|
ccs | array of CcInfo |
Eine Liste mit einem oder mehreren CCs, die in der Vereinbarungstransaktion kopiert werden |
|
Erstellungsdatum
|
createdDate | date |
Datum der Erstellung der Vereinbarung |
|
Dokumentsichtbarkeit?
|
documentVisibilityEnabled | boolean |
Ist die Dokumentsichtbarkeit aktiviert |
|
Ablaufzeit
|
expirationTime | string |
Zeitpunkt, zu dem die Vereinbarung abläuft und vor derEn Unterzeichnung erforderlich ist |
|
Externe ID
|
externalId.id | string |
Ein beliebiger Wert aus Ihrem System, der zur Sendezeit angegeben und dann später zurückgegeben oder abgefragt werden kann |
|
Externe Gruppe
|
externalId.group | string |
Ein beliebiger Wert aus Ihrem System, der zur Sendezeit angegeben und dann später zurückgegeben oder abgefragt werden kann |
|
Erste Erinnerungsverzögerung
|
firstReminderDelay | integer |
Ganze Zahl, die die Verzögerung in Stunden vor dem Senden der ersten Erinnerung angibt. |
|
Gebietsschema
|
locale | string |
Das Gebietsschema, das dieser Vereinbarung zugeordnet ist |
|
Nachricht
|
message | string |
Eine optionale Nachricht an die Teilnehmer, die beschreibt, was gesendet wird oder warum ihre Signatur erforderlich ist |
|
Erinnerungshäufigkeit
|
reminderFrequency | string |
Optionaler Parameter, der festlegt, wie oft Erinnerungen an die Teilnehmer gesendet werden sollen. Wenn sie nicht angegeben ist, wird die für das Konto festgelegte Standardhäufigkeit verwendet. |
|
Absender-E-Mail
|
senderEmail | string |
E-Mail-Absender des Vertrags |
|
Tresor aktiviert?
|
vaultingInfo.enabled | boolean |
Bei Konten, die für das Dokumententresoring eingerichtet sind, und die Option, die pro Vereinbarung aktiviert werden soll, bestimmt dies, ob das Dokument tresoriert werden soll. |
|
Url der Umleitung nach dem Signieren
|
postSignOption.redirectUrl | string |
Eine öffentlich zugängliche URL, an die der Benutzer gesendet wird, nachdem der Signiervorgang erfolgreich abgeschlossen wurde |
|
Workflow-ID
|
workflowId | string |
Die ID des benutzerdefinierten Workflows, der den Routingpfad einer Vereinbarung definiert. |
|
Teilnehmersätze
|
participantSetsInfo.participantSets | array of WebhookParticipantSets |
Der Teilnehmer legt Informationen fest |
|
Dokumente
|
documentsInfo.documents | array of WebhookDocument |
Eine Liste von Objekten, die die Dokumente darstellen |
|
Belege
|
documentsInfo.supportingDocuments | array of WebhookSupportingDocument |
Eine Liste der Unterstützenden Dokumente Dies wird nur zurückgegeben, wenn in der Vereinbarung unterstützende Dokumente vorhanden sind. |
|
Signierte Dokumentinformationen
|
signedDocumentInfo.document | string |
Eine base64-codierte Zeichenfolge des signierten Dokuments |
WebhookMegaSignInfo
Die vollständigen Informationen des Megazeichens
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die eindeutige ID des Megazeichens |
|
Name
|
name | string |
Der Name des Megazeichens |
|
Der Status
|
status | string |
Der Status des Megazeichens |
|
Ccs
|
ccs | array of MegaSignCcInfo |
Eine Liste mit einer oder mehreren E-Mail-Adressen, die Sie auf dieses Megazeichen kopieren möchten. |
|
Externe ID
|
externalId.id | string |
Ein beliebiger Wert aus Ihrem System, der zur Sendezeit angegeben und dann später zurückgegeben oder abgefragt werden kann |
|
Erste Erinnerungsverzögerung
|
firstReminderDelay | integer |
Ganze Zahl, die die Verzögerung in Stunden vor dem Senden der ersten Erinnerung angibt. |
|
Gebietsschema
|
locale | string |
Das Gebietsschema, das dieser Vereinbarung zugeordnet ist |
|
Nachricht
|
message | string |
Eine optionale Nachricht an die Teilnehmer, die beschreibt, was gesendet wird oder warum ihre Signatur erforderlich ist |
|
Url der Umleitung nach dem Signieren
|
postSignOption.redirectUrl | string |
Eine öffentlich zugängliche URL, an die der Benutzer gesendet wird, nachdem der Signiervorgang erfolgreich abgeschlossen wurde |
|
Absender-E-Mail
|
senderEmail | string |
E-Mail von Megasign Creator |
|
Signaturtyp
|
signatureType | string |
Gibt den angeforderten Signaturtyp an – E-Signatur oder geschrieben |
|
Tresor aktiviert?
|
vaultingInfo.enabled | boolean |
Bei Konten, die für das Dokumententresoring eingerichtet sind, und die Option, die pro Vereinbarung aktiviert werden soll, bestimmt dies, ob das Dokument tresoriert werden soll. |
|
Dateiinformationen zu untergeordneten Vereinbarungen
|
childAgreementsInfo.fileInfo | MegaSignChildAgreementsFileInfo |
Dateiinformationen, die pro untergeordneter Vereinbarung informationen von megaSign enthalten. |
WebhookWidgetInfo
Die vollständigen Informationen des Webformulars
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die eindeutige ID des Webformulars |
|
Name
|
name | string |
Der Name des Webformulars |
|
Der Status
|
status | string |
Der Status des Webformulars |
|
Informationen zu Authentifizierungsfehlern
|
authFailureInfo | AuthFailureWidgetRedirectionInfo |
DIE URL und die zugehörigen Eigenschaften für die Fehlerseite, die der Webformular-Signierer nach einem Fehler bei der Authentifizierung ausgeführt wird. |
|
Ccs
|
ccs | array of WidgetCcInfo |
Eine Liste mit einer oder mehreren E-Mail-Adressen, die Sie in dieses Webformular kopieren möchten. |
|
Erstellungsdatum
|
createdDate | date |
Datum der Erstellung eines Webformulars |
|
Abschlussinformationen
|
completionInfo | WidgetCompletionRedirectionInfo |
URL und zugeordnete Eigenschaften für die Erfolgsseite, an die der Webformular-Signierer nach dem Ausführen der gewünschten Aktion im Webformular ausgeführt wird |
|
Creator-E-Mail
|
creatorEmail | string |
Die E-Mail des Erstellers des Webformulars |
|
Tresor aktiviert?
|
vaultingInfo.enabled | boolean |
Bei Konten, die für das Dokumententresoring eingerichtet sind, und die Option, die pro Vereinbarung aktiviert werden soll, bestimmt dies, ob das Dokument tresoriert werden soll. |
|
Zusätzliche Teilnehmersätze
|
participantSetsInfo.additionalParticipantSets | array of WidgetParticipantSetInfo |
Liste aller Teilnehmer im Webformular mit Ausnahme des Webformulars |
|
Rolle "First Participant Set"
|
participantSetsInfo.widgetParticipantSet.role | string |
Rolle, die von allen Teilnehmern des Satzes angenommen wird (Signierer, Genehmigender usw.) |
|
First Participant Set Order
|
participantSetsInfo.widgetParticipantSet.order | integer |
Index, der die sequenzielle Signaturgruppe angibt (für hybrides Routing angegeben) |
|
Dokumente
|
documentsInfo.documents | array of WidgetWebhookDocument |
Eine Liste von Objekten, die die Dokumente darstellen |
AuthFailureWidgetRedirectionInfo
DIE URL und die zugehörigen Eigenschaften für die Fehlerseite, die der Webformular-Signierer nach einem Fehler bei der Authentifizierung ausgeführt wird.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Verzögerung bei Auth-Fehlerumleitung
|
delay | integer |
Die Verzögerung (in Sekunden), bevor der Benutzer zur resultierenden Seite weitergeleitet wird |
|
Authentifizierungsfehlerumleitungs-Deframe
|
deframe | boolean |
Wenn der Deframe falsch ist, wird die resultierende Seite im Webformularframe angezeigt. |
|
Url der Authentifizierungsfehlerumleitung
|
url | string |
Eine öffentlich zugängliche URL, an die der Benutzer gesendet wird, nachdem das Webformular erfolgreich abgeschlossen wurde |
WidgetCompletionRedirectionInfo
URL und zugeordnete Eigenschaften für die Erfolgsseite, an die der Webformular-Signierer nach dem Ausführen der gewünschten Aktion im Webformular ausgeführt wird
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Vervollständigungsumleitungsverzöger
|
delay | integer |
Die Verzögerung (in Sekunden), bevor der Benutzer zur resultierenden Seite weitergeleitet wird |
|
Abschlussumleitungs-Deframe
|
deframe | boolean |
Wenn der Deframe falsch ist, wird die resultierende Seite im Webformularframe angezeigt. |
|
Url der Vervollständigungsumleitung
|
url | string |
Eine öffentlich zugängliche URL, an die der Benutzer gesendet wird, nachdem das Webformular erfolgreich abgeschlossen wurde |
WebhookParticipantSets
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Mitgliedsinfos
|
memberInfos | array of MemberInfos |
Die Informationen zu Teilnehmermitgliedern |
|
Bestellung
|
order | integer |
Index, der angibt, an welcher Position die Signiergruppe signieren muss. |
|
Rolle
|
role | string |
Rolle, die von allen Teilnehmern des Satzes angenommen wird (Signierer, Genehmigender usw.) |
|
Der Status
|
status | string |
Aktueller Status der Vereinbarung aus Sicht des Benutzers |
|
ID
|
id | string |
Die ID des Teilnehmersatzes |
|
Name
|
name | string |
Der Name des Teilnehmersatzes |
|
Private Nachricht
|
privateMessage | string |
Private Nachricht für die Teilnehmer im Satz |
MegaSignChildAgreementsFileInfo
Dateiinformationen, die pro untergeordneter Vereinbarung informationen von megaSign enthalten.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Datei-ID für untergeordnete Vereinbarungen
|
childAgreementsInfoFileId | string |
Die ID der Datei, die Informationen über das vorhandene childAgreementsInfo des megaSign enthält. |
WidgetWebhookDocument
Die Informationen zum Dokument des Webformulars
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die eindeutige ID des Dokuments |
|
Name
|
name | string |
Der Name des Dokuments |
WebhookDocument
Die Informationen über das Dokument der Vereinbarung
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die eindeutige ID des Dokuments |
|
Name
|
name | string |
Der Name des Dokuments |
WebhookSupportingDocument
Die Informationen zum Unterstützenden Dokument
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Name
|
displayLabel | string |
Anzeigename des unterstützenden Dokuments |
|
Feldname
|
fieldName | string |
Der Name des unterstützenden Dokumentfelds |
|
ID
|
id | string |
Die eindeutige ID, die das unterstützende Dokument darstellt |
WidgetCcInfo
Die Informationen zum CC des Webformulars
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Email
|
string |
E-Mail des CC-Teilnehmers des Webformulars |
MegaSignCcInfo
Die Informationen zum CC des Megazeichens
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Email
|
string |
E-Mail des CC-Teilnehmers des Megazeichens |
CcInfo
Die Informationen über das CC des Vertrags
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Email
|
string |
Die E-Mail des CC des Vertrags |
|
|
Etikett
|
label | string |
Die Bezeichnung der CC-Liste, wie in der Workflowbeschreibung zurückgegeben |
|
Sichtbare Seiten
|
visiblePages | array of string |
Die Seiten, die für die CC sichtbar sind |
WidgetParticipantSetInfo
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Rolle
|
role | string |
Rolle, die von allen Teilnehmern des Satzes angenommen wird (Signierer, Genehmigender usw.) |
|
ID
|
id | string |
Der eindeutige Bezeichner des Teilnehmersatzes |
|
Mitgliedsinfos
|
memberInfos | array of MemberInfos |
Die Informationen über die Teilnehmermitglieder |
|
Bestellung
|
order | integer |
Index, der die sequenzielle Signaturgruppe angibt (für hybrides Routing angegeben) |
MemberInfos
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die eindeutige ID des Teilnehmers |
|
Email
|
string |
Die E-Mail des Teilnehmers |
|
|
Firma
|
company | string |
Die Gesellschaft des Teilnehmers |
|
Name
|
name | string |
Der Name des Teilnehmers |
|
Private Nachricht
|
privateMessage | string |
Die private Nachricht des Teilnehmers |
|
Der Status
|
status | string |
Der Status des Teilnehmers |
LibraryDocumentCreationResponseV6
Ein JSON-Objekt, das die Bibliotheksvorlage beschreibt
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Bibliotheksvorlagen-ID
|
id | string |
Die eindeutige ID, die verwendet werden kann, um auf die Bibliotheksvorlage zu verweisen |
LibraryDocument
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Bibliotheksvorlagen-ID
|
id | string |
Der eindeutige Bezeichner, der zum Verweisen auf die Bibliotheksvorlage verwendet wird |
|
Versteckt
|
hidden | boolean |
True, wenn Bibliotheksdokument ausgeblendet ist |
|
Vorlagentyp(n)
|
templateTypes | array of string |
Eine Liste mit einem oder mehreren Bibliotheksvorlagentypen |
|
Änderungsdatum
|
modifiedDate | date |
Der Tag, an dem die Bibliotheksvorlage zuletzt geändert wurde |
|
Name der Bibliotheksvorlage
|
name | string |
Der Name der Bibliotheksvorlage |
|
Vorlagenfreigabemodus
|
sharingMode | string |
Der Bereich der Sichtbarkeit der Bibliotheksvorlage |
|
Creator-E-Mail
|
creatorEmail | string |
E-Mail-Adresse des Dokumenterstellers der Bibliothek. |
|
Gruppen-ID
|
groupId | string |
Der eindeutige Bezeichner der Gruppe, zu der die Bibliotheksvorlage gehört. |
|
Der Status
|
status | string |
Status des Bibliotheksdokuments |
LibraryDocuments
Ein JSON-Objekt, das das Arrayobjekt der Bibliotheksvorlage enthält
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Seite
|
page | page |
Paginierungsinformationen zum Navigieren durch die Antwort |
|
Bibliotheksvorlagenliste
|
libraryDocumentList | array of LibraryDocument |
Eine Liste der Bibliotheksvorlagenelemente |
UserWidgetV6
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Webformular-ID
|
id | string |
Der eindeutige Bezeichner eines Webformulars |
|
Änderungsdatum
|
modifiedDate | string |
Das Datum, an dem das Webformular zuletzt geändert wurde |
|
Versteckt
|
hidden | boolean |
True, wenn die Vereinbarung für den Benutzer ausgeblendet ist |
|
Gruppen-ID
|
groupId | string |
Eindeutiger Bezeichner der Gruppe |
|
Name
|
name | string |
Der Name des Webformulars |
|
Der Status
|
status | string |
Der Webformularstatus |
|
URL
|
url | string |
Die gehostete URL des Webformulars |
|
Javascript
|
javascript | string |
Der eingebettete Javascript-Code des Webformulars |
userWidgetListV6
Ein JSON-Objekt, das das Arrayobjekt des Benutzerwebformulars enthält
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Seite
|
page | page |
Paginierungsinformationen zum Navigieren durch die Antwort |
|
Webformularliste
|
userWidgetList | array of UserWidgetV6 |
Ein Array von Webformularelementen |
UserWorkflowV6
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Workflow-ID
|
id | string |
Der eindeutige Bezeichner eines Workflows |
|
Description
|
description | string |
Beschreibung für diesen Workflow zum Zeitpunkt der Erstellung |
|
Erstellt am
|
created | string |
Das Datum, an dem der Workflow erstellt wurde. Format wäre yyyy-MM-dd'T'HH:mm:ssZ |
|
Änderungsdatum
|
modified | string |
Das Datum, an dem der Workflow geändert wurde. Format wäre yyyy-MM-dd'T'HH:mm:ssZ |
|
Name
|
name | string |
Der Name des Workflows |
|
Anzeigename
|
displayName | string |
Der Anzeigename des Workflows |
|
Der Status
|
status | string |
Der Workflowstatus |
|
Umfang
|
scope | string |
Der Workflowbereich |
|
Absender-ID
|
originatorId | string |
Ursprünglicher Absender des Workflows |
|
Bereichs-ID
|
scopeId | string |
Bezeichner des Bereichs. Derzeit gilt sie nur für den Bereich GROUP, und der Wert ist "groupId". |
userWorkflowListV6
Ein JSON-Code, der das Objekt des Benutzerworkflowarrays enthält
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Workflowliste
|
userWorkflowList | array of UserWorkflowV6 |
Ein Array von Workflowelementen |
WorkflowDefaultParamsV6
Ein JSON-Code, der das Workflowstandard-Params-Objekt enthält
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Standardwert
|
defaultValue | string |
Standardwert des Felds, wenn keine Eingabe für dieses Feld angegeben wird und dieses Feld erforderlich ist |
|
Bearbeitbar
|
editable | boolean |
Gibt an, ob das aktuelle Feld bearbeitet werden kann. Wenn das bearbeitbare Attribut für dieses Feld falsch ist, sollte dieses Feld nicht in der Anforderung zur Erstellung von Vereinbarungen angegeben werden, und der Standardwert dieses Felds wird bei der Erstellung von Vereinbarungen verwendet. |
|
Erforderlich
|
required | boolean |
Gibt an, ob dieses Feld erforderlich oder optional ist. |
|
Sichtbar
|
visible | boolean |
Gibt an, ob das aktuelle Feld sichtbar ist oder nicht. Wenn das sichtbare Attribut für dieses Feld falsch ist, sollte dieses Feld nicht in der Benutzeroberfläche für die Vertragserstellung angezeigt werden, indem dieser Workflow für Benutzer verwendet wird. |
CCsListInfoDescriptionV6
Ein JSON mit detaillierten Informationen zum Workflow
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Standardwerte
|
defaultValues | array of string |
Ein Array von Standard-E-Mails, die verwendet werden, wenn keine Eingabe für dieses Listenelement bereitgestellt wird |
|
Bearbeitbar
|
editable | boolean |
Gibt an, ob das aktuelle Feld bearbeitet werden kann. Wenn das bearbeitbare Attribut für dieses Feld falsch ist, sollte dieses Feld nicht in der Anforderung zur Erstellung von Vereinbarungen angegeben werden, und der Standardwert dieses Felds wird bei der Erstellung von Vereinbarungen verwendet. |
|
Etikett
|
label | string |
Ein Anzeigetext für den Workflowbenutzer, der für die aktuelle CC-Liste verwendet werden kann |
|
Max CC-Einträge
|
maxListCount | integer |
Maximale Anzahl zulässiger Einträge in der aktuellen CC-Liste |
|
Min CC-Einträge
|
minListCount | integer |
Mindestanzahl zulässiger Einträge in der aktuellen CC-Liste |
|
CC-Listenname
|
name | string |
Name der aktuellen CC-Liste |
|
Erforderlich
|
required | boolean |
Gibt an, ob dieses Feld erforderlich oder optional ist. |
|
Sichtbar
|
visible | boolean |
Gibt an, ob das aktuelle Feld sichtbar ist oder nicht. Wenn das sichtbare Attribut für dieses Feld falsch ist, sollte dieses Feld nicht auf der Seite zum Erstellen von Vereinbarungen mit diesem Workflow angezeigt werden. |
ExpirationFieldInfoDescriptionV6
Ein JSON-Code, der Informationen zum Ablauf enthält
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Standardwert
|
defaultValue | string |
Standardwert des Felds, wenn keine Eingabe für dieses Feld angegeben wird und dieses Feld erforderlich ist |
|
Bearbeitbar
|
editable | boolean |
Gibt an, ob das aktuelle Feld bearbeitet werden kann. Wenn das bearbeitbare Attribut für dieses Feld falsch ist, sollte dieses Feld nicht in der Anforderung zur Erstellung von Vereinbarungen angegeben werden, und der Standardwert dieses Felds wird bei der Erstellung von Vereinbarungen verwendet. |
|
Ablauf der Vereinbarung max. Tage
|
maxDays | integer |
Maximale Anzahl von Tagen für den Ablauf der Vereinbarung |
|
Erforderlich
|
required | boolean |
Gibt an, ob dieses Feld erforderlich oder optional ist. |
|
Sichtbar
|
visible | boolean |
Gibt an, ob das aktuelle Feld sichtbar ist oder nicht. Wenn das sichtbare Attribut für dieses Feld falsch ist, sollte dieses Feld nicht auf der Seite zum Erstellen von Vereinbarungen mit diesem Workflow angezeigt werden. |
FileInfosDescriptionV6
Ein JSON-Code, der Informationen zu Dateien enthält
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Etikett
|
label | string |
Anzeigebezeichnung dieses Felds für externe Benutzer |
|
Name
|
name | string |
Name des FileInfo-Elements |
|
Erforderlich
|
required | boolean |
Gibt an, ob dieses Feld erforderlich oder optional ist. |
|
Workflowbibliotheksdokumente
|
workflowLibraryDocumentSelectorList | array of WorkflowLibraryDocumentV6 |
Eine Liste der Workflowbibliotheksdokumente, aus denen ein Workflowbibliotheksdokument mit diesem fileInfo-Objekt ausgewählt werden kann |
WorkflowLibraryDocumentV6
Ein JSON-Code, der Informationen zu Workflowbibliotheksdokumenten enthält
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Etikett
|
label | string |
Ein Anzeigetext für dieses Formular für Workflowbenutzer |
|
Änderungsdatum
|
modifiedDate | string |
Das Datum, an dem das Bibliotheksdokument zuletzt geändert wurde. Format wäre yyyy-MM-dd'T'HH:mm:ssZ. Beispiel: 2016-02-25T18:46:19Z stellt UTC-Zeit dar. |
|
Freigabemodus
|
sharingMode | string |
Gibt an, wer Zugriff auf dieses Bibliotheksdokument haben soll. DIE GLOBALE Freigabe ist ein eingeschränkter Vorgang. |
|
Vorlagentypen
|
templateTypes | array of |
Eine Liste mit einem oder mehreren Bibliotheksvorlagentypen |
|
Dokument-ID der Workflowbibliothek
|
workflowLibDoc | string |
Eine ID des Workflowbibliotheksdokuments, das als Eingabedatei in der Erstellungsanforderung für benutzerdefinierte Workflowvereinbarungen bereitgestellt werden kann |
LocaleFieldInfoDescriptionV6
Ein JSON mit detaillierten Informationen zum Workflowgebietsschema
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Verfügbare Gebietsschemas
|
availableLocales | array of string |
Welche Gebietsschemas für diesen Workflow ausgewählt werden können |
|
Standardwert
|
defaultValue | string |
Standardwert des Felds, wenn keine Eingabe für dieses Feld angegeben wird und dieses Feld erforderlich ist |
|
Bearbeitbar
|
editable | boolean |
Gibt an, ob das aktuelle Feld bearbeitet werden kann. Wenn das bearbeitbare Attribut für dieses Feld falsch ist, sollte dieses Feld nicht in der Anforderung zur Erstellung von Vereinbarungen angegeben werden, und der Standardwert dieses Felds wird bei der Erstellung von Vereinbarungen verwendet. |
|
Erforderlich
|
required | boolean |
Gibt an, ob dieses Feld erforderlich oder optional ist. |
|
Sichtbar
|
visible | boolean |
Gibt an, ob das aktuelle Feld sichtbar ist oder nicht. Wenn das sichtbare Attribut für dieses Feld falsch ist, sollte dieses Feld nicht in der Benutzeroberfläche für die Vertragserstellung angezeigt werden, indem dieser Workflow für Benutzer verwendet wird. |
MergeFieldInfoDescriptionV6
Json mit detaillierten Informationen zum Seriendruckfeld
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Standardwert
|
defaultValue | string |
Standardwert des Felds, wenn keine Eingabe für dieses Feld angegeben wird und dieses Feld erforderlich ist |
|
Anzeigename
|
displayName | string |
Der Anzeigetext, der für dieses benutzerdefinierte Feld angezeigt werden kann |
|
Bearbeitbar
|
editable | boolean |
Gibt an, ob das aktuelle Feld bearbeitet werden kann. Wenn das bearbeitbare Attribut für dieses Feld falsch ist, sollte dieses Feld nicht in der Anforderung zur Erstellung von Vereinbarungen angegeben werden, und der Standardwert dieses Felds wird bei der Erstellung von Vereinbarungen verwendet. |
|
Name des benutzerdefinierten Felds
|
fieldName | string |
Name des benutzerdefinierten Felds in diesem Workflow |
|
Erforderlich
|
required | boolean |
Gibt an, ob dieses Feld erforderlich oder optional ist. |
|
Sichtbar
|
visible | boolean |
Gibt an, ob das aktuelle Feld auf der Seite zum Erstellen von Vereinbarungen sichtbar sein soll. Wenn das sichtbare Attribut für dieses Feld falsch ist, sollte dieses Feld nicht auf der Seite zum Erstellen von Vereinbarungen mit diesem Workflow angezeigt werden. |
PasswordFieldInfoDescriptionV6
Ein JSON mit detaillierten Informationen zum Kennwort
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Kennwort
|
defaultValue | string |
Standardwert des Felds "Kennwortinformationen" |
|
Bearbeitbar
|
editable | boolean |
Gibt an, ob das aktuelle Feld bearbeitet werden kann. Wenn das bearbeitbare Attribut für dieses Feld falsch ist, sollte dieses Feld nicht in der Anforderung zur Erstellung von Vereinbarungen angegeben werden, und der Standardwert dieses Felds wird bei der Erstellung von Vereinbarungen verwendet. |
|
Etikett
|
label | string |
Bezeichnung des Kennwortfelds |
|
Name
|
name | string |
Name des Kennwortfelds |
|
Erforderlich
|
required | boolean |
Gibt an, ob dieses Feld erforderlich oder optional ist. |
|
Sichtbar
|
visible | boolean |
Gibt an, ob das Feld "Kennwortinformationen" auf der Seite zum Erstellen von Vereinbarungen sichtbar ist. |
RecipientsListInfoDescriptionV6
Ein JSON mit detaillierten Informationen zur Empfängerliste
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Absender zulassen
|
allowSender | boolean |
Gibt an, ob der Absender als Empfänger zulässig ist. |
|
Absender zulassen
|
allowfax | boolean |
Gibt an, ob Fax zulässig ist oder nicht. |
|
Authentifizierungsmethode
|
authenticationMethod | string |
Authentifizierungsmethode für die aktuelle Empfängerliste, um Zugriff auf das Anzeigen und Signieren des Dokuments zu haben, |
|
Standard-E-Mail-/Faxwert
|
defaultValue | string |
Standard-E-Mail- oder Faxnummer |
|
Bearbeitbar
|
editable | boolean |
Gibt an, ob das aktuelle Feld bearbeitet werden kann. Wenn das bearbeitbare Attribut für dieses Feld falsch ist, sollte dieses Feld nicht in der Anforderung zur Erstellung von Vereinbarungen angegeben werden, und der Standardwert dieses Felds wird bei der Erstellung von Vereinbarungen verwendet. |
|
Etikett
|
label | string |
Ein Anzeigetext für den Workflowbenutzer, der für die aktuelle Empfängerliste verwendet werden kann |
|
Maximale Empfängeranzahl
|
maxListCount | integer |
Maximale Anzahl zulässiger Einträge in der aktuellen Empfängerliste |
|
Mindestempfänger
|
minListCount | integer |
Mindestanzahl zulässiger Einträge in der aktuellen Empfängerliste |
|
Name der Empfängerinformationsliste
|
name | string |
Name der aktuellen Empfängerinformationsliste |
|
Teilnehmerrolle
|
role | string |
Die aktuelle Rolle des Teilnehmers |
|
Sichtbar
|
visible | boolean |
Gibt an, ob das aktuelle Feld sichtbar ist. Wenn das sichtbare Attribut für dieses Feld falsch ist, sollte dieses Feld nicht in der Benutzeroberfläche für die Vertragserstellung angezeigt werden, die diesen Workflow für Benutzer verwendet. |
WorkflowDescriptionV6
Ein JSON mit detaillierten Informationen zum Workflow
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
agreementNameInfo
|
agreementNameInfo | WorkflowDefaultParamsV6 |
Ein JSON-Code, der das Workflowstandard-Params-Objekt enthält |
|
authoringInfo
|
authoringInfo | WorkflowDefaultParamsV6 |
Ein JSON-Code, der das Workflowstandard-Params-Objekt enthält |
|
CC-Listeninformationen
|
ccsListInfo | array of CCsListInfoDescriptionV6 |
Informationen zum Feld "CC-Listeneingabe" in der Anforderung zur Erstellung von Vereinbarungen |
|
Erstellungsdatum des Workflows
|
created | string |
Der Tag, an dem der Workflow erstellt wurde |
|
Workflowbeschreibung
|
description | string |
Beschreibung für diesen Workflow zum Zeitpunkt der Erstellung |
|
Anzeigename des Workflows
|
displayName | string |
Der Anzeigename des Workflows |
|
expirationInfo
|
expirationInfo | ExpirationFieldInfoDescriptionV6 |
Ein JSON-Code, der Informationen zum Ablauf enthält |
|
Dateiinformationen
|
fileInfos | array of FileInfosDescriptionV6 |
Informationen zum Eingabefeld für Dateiinformationen in der Anforderung zur Vertragserstellung |
|
localeInfo
|
localeInfo | LocaleFieldInfoDescriptionV6 |
Ein JSON mit detaillierten Informationen zum Workflowgebietsschema |
|
Feldinformationen zusammenführen
|
mergeFieldsInfo | array of MergeFieldInfoDescriptionV6 |
Informationen zum Eingabefeld für benutzerdefinierte Infos in der Anforderung zur Vertragserstellung |
|
messageInfo
|
messageInfo | WorkflowDefaultParamsV6 |
Ein JSON-Code, der das Workflowstandard-Params-Objekt enthält |
|
Änderungsdatum
|
modified | string |
Der Tag, an dem der Workflow zuletzt geändert wurde |
|
Workflowname
|
name | string |
Der Name des Workflows |
|
passwordInfo
|
passwordInfo | PasswordFieldInfoDescriptionV6 |
Ein JSON mit detaillierten Informationen zum Kennwort |
|
Empfängerlisteninformationen
|
recipientsListInfo | array of RecipientsListInfoDescriptionV6 |
Informationen zum Eingabefeld "Recepients" in der Anforderung zur Erstellung von Vereinbarungen |
|
Workflowbereich
|
scope | string |
Der Workflowbereich |
|
Workflowstatus
|
status | string |
Der Workflowstatus |
|
Workflow-Absender-ID
|
originatorId | string |
Ursprünglicher Absender des Workflows |
|
Workflowbereichs-ID
|
scopeId | string |
Bezeichner des Bereichs. Derzeit gilt es nur für den Bereich GROUP, und der Wert ist "groupId" |
BooleanSettingInfoV6
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Wert
|
value | boolean |
Wert der Einstellung |
|
Geerbt
|
inherited | boolean |
True, wenn die Einstellung von der Gruppe oder dem Kontowert geerbt wird |
SettingsInfoV6
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
libaryDocumentCreationVisible
|
libaryDocumentCreationVisible | BooleanSettingInfoV6 | |
|
sendRestrictedToWorkflows
|
sendRestrictedToWorkflows | BooleanSettingInfoV6 | |
|
userCanSend
|
userCanSend | BooleanSettingInfoV6 | |
|
widgetCreationVisible
|
widgetCreationVisible | BooleanSettingInfoV6 |
UserGroupInfoV6
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gruppen-ID
|
id | string |
Eindeutiger Bezeichner der Gruppe |
|
Ist Gruppenadministrator
|
isGroupAdmin | boolean |
True, wenn der Benutzer Gruppenadministrator ist |
|
Ist primäre Gruppe
|
isPrimaryGroup | boolean |
True, wenn die Gruppe die primäre Gruppe des Benutzers ist |
|
Der Status
|
status | string |
Status der Gruppenmitgliedschaft |
|
Erstellt am
|
createdDate | date |
Datumsgruppe wurde erstellt |
|
Gruppenname
|
name | string |
Name der Gruppe |
|
Einstellungen
|
settings | SettingsInfoV6 |
UserGroupsInfoV6
Ein JSON-Code, der die Liste der Gruppen für einen bestimmten Benutzer enthält
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Benutzergruppenliste
|
groupInfoList | array of UserGroupInfoV6 |
Ein Array von Benutzergruppeninformationenelementen |
AgreementViews
Liste der Vereinbarungsansichten
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Vereinbarungsansichtsliste
|
agreementViewList | array of AgreementView |
Vereinbarungsansichten |
AgreementView
Name der erforderlichen Ansicht und der gewünschten Konfiguration.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
URL anzeigen
|
url | string |
URL des Ressourcenspeicherorts |
|
Eingebetteter Code
|
embeddedCode | string |
Eingebetteter Code der URL der Ressource |
|
Ablauf
|
expiration | string |
Ablauf der Benutzer-URL |
|
Ist aktuelle Ansicht
|
isCurrent | boolean |
True, wenn diese Ansicht die aktuelle Ansicht ist |
binär
Dies ist der grundlegende Datentyp "binary".
Objekt
Dies ist der Typ 'object'.
file
Dies ist der grundlegende Datentyp "Datei".