Lex Power Sign (Vorschau)
Lex Persona ist ein europäischer Qualifizierter Trust Services-Anbieter, der eine Reihe von elektronischen Signaturlösungen anbietet. Mit Lex Enterprise haben Sie Zugriff auf alle eIDAS-Signaturebenen sowie eine große Anzahl von Signiererauthentifizierungsmethoden. Ihre Signaturbücher sind in digitale Workflows eingebettet. Automatisieren Sie Verbindungen zwischen Lex Enterprise und allen Ihren Tools, um sich wiederholende Aufgaben zu beseitigen, Effizienz zu erzielen und Ihr Unternehmen zu beschleunigen.
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Dienstleistung | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Logik-Apps | Norm | Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: – Azure Government-Regionen - Azure China-Regionen - US Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | Lex Persona-Support |
| URL | https://support.lex-persona.com |
| support@lex-persona.com |
| Connectormetadaten | |
|---|---|
| Herausgeber | Lex Persona |
| Webseite | https://www.lex-persona.com |
| Datenschutzrichtlinie | https://www.lex-persona.com/politique-de-confidentialite/ |
| Kategorien | Künstliche Intelligenz; Website |
Lex Persona ist ein europäischer qualifizierter Trust Services-Anbieter, der eine Reihe von elektronischen Signaturlösungen anbietet. Mit diesem Connector können Sie Ihrer Microsoft-basierten Anwendung (PowerApp, .NET-basierte Web-App, Dynamics...) und Umgebung (Outlook, Sharepoint, Teams...) ganz einfach die elektronische Signaturfunktion hinzufügen. Der Connector wird von unserem Lex Enterprise Workflow Manager unterstützt. Sie können Elektronensignaturworkflows erstellen, die aus verschiedenen Arten von Schritten bestehen, die in Sequenz und/oder parallel ausgeführt werden können. Der Connector unterstützt alle eIDAS-Signaturebenen und bietet eine breite Palette von Signierauthentifizierungsmethoden (OTP, SSO, France Connect, Identité Numérique La Poste, Hardwaretoken...)
Voraussetzungen
Sie müssen folgendes haben, um fortzufahren:
- Lex Enterprise-Abonnement. Testen des Testplans
Die Umgebungsanforderungen sind:
- Ein Microsoft Power Apps- oder Power Automate-Plan mit benutzerdefiniertem Connectorfeature
- Die Power Platform CLI-Tools
So erhalten Sie Anmeldeinformationen
Wenden Sie sich an unsere Vertriebsmitarbeiter, commercial@lex-persona.com um ein Lex Enteprise-Abonnement oder ein Konto auf unseren Testsystemen zu erhalten.
Stellen Sie eine Verbindung mit dem Lex Enterprise-Portal mit Ihrem Konto her, und generieren Sie einen API-Schlüssel.
Erste Schritte mit Ihrem Connector
Erstellen Sie zunächst eine Verbindung für den Verbinder. Legen Sie die Authentifizierungsmethode auf DEN API-Schlüssel fest, stellen Sie Ihren API-Schlüssel ("Bearer act_XXXXXXX") bereit, und geben Sie an, dass der API-Schlüssel im Autrorization-Header der API-Aufrufe platziert werden muss.
Die Schritte zum Erstellen eines einfachen Signaturworkflows sind die folgenden:
- rufen Sie direkt nach dem Tigger die verbundene Lex Enterprise-Benutzer-ID ab (diese ID ist erforderlich, um einen Workflow zu erstellen) mit der Aktion "Abrufen"
- Such consent pages with the Search consent pages action_. Sie können den Textparameter verwenden, um Zustimmungsseiten nach Namen zu durchsuchen (Zustimmungsseiten definieren die Signaturebene und sind in Ihrer Lex Enterprise-Umgebung vorkonfiguriert)
- erstellen Sie einen Signaturworkflow mit der Aktion "Workflow erstellen" . In diesem Schritt müssen Sie die Informationen der Signierer angeben.
- Suchsignaturprofile mit der Aktion "Signaturprofile suchen". Sie können den Textparameter verwenden, um Signaturprofile nach Namen zu durchsuchen (Signaturprofile steuern einige Aspekte des Verhaltens der Zustimmungsseiten. Erzwingen Sie, dass der Signierer zum Ende des Dokuments scrollt, bevor Sie beispielsweise signieren)
- Abrufen eines Dokuments aus Ihrer Umgebung (SharePoint, Outlook, OneDrive...)
- Fügen Sie dem Workflow das Dokument mit der Aktion "Teil erstellen" hinzu, und legen Sie den parameter createDocument auf "true" fest.
- starten Sie den Workflow mit der Workflowaktion aktualisieren, und legen Sie den Workflowstatus auf den Start fest.
Bitte beachten Sie: Der Connector ist standardmäßig mit unserem Testserver gekoppelt. Wenn Sie den Connector mit Ihrem eigenen Mandanten koppeln möchten, müssen Sie die Host-URL in der Sicherheitsdefinition des Connectors oder in der datei apiDefinitions.json ändern:
- "host": "yourtenant.lexpersona.com",
Kennen von Problemen und Einschränkungen
Die Aktion " Dokument erstellen " akzeptiert eine Liste der Dokumentteile int der Nutzlast. Wenn Sie jedoch mehrere Teile bereitstellen, wird nur das erste berücksichtigt (dies liegt an einem Fehler in unserer API. Es wird in der nächsten Version des Connectors behoben).
Wenn Sie einem Workflow daher mehrere Dokumente hinzufügen möchten, ist es erforderlich, für jedes Dokument einen Aufruf desCreateDocument-Parameters auf "true " auszuführen.
Häufige Fehler und Abhilfemaßnahmen
Bei einem API-Aufruffehler enthält die API-Aufrufantwort eine umfassende Fehlermeldung, die im Ausführungsverlauf des Connectors angezeigt wird. Die Nachricht enthält auch eine Protokoll-ID, sodass Sie, wenn Sie weitere Informationen zum Fehler benötigen, eine Verbindung mit dem Lex Enteprise-Portal herstellen und die Serverprotokolldatei konsultieren können. Alternativley können Sie eine Postman-Anforderung einrichten, um unsere Serverprotokolle zu durchsuchen (plase konsultieren Sie die Dokumentation: https://sgs-demo-test01.sunnystamp.com/wm-docs/api.html#search-logs).
Die gängigeren HTTP-Fehlercodes, die von unserer API zurückgegeben werden, sind die folgenden:
- Fehler 400 – Ungültige Anforderung. In Ihrer Anfrage gibt es etwas Falsches. Lesen Sie das Protokoll, um Informationen zur Ursache des Fehlers zu finden.
- Fehler 401 – Nicht autorisiert. Yo hat nicht die Zugriffsrechte, um diesen Vorgang auszuführen. Überprüfen Sie Ihre Lex Persona-Benutzerzugriffsrechte
- Fehler 403 – Verboten. Ihr API-Schlüssel ist invlaid oder deaktiviert.
- Fehler 404 – Nicht gefunden. Fehler in Ihrer Anforderungs-URL
Weitere Informationen zu den möglichen Fehlercodes des API-Aufrufs finden Sie auch in unserer Dokumentation (https://sgs-demo-test01.sunnystamp.com/wm-docs/api.html)
Häufig gestellte Fragen
Welche Dokumente werden vom Connector unterstützt?
Die Dokumente, die Sie zur Signatur senden können, können die Formate pdf, docx, pptx und xlsx aufweisen. Der Connector konvertiert die Dokumente bei Bedarf in pdf, und die Signaturen weisen das PAdES-Format auf.
Es ist auch möglich, XML-Dokumente zu signieren. In diesem Fall wird keine Konvertierung angewendet, und die Signaturen weisen das XAdES-Format auf.
Es ist auch möglich, ZIP-Dateien hochzuladen. Der Connector entpackt das Archiv und fügt jedes Dokument dem Workflow hinzu.
Sie können auch Anlagen zu Signaturenworkflows hinzufügen. Die Anlage ist nicht signiert und kann ein beliebiges Format aufweisen.
Kann ein Dokument über mehrere Signierer verfügen
Ja. Die Anzahl der Signierer eines Dokuments ist unbegrenzt.
Ist es möglich, mehrere Dokumente gleichzeitig zu signieren
Ja. Sie können einem Workflow mehrere Dokumente hinzufügen, und alle Dokumente werden gleichzeitig signiert. Beachten Sie jedoch, dass in diesem Fall die Gruppe von Dokumenten juridisch verknüpft wird und dass das System eine eindeutige Beweisdatei erzeugt.
Sie können auch mutlpiple Workglows erstellen, die denselben Signierer gemeinsam verwenden. Zur Signaturzeit wird die Liste der Dokumente dem Signierer angezeigt, und der Signierer hat die Möglichkeit, die Dokumente auszuwählen, die sie signieren möchte. In diesem Fall werden die Dokumente rechtsunabhängig sein, eine Beweisakte wird für jedes Dokument erstellt.
Ist es möglich, ein Dokument offline zu signieren
Nein. Für den Zugriff auf die Zustimmungsseiten ist eine Intenetverbindung erforderlich.
Ist es möglich, automatische Signatur-Remider an Signierer zu senden
Ja. Sie können den Erinnerungszeitraum und die maximale Anzahl der zu sendenden Erinnerungen konfigurieren.
Ist es möglich, einen bereits gestarteten Signaturworkflow zu ändern
Ja. Vor jeder Signatur können Sie alles im Workflow ändern. Nach der ersten Signatur ist es unmöglich, die Dokumente zu ändern, aber Sie können die Workflowschritte trotzdem ändern.
Was ist die Gültigkeitsdauer der einmaligen Kennwörter
Die Gültigkeitsdauer von Einmaligen Kennwörtern beträgt zwei Minuten (eine Zählung wird auf den Zustimmungsseiten angezeigt).
Ist es möglich, die Gültigkeit einer elektronischen Signatur zu überprüfen
Sie können den Bereich "Signaturen" von Adobe Acrobat verwenden, um die Gültigkeit der in einem PDF-Dokument enthaltenen Signaturen zu überprüfen. Alternativ können Sie einen vertrauenswürdigen Signaturüberprüfungswebdienst (https://ec.europa.eu/digital-building-blocks/DSS/webapp-demo/validation z. B.) verwenden.
Was sind die Lex Persona Dokumentspeicherbedingungen
Standardmäßig behalten wir die Dokumente als Nachweisdateien auf unseren Servern bei. Tou kann Dokumente jederzeit durchsuchen und herunterladen. Bei Bedarf können wir Ihre Dokumente jedoch priodisch von unseren Servern löschen.
Behält Lex Persona die Zeitstempeltoken bei
Nein. Die Zeitstempel werden nicht beibehalten. Bei Bedarf können Sie diese Token aus den signierten Dokumenten extracxt.
Gibt es eine Widerrufsfrist für ein signiertes Dokument
Ja. Der Rücktritt hängt von den rechtlichen Bedingungen ab, die für das Dokument gelten.
Ist es möglich, einen Signaturworkflow abzubrechen
Ja. Ein Autoriezd-Benutzer kann jederzeit einen gestarteten Signaturworkflow abbrechen. Es werden keine Rückschlüsse erstellt, und wenn das Dokument bereits von einem oder vielen Signierern signiert wurde, werden die Sgnatures ungültig.
Erstellen einer Verbindung
Der Connector unterstützt die folgenden Authentifizierungstypen:
| Vorgabe | Parameter zum Erstellen einer Verbindung. | Alle Regionen | Nicht teilbar |
Vorgabe
Anwendbar: Alle Regionen
Parameter zum Erstellen einer Verbindung.
Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.
| Name | Typ | Description | Erforderlich |
|---|---|---|---|
| API-Schlüssel | securestring | Der API-Schlüssel für diese API | Richtig |
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Abrufen der Metadatenzuordnung |
Abrufen der Metadatenzuordnung des angegebenen Mandanten |
| Abrufen der Seiten-URL für constent |
Erstellen und Abrufen der Url der Zustimmungsseite für einen Empfänger |
| Abrufen des Metadatenlayouts |
Abrufen eines Workflowlayouts |
| Abrufen von mir |
Abrufen der id des verbundenen Benutzers |
| Aktualisieren des Metadatenlayouts |
Aktualisieren eines Metadatenlayouts |
| Datei "Nachweise herunterladen" |
Herunterladen der Workflow-Nachweisdatei |
| Dokument abrufen |
Abrufen eines Dokuments |
| Dokument aktualisieren |
Aktualisieren eines Dokuments |
| Dokument erstellen |
Erstellen eines Dokuments aus vordefinierten Teilen |
| Dokument löschen |
Löschen eines Dokuments |
| Dokumente durchsuchen |
Dokumente durchsuchen |
| Durchsuchen von Signaturprofilen |
Durchsuchen von Signaturprofilen |
| Erstellen des Workflows |
Erstellen eines Workflows |
| Erstellen eines Metadatenlayouts |
Erstellen eines Metadatenlayouts |
| Herunterladen von Workflowdokumenten |
Herunterladen der Workflowdokumente |
| Kontakt abrufen |
Abrufen von Kontaktinformationen aus der Kontakt-ID |
| Kontakt aktualisieren |
Ändern einer vorhandenen Kontaktinformationen |
| Kontakt erstellen |
Hinzufügen eines Kontakts zur Kontaktliste des aktuellen Benutzers |
| Kontakt löschen |
Entfernen eines Kontakts aus der Liste der aktuellen Benutzer |
| Seite "Zustimmung abrufen" |
Abrufen von Informationen zur Zustimmungsseite aus der Zustimmungsseiten-ID |
| Signaturprofil abrufen |
Abrufen eines Signaturprofils |
| Signaturprofil aktualisieren |
Aktualisieren eines Signaturprofils |
| Signaturprofil erstellen |
Erstellen eines Signaturprofils |
| Such-Zustimmungsseiten |
Such-Zustimmungsseiten |
| Suchen von Kontakten |
Suchen von Kontakten |
| Suchmetadatenlayouts |
Suchworkflowlayouts |
| Suchworkflows |
Suchworkflows |
| Webpart erstellen |
Erstellen eines Dokumentteils |
| Workflow abrufen |
Workflow aus workflow-ID abrufen |
| Workflow aktualisieren |
Aktualisieren eines Workflows |
| Workflow löschen |
Löschen eines Workflows |
Abrufen der Metadatenzuordnung
Abrufen der Metadatenzuordnung des angegebenen Mandanten
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Mandanten-ID
|
tenantId | True | string |
ID des Mandanten |
Gibt zurück
- Body
- dataMapping
Abrufen der Seiten-URL für constent
Erstellen und Abrufen der Url der Zustimmungsseite für einen Empfänger
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Workflow-ID
|
workflowId | True | string |
ID des Workflows |
|
Empfänger-E-Mail
|
recipientEmail | string |
E-Mail des betroffenen Empfängers |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Die URL der Zustimmungsseite für den betroffenen Empfänger
|
inviteUrl | string |
Die URL der Zustimmungsseite für den betroffenen Empfänger |
Abrufen des Metadatenlayouts
Abrufen eines Workflowlayouts
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Layout-ID
|
layoutId | True | string |
ID des Layouts |
Gibt zurück
Metadatenlayout
- Body
- layout
Abrufen von mir
Aktualisieren des Metadatenlayouts
Aktualisieren eines Metadatenlayouts
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Mandanten-ID
|
layoutId | True | string |
ID des Layouts |
|
Inhaltstyp
|
Content-Type | True | string |
Inhaltstyp |
|
Name
|
name | True | string |
Der Layoutname |
|
Ist deaktiviert
|
isDisabled | boolean |
Bei Festlegung auf "true" wird das Layout deaktiviert. |
|
|
Schlitz
|
slot | string |
Metadatenelement (Daten1 zu Daten8) |
|
|
Standardeinstellung
|
default | string |
Standardwert für Metadaten in diesem Layout |
|
|
optional
|
optional | boolean |
Wenn "true" angegeben ist, ist die Angabe eines Werts nicht obligatorisch. |
|
|
readonly
|
readonly | boolean |
Der Wert kann außer Kraft gesetzt werden. |
|
|
rememberLastValue
|
rememberLastValue | boolean |
Wenn dieser Wert auf "true" festgelegt ist, wird der Wert über Workflows hinweg beibehalten. |
Gibt zurück
Metadatenlayout
- Body
- layout
Datei "Nachweise herunterladen"
Herunterladen der Workflow-Nachweisdatei
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Workflow-ID
|
workflowId | True | string |
ID des Workflows |
|
Akzeptieren
|
Accept | True | string |
Akzeptieren |
Gibt zurück
- response
- binary
Dokument abrufen
Abrufen eines Dokuments
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
documentId | True | string |
ID des Dokuments |
Gibt zurück
- Body
- document
Dokument aktualisieren
Aktualisieren eines Dokuments
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
documentId | True | string |
ID des Dokuments |
|
Inhaltstyp
|
Content-Type | True | string |
Inhaltstyp |
|
signatureProfileId
|
signatureProfileId | string |
Das Signaturprofil für dieses Dokument |
|
|
imageHeight
|
imageHeight | float |
imageHeight |
|
|
imagePage
|
imagePage | float |
imagePage |
|
|
imageWidth
|
imageWidth | float |
imageWidth |
|
|
imageX
|
imageX | float |
imageX |
|
|
imageY
|
imageY | float |
imageY |
Gibt zurück
- Body
- document
Dokument erstellen
Erstellen eines Dokuments aus vordefinierten Teilen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Workflow-ID
|
workflowId | True | string |
ID des betroffenen Workflows |
|
Inhaltstyp
|
Content-Type | True | string |
Inhaltstyp |
|
Inhaltstyp
|
contentType | string |
Inhaltstyp |
|
|
filename
|
filename | string |
filename |
|
|
hash
|
hash | string |
hash |
|
|
size
|
size | integer |
size |
|
|
signatureProfileId
|
signatureProfileId | string |
Das Signaturprofil für dieses Dokument |
Gibt zurück
- Body
- document
Dokument löschen
Löschen eines Dokuments
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
documentId | True | string |
ID des Dokuments |
Gibt zurück
- Body
- document
Dokumente durchsuchen
Dokumente durchsuchen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Suchtext
|
text | string |
Suchtext |
|
|
Suchmetadatenlayout
|
items.layoutId | string |
Nach Metadatenlayout suchen |
|
|
Suchgruppe
|
items.groupId | string |
Nach Benutzergruppe suchen |
|
|
Benutzer suchen
|
items.userId | string |
Suche nach Besitzer |
|
|
Suchworkflow-ID
|
items.workflowId | string |
Suchen nach Workflow-ID |
|
|
Name des Suchworkflows
|
items.workflowName | string |
Nach Workflowname suchen |
|
|
Suchmetadaten 1
|
items.data1 | string |
Suchen nach Dem Wert von Metadaten 1 |
|
|
Suchmetadaten 2
|
items.data2 | string |
Suchen nach Dem Wert von Metadaten 2 |
|
|
Suchmetadaten 3
|
items.data3 | string |
Suchen nach Dem Wert von Metadaten 3 |
|
|
Suchmetadaten 4
|
items.data4 | string |
Suchen nach Dem Wert von Metadaten 4 |
|
|
Suchmetadaten 5
|
items.data5 | string |
Suchen nach Dem Wert von Metadaten 5 |
|
|
Suchmetadaten 6
|
items.data6 | string |
Suchen nach Dem Wert von Metadaten 6 |
|
|
Suchmetadaten 7
|
items.data7 | string |
Suchen nach Dem Wert von Metadaten 7 |
|
|
Suchmetadaten 8
|
items.data8 | string |
Suchen nach Dem Wert von Metadaten 8 |
|
|
Signaturprofil durchsuchen
|
items.signatureProfileId | string |
Nach Signaturprofil suchen |
|
|
Erstellungsdatum der Suche
|
items.created | string |
Nach Erstellungsdatum suchen |
|
|
Aktualisierungsdatum der Suche
|
items.updated | string |
Nach Datum der letzten Aktualisierung suchen |
|
|
Sortieren nach
|
sortBy | string |
Das Zum Sortieren des Suchergebnisses verwendete Feld |
|
|
Sortierreihenfolge
|
sortOrder | string |
Die Richtung der Sortierung |
|
|
Artikel pro Seite
|
itemsPerPage | string |
Anzahl der Elemente pro Seite in der Antwort |
|
|
Seitenindex
|
pageIndex | string |
Index der zurückgegebenen Seite |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
items
|
items | documents |
Durchsuchen von Signaturprofilen
Durchsuchen von Signaturprofilen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Suchtext
|
text | string |
Suchtext |
|
|
Suchstandard
|
items.isDefault | string |
Suchen nach Standardsignaturprofilen |
|
|
Suche deaktiviert
|
items.isDisabled | string |
Suchen nach deaktivierten Signaturprofilen |
|
|
Suchname
|
items.name | string |
Nach Signaturprofilname suchen |
|
|
Dokument durchsuchen. Geben Sie
|
items.documentType | string |
Suchen nach Dokumenttyp |
|
|
Suchsignaturtyp
|
items.signatureType | string |
Nach Signaturtyp suchen |
|
|
Erstellungsdatum der Suche
|
items.created | string |
Nach Erstellungsdatum suchen |
|
|
Aktualisierungsdatum der Suche
|
items.updated | string |
Nach Datum der letzten Aktualisierung suchen |
|
|
Sortieren nach
|
sortBy | string |
Das Zum Sortieren des Suchergebnisses verwendete Feld |
|
|
Sortierreihenfolge
|
sortOrder | string |
Die Richtung der Sortierung |
|
|
Artikel pro Seite
|
itemsPerPage | string |
Anzahl der Elemente pro Seite in der Antwort |
|
|
Seitenindex
|
pageIndex | string |
Index der zurückgegebenen Seite |
Gibt zurück
- Body
- signatureProfiles
Erstellen des Workflows
Erstellen eines Workflows
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
userId | True | string |
Benutzer-ID des Workflowbesitzers |
|
Inhaltstyp
|
Content-Type | string |
Inhaltstyp |
|
|
Name
|
name | True | string |
Name des Workflows |
|
Description
|
description | string |
Beschreibung des Workflows |
|
|
id
|
id | string |
Schritt-ID |
|
|
stepType
|
stepType | string |
Signatur oder Genehmigung |
|
|
consentPageId
|
consentPageId | True | string |
ID der Zustimmungsseite (Signaturstufe), die diesem Empfänger zugeordnet ist |
|
E-Mail
|
True | string |
E-Mail-Adresse des Empfängers |
|
|
userId
|
userId | string |
verweisen sie auf einen LE-Benutzer, anstatt einen Empfänger im Flug zu erstellen. |
|
|
Telefonnummer
|
phoneNumber | string |
Mobiltelefonnummer von reicpient |
|
|
Vorname
|
firstName | string |
Vorname des Empfängers |
|
|
lastName
|
lastName | string |
Nachname des Empfängers |
|
|
country
|
country | string |
Ländercode des Empfängers |
|
|
preferredLocale
|
preferredLocale | string |
Gebietsschemacode des Empfängers |
|
|
Organisations-ID
|
organizationId | string |
ID der LE-Organisation des Empfängers |
|
|
requiredRecipients
|
requiredRecipients | number |
Mindestanzahl von Signierern, die signieren müssen, um den nächsten Schritt auszuführen |
|
|
gültigkeitPeriod
|
validityPeriod | number |
Gültigkeitsdauer für Schritt |
|
|
inviteperiod
|
inviteperiod | number |
Häufigkeit von Signaturerinnerungen |
|
|
maxInvites
|
maxInvites | number |
maximale Anzahl von Signaturerinnerungen |
|
|
sendDownloadLink
|
sendDownloadLink | boolean |
steuert die Übermittlung des signierten Dokuments an Signierer |
|
|
allowComments
|
allowComments | boolean |
erlaubt/verbietet Kommentare zu diesem Schritt |
|
|
hideAttachments
|
hideAttachments | boolean |
steuert die Anzeige von Anlagen für Signierer |
|
|
hideWorkflowRecipients
|
hideWorkflowRecipients | boolean |
steuert die Anzeige anderer Signierer an den Signierer. |
|
|
Benachrichtigungsereignisse
|
notifiedEvents | array of string |
Benachrichtigungsworkflowereignisse |
|
|
userId
|
userId | string |
Benutzer-ID des Watchers |
|
|
notifiedEvents
|
notifiedEvents | array of string |
Workflowereignisse, die an diese Überwachung benachrichtigt werden |
|
|
E-Mail
|
string |
E-Mail des Watchers |
||
|
Vorlagen-ID
|
templateId | string |
ID der Vorlage, von der der Workflow abgeleitet wird |
|
|
Layout-ID
|
layoutId | string |
Vom Arbeitslow verwendete Metadatenlayout |
|
|
Data1
|
data1 | string |
Erste Metadaten |
|
|
data2
|
data2 | string |
Zweite Metadaten |
|
|
Data3
|
data3 | string |
Dritte Metadaten |
|
|
data4
|
data4 | string |
Vierte Metadaten |
|
|
Data5
|
data5 | string |
Fünfte Metadaten |
|
|
data6
|
data6 | string |
Sechste Metadaten |
|
|
data7
|
data7 | string |
Siebte Metadaten |
|
|
data8
|
data8 | string |
Heighth-Metadaten |
Gibt zurück
- Body
- workflow
Erstellen eines Metadatenlayouts
Erstellen eines Metadatenlayouts
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Mandanten-ID
|
tenantId | True | string |
ID des Layouts |
|
Inhaltstyp
|
Content-Type | True | string |
Inhaltstyp |
|
Name
|
name | True | string |
Der Layoutname |
|
Ist deaktiviert
|
isDisabled | boolean |
Bei Festlegung auf "true" wird das Layout deaktiviert. |
|
|
Schlitz
|
slot | string |
Metadatenelement (Daten1 zu Daten8) |
|
|
Standardeinstellung
|
default | string |
Standardwert für Metadaten in diesem Layout |
|
|
optional
|
optional | boolean |
Wenn "true" angegeben ist, ist die Angabe eines Werts nicht obligatorisch. |
|
|
readonly
|
readonly | boolean |
Der Wert kann außer Kraft gesetzt werden. |
|
|
rememberLastValue
|
rememberLastValue | boolean |
Wenn dieser Wert auf "true" festgelegt ist, wird der Wert über Workflows hinweg beibehalten. |
Gibt zurück
Metadatenlayout
- Body
- layout
Herunterladen von Workflowdokumenten
Herunterladen der Workflowdokumente
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Workflow-ID
|
workflowId | True | string |
ID des Workflows |
Gibt zurück
- response
- binary
Kontakt abrufen
Abrufen von Kontaktinformationen aus der Kontakt-ID
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Kontakt-ID
|
contactId | True | string |
ID des Kontakts |
|
Inhaltstyp
|
Content-Type | True | string |
Inhaltstyp |
Gibt zurück
- Body
- contact
Kontakt aktualisieren
Ändern einer vorhandenen Kontaktinformationen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Kontakt-ID
|
contactId | True | string |
ID des Kontakts |
|
Inhaltstyp
|
Content-Type | True | string |
Inhaltstyp |
|
E-Mail des Kontakts
|
string |
E-Mail des Kontakts |
||
|
Telefonnummer des Kontakts
|
phoneNumber | string |
Telefonnummer des Kontakts |
|
|
Vorname des Kontakts
|
firstName | string |
Vorname des Kontakts |
|
|
Nachname des Kontakts
|
lastName | string |
Nachname des Kontakts |
|
|
Land des Kontakts
|
country | string |
Land des Kontakts |
Gibt zurück
- Body
- contact
Kontakt erstellen
Hinzufügen eines Kontakts zur Kontaktliste des aktuellen Benutzers
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
userId | True | string |
Benutzer, zu dem der Kontakt gehört |
|
Inhaltstyp
|
Content-Type | True | string |
Inhaltstyp |
|
Kontakt-E-Mail
|
True | string |
Kontakt-E-Mail |
|
|
Telefonnummer für "Kontatct"
|
phoneNumber | string |
Telefonnummer |
|
|
Vorname des Kontakts
|
firstName | True | string |
Vorname |
|
Nachname des Kontakts
|
lastName | True | string |
lastName |
|
Kontaktland
|
country | string |
country |
Gibt zurück
- Body
- contact
Kontakt löschen
Entfernen eines Kontakts aus der Liste der aktuellen Benutzer
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Kontakt-ID
|
contactId | True | string |
ID des Kontakts |
|
Inhaltstyp
|
Content-Type | True | string |
Inhaltstyp |
Gibt zurück
- Body
- contact
Seite "Zustimmung abrufen"
Abrufen von Informationen zur Zustimmungsseite aus der Zustimmungsseiten-ID
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Id der Zustimmungsseite
|
cpId | True | string |
ID der Zustimmungsseite |
|
Inhaltstyp
|
Content-Type | True | string |
Inhaltstyp |
Gibt zurück
- Body
- consentPage
Signaturprofil abrufen
Abrufen eines Signaturprofils
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Signaturprofil-ID
|
spId | True | string |
ID des Signaturprofils |
Gibt zurück
- Body
- signatureProfile
Signaturprofil aktualisieren
Aktualisieren eines Signaturprofils
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Signaturprofil-ID
|
spId | True | string |
ID des Signaturprofils |
|
Inhaltstyp
|
Content-Type | True | string |
Inhaltstyp |
|
Ist Standard
|
isDefault | string |
Macht dieses Signaturprofil zum Standardprofil |
|
|
Ist deaktiviert
|
isDisabled | string |
Dieses Signaturprofil deaktivieren |
|
|
Name
|
name | string |
Der Signaturprofilname |
|
|
Signaturtyp
|
signatureType | string |
pades,xades,xadesDetached,xadesDetachedManifest,cades,helios |
|
|
Erzwingen des Bildlaufs zum Ende des Dokuments
|
forceScrollDocument | boolean |
Erzwingen, dass der Signierer zum Ende des Dokuments scrollt |
|
|
Sichtbarer Signaturmodus
|
pdfVisibleSignatureMode | string |
Sichtbarer Signaturmodus (zulässig, deaktiviert, noImage) |
|
|
Signaturtext
|
pdfSignatureImageText | string |
Text, der in Signaturenpads angezeigt wird |
|
|
Signaturtextfarbe
|
pdfSignatureImageTextColor | string |
Farbe des Texts, der in den Singaturen pads angezeigt wird |
|
|
Signaturtextgröße
|
pdfSignatureImageTextSize | number |
Größe des Texts, der in den Singaturenpads angezeigt wird |
Gibt zurück
- Body
- signatureProfile
Signaturprofil erstellen
Erstellen eines Signaturprofils
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Mandanten-ID
|
tenantId | True | string |
ID des Mandanten |
|
Inhaltstyp
|
Content-Type | True | string |
Inhaltstyp |
|
Ist Standard
|
isDefault | True | string |
Macht dieses Signaturprofil zum Standardprofil |
|
Ist deaktiviert
|
isDisabled | string |
Dieses Signaturprofil deaktivieren |
|
|
Name
|
name | True | string |
Der Signaturprofilname |
|
Dokumenttyp
|
documentType | True | string |
pdf, xml, word, excel, powerpoint, other |
|
Signaturtyp
|
signatureType | True | string |
pades,xades,xadesDetached,xadesDetachedManifest,cades,helios |
|
Erzwingen des Bildlaufs zum Ende des Dokuments
|
forceScrollDocument | True | boolean |
Erzwingen, dass der Signierer zum Ende des Dokuments scrollt |
|
Sichtbarer Signaturmodus
|
pdfVisibleSignatureMode | string |
Sichtbarer Signaturmodus (zulässig, deaktiviert, noImage) |
|
|
Signaturtext
|
pdfSignatureImageText | string |
Text, der in Signaturenpads angezeigt wird |
|
|
Signaturtextfarbe
|
pdfSignatureImageTextColor | string |
Farbe des Texts, der in den Singaturen pads angezeigt wird |
|
|
Signaturtextgröße
|
pdfSignatureImageTextSize | number |
Größe des Texts, der in den Singaturenpads angezeigt wird |
Gibt zurück
- Body
- signatureProfile
Such-Zustimmungsseiten
Such-Zustimmungsseiten
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Suchtext
|
text | string |
Suchtext |
|
|
Suchstandard
|
items.isDefault | string |
Nach Standard-Zustimmungsseite suchen |
|
|
Suche deaktiviert
|
items.isDisabled | string |
Nach deaktivierten Zustimmungsseiten suchen |
|
|
Suchname
|
items.name | string |
Nach Zustimmungsseitennamen suchen |
|
|
Suchschritttyp
|
items.stepType | string |
Nach Schritt-Typ suchen |
|
|
Suchclient-ID
|
items.clientId | string |
Suche nach Client-ID |
|
|
Erstellungsdatum der Suche
|
items.created | string |
Nach Erstellungsdatum suchen |
|
|
Aktualisierungsdatum der Suche
|
items.updated | string |
Nach Datum der letzten Aktualisierung suchen |
|
|
Sortieren nach
|
sortBy | string |
Das Feld, nach dem das Suchergebnis sortiert werden soll |
|
|
Sortierreihenfolge
|
sortOrder | string |
Die Richtung der Sortierung |
|
|
Artikel pro Seite
|
itemsPerPage | string |
Anzahl der Elemente pro Seite in der Antwort |
|
|
Seitenindex
|
pageIndex | string |
Index der zurückgegebenen Seite |
Gibt zurück
- Body
- consentPages
Suchen von Kontakten
Suchen von Kontakten
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Suchtext
|
text | string |
Nach Text suchen |
|
|
E-Mail durchsuchen
|
items.email | string |
Nach E-Mail suchen |
|
|
Telefonnummer durchsuchen
|
items.phoneNumber | string |
Nach Telefonnummer suchen |
|
|
Vorname suchen
|
items.fisrtName | string |
Nach Vornamen suchen |
|
|
Nachname suchen
|
items.lastName | string |
Nach Nachname suchen |
|
|
Land suchen
|
items.country | string |
Nach Land suchen |
|
|
Artikel pro Seite
|
itemsPerPage | number |
Anzahl der Elemente pro Seite in der Antwort |
|
|
Seitenindex
|
pageIndex | number |
Index der zurückgegebenen Seite |
Gibt zurück
- Body
- contacts
Suchmetadatenlayouts
Suchworkflowlayouts
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Suchtext
|
text | string |
Suchtext |
|
|
Suche deaktiviert
|
items.isDisabled | string |
Suchen nach deaktivierten Layouts |
|
|
Suchname
|
items.name | string |
Nach Layoutname suchen |
|
|
Suchmetadaten
|
items.dataConfigurations.slot | string |
Suchen nach Vorhandensein von Metadaten |
|
|
Erstellungsdatum der Suche
|
items.created | string |
Nach Erstellungsdatum suchen |
|
|
Aktualisierungsdatum der Suche
|
items.updated | string |
Nach Datum der letzten Aktualisierung suchen |
|
|
Sortieren nach
|
sortBy | string |
Das Zum Sortieren des Suchergebnisses verwendete Feld |
|
|
Sortierreihenfolge
|
sortOrder | string |
Die Richtung der Sortierung |
|
|
Artikel pro Seite
|
itemsPerPage | string |
Anzahl der Elemente pro Seite in der Antwort |
|
|
Seitenindex
|
pageIndex | string |
Index der zurückgegebenen Seite |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
items
|
items | layouts |
Suchworkflows
Suchworkflows
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Akzeptieren
|
Accept | string |
Akzeptieren |
|
|
Suchtext
|
text | string |
Suchtext |
|
|
Suchmetadatenlayout
|
items.layoutId | string |
Nach Metadatenlayout suchen |
|
|
Suchvorlage
|
items.templateId | string |
Nach Workflowvorlage suchen |
|
|
Suchgruppe
|
items.groupId | string |
Nach Benutzergruppe suchen |
|
|
Benutzer suchen
|
items.userId | string |
Suche nach Besitzer |
|
|
E-Mail durchsuchen
|
items.email | string |
Nach E-Mail-Adresse des Besitzers suchen |
|
|
Vorname suchen
|
items.firstname | string |
Nach dem Vornamen des Besitzers suchen |
|
|
Nachname suchen
|
items.lastname | string |
Nach dem Nachnamen des Besitzers suchen |
|
|
Suchstatus
|
items.workflowStatus | string |
Nach Workflowstatus suchen |
|
|
Suchmetadaten 1
|
items.data1 | string |
Suchen nach Dem Wert von Metadaten 1 |
|
|
Suchmetadaten 2
|
items.data2 | string |
Suchen nach Dem Wert von Metadaten 2 |
|
|
Suchmetadaten 3
|
items.data3 | string |
Suchen nach Dem Wert von Metadaten 3 |
|
|
Suchmetadaten 4
|
items.data4 | string |
Suchen nach Dem Wert von Metadaten 4 |
|
|
Suchmetadaten 5
|
items.data5 | string |
Suchen nach Dem Wert von Metadaten 5 |
|
|
Suchmetadaten 6
|
items.data6 | string |
Suchen nach Dem Wert von Metadaten 6 |
|
|
Suchmetadaten 7
|
items.data7 | string |
Suchen nach Dem Wert von Metadaten 7 |
|
|
Suchmetadaten 8
|
items.data8 | string |
Suchen nach Dem Wert von Metadaten 8 |
|
|
Erstellungsdatum der Suche
|
items.created | string |
Nach Erstellungsdatum suchen |
|
|
Aktualisierungsdatum der Suche
|
items.updated | string |
Nach Datum der letzten Aktualisierung suchen |
|
|
Startdatum der Suche
|
items.started | string |
Nach Startdatum suchen |
|
|
Sortieren nach
|
sortBy | string |
Das Zum Sortieren des Suchergebnisses verwendete Feld |
|
|
Sortierreihenfolge
|
sortOrder | string |
Die Richtung der Sortierung |
|
|
Artikel pro Seite
|
itemsPerPage | string |
Anzahl der Elemente pro Seite in der Antwort |
|
|
Seitenindex
|
pageIndex | string |
Index der zurückgegebenen Seite |
Gibt zurück
- Body
- workflows
Webpart erstellen
Erstellen eines Dokumentteils
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Workflow-ID
|
workflowId | True | string |
ID des betroffenen Workflows |
|
Inhaltstyp
|
Content-Type | True | string |
Inhaltstyp |
|
Kotent disposition
|
Content-Disposition | True | string |
Content-Dispotion |
|
Dokument erstellen
|
createDocuments | string |
Erstellen eines Dokuments aus diesem Teil |
|
|
Anlagen ignorieren
|
ignoreAttachments | string |
Anlagen werden ignoriert. |
|
|
Signaturprofil-ID
|
signatureProfileId | string |
Teil, der als Anlage betrachtet wird, wenn er ausgelassen wird |
|
|
Entpacken
|
unzip | string |
Entzippen von Dateien |
|
|
Pdf zu PdfA
|
pdf2pdfa | string |
Pdf in pdf/A konvertieren |
|
|
Dokument
|
document | True | binary |
Die hochgeladenen Dateidaten |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Urkunden
|
documents | array of document |
Erstellte Dokumente |
|
ignoredAttachments
|
ignoredAttachments | integer |
ignoredAttachments |
|
Teile
|
parts | array of part |
Teile |
Workflow abrufen
Workflow aus workflow-ID abrufen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Workflow-ID
|
workflowId | True | string |
ID des Workflows |
Gibt zurück
- Body
- workflow
Workflow aktualisieren
Aktualisieren eines Workflows
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Workflow-ID
|
workflowId | True | string |
ID des zu aktualisierenden Workflows |
|
Inhaltstyp
|
Content-Type | string |
Inhaltstyp |
|
|
Benutzer-ID
|
userId | string |
ID des Workflowbesitzers |
|
|
Name
|
name | string |
Name des Workflows |
|
|
Description
|
description | string |
Beschreibung des Workflows |
|
|
id
|
id | string |
Schritt-ID |
|
|
stepType
|
stepType | string |
Signatur oder Genehmigung |
|
|
consentPageId
|
consentPageId | True | string |
ID der Zustimmungsseite (Signaturstufe), die diesem Empfänger zugeordnet ist |
|
E-Mail
|
True | string |
E-Mail-Adresse des Empfängers |
|
|
userId
|
userId | string |
verweisen sie auf einen LE-Benutzer, anstatt einen Empfänger im Flug zu erstellen. |
|
|
Telefonnummer
|
phoneNumber | string |
Mobiltelefonnummer von reicpient |
|
|
Vorname
|
firstName | string |
Vorname des Empfängers |
|
|
lastName
|
lastName | string |
Nachname des Empfängers |
|
|
country
|
country | string |
Ländercode des Empfängers |
|
|
preferredLocale
|
preferredLocale | string |
Gebietsschemacode des Empfängers |
|
|
Organisations-ID
|
organizationId | string |
ID der LE-Organisation des Empfängers |
|
|
requiredRecipients
|
requiredRecipients | number |
Mindestanzahl von Signierern, die signieren müssen, um den nächsten Schritt auszuführen |
|
|
gültigkeitPeriod
|
validityPeriod | number |
Gültigkeitsdauer für Schritt |
|
|
inviteperiod
|
inviteperiod | number |
Häufigkeit von Signaturerinnerungen |
|
|
maxInvites
|
maxInvites | number |
maximale Anzahl von Signaturerinnerungen |
|
|
sendDownloadLink
|
sendDownloadLink | boolean |
steuert die Übermittlung des signierten Dokuments an Signierer |
|
|
allowComments
|
allowComments | boolean |
erlaubt/verbietet Kommentare zu diesem Schritt |
|
|
hideAttachments
|
hideAttachments | boolean |
steuert die Anzeige von Anlagen für Signierer |
|
|
hideWorkflowRecipients
|
hideWorkflowRecipients | boolean |
steuert die Anzeige anderer Signierer an den Signierer. |
|
|
Benachrichtigungsereignisse
|
notifiedEvents | array of string |
Benachrichtigungsworkflowereignisse |
|
|
userId
|
userId | string |
Watcher-Benutzer-ID |
|
|
notifiedEvents
|
notifiedEvents | array of string |
Workflowereignisse, die an diese Überwachung benachrichtigt werden |
|
|
E-Mail
|
string |
|
||
|
Workflowstatus
|
workflowStatus | string |
Aktueller Status des Workflows |
|
|
Data1
|
data1 | string |
erste Metadaten |
|
|
data2
|
data2 | string |
zweite Metadaten |
|
|
Data3
|
data3 | string |
Dritte Metadaten |
|
|
data4
|
data4 | string |
vierte Metadaten |
|
|
Data5
|
data5 | string |
fünfte Metadaten |
|
|
data6
|
data6 | string |
sechste Metadaten |
|
|
data7
|
data7 | string |
Siebte Metadaten |
|
|
data8
|
data8 | string |
Heighth-Metadaten |
Gibt zurück
- Body
- workflow
Workflow löschen
Löschen eines Workflows
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Workflow-ID
|
workflowId | True | string |
ID des zu löschenden Workflows |
Gibt zurück
- Body
- workflow
Definitionen
consentPage
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
allowOrganization
|
allowOrganization | boolean |
Ermöglicht die Verwendung von Organisationen |
|
authenticateUser
|
authenticateUser | boolean |
Erzwingt die Signiererauthentifizierung |
|
Kunden-ID
|
clientId | string |
Client-ID |
|
erstellt
|
created | number |
Erstellungsdatum. |
|
emUrl
|
emUrl | string |
Url des Nachweis-Managers |
|
hideDownloads
|
hideDownloads | boolean |
Downloadlinks für Dokumente werden auf Zustimmungsseiten nicht wiedergegeben. |
|
hideMobileQrCode
|
hideMobileQrCode | boolean |
Blendet die QR-Codes auf Konstentseiten aus. |
|
id
|
id | string |
Die Id der Zustimmungsseite |
|
isCountryRequired
|
isCountryRequired | boolean |
Legt fest, dass das Land in Anmeldeinformationen obligatorisch ist |
|
isDisabled (istDeaktiviert)
|
isDisabled | boolean |
Die Zustimmungsseite ist deaktiviert. |
|
logoResourceId
|
logoResourceId | string |
ID der Logoressource der Zustimmungsseite |
|
name
|
name | string |
Name der Zustimmungsseite |
|
primaryColor
|
primaryColor | string |
Primäre Farbe der Zustimmungsseite |
|
secondaryColor
|
secondaryColor | string |
Sekundärfarbe der Zustimmungsseite |
|
sharedPassphrase
|
sharedPassphrase | string |
Freigegebene Passphrase |
|
Signaturmodus
|
signing mode | string |
Signaturmodus (lokal oder Server) |
|
stepType
|
stepType | string |
Schritttyp (Signatur oder Genehmigung) |
|
tenantId
|
tenantId | string |
Mandanten-ID |
|
tsaUrl
|
tsaUrl | string |
Zeitstempel-Autoritäts-URL |
|
aktualisierte
|
updated | number |
Datum der letzten Änderung |
|
verifyEmail
|
verifyEmail | boolean |
Wenn diese Einstellung auf "Tue" festgelegt ist, erhalten Signierer OTPs per E-Mail |
|
verifyPhoneNumber
|
verifyPhoneNumber | boolean |
Wenn dieser Wert auf "true" festgelegt ist, empfangen Signierer OTPs nach Textnachrichten. |
consentPages
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
items
|
items | array of consentPage |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
totalItems
|
totalItems | integer |
totalItems |
Kontakt
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
country
|
country | string |
Kontaktland |
|
erstellt
|
created | integer |
Erstellungsdatum des Kontakts |
|
E-Mail
|
string |
Kontakt-E-Mail |
|
|
Vorname
|
firstName | string |
FirstName des Kontakts |
|
id
|
id | string |
Kontakt-ID |
|
lastName
|
lastName | string |
Nachname des Kontakts |
|
name
|
name | string |
Kontaktname (Vorname + Nachname)) |
|
Telefonnummer
|
phoneNumber | string |
Telefonnummer des Kontakts |
|
tenantId
|
tenantId | string |
Mandanten-ID |
|
aktualisierte
|
updated | integer |
Datum der letzten Änderung des Kontakts |
|
userId
|
userId | string |
ID des Kontaktbesitzers |
contacts
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
items
|
items | array of contact |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
totalItems
|
totalItems | integer |
totalItems |
dataMapping
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Beschreibung
|
data1.description | string |
Metadatenbeschreibung |
|
name
|
data1.name | string |
Metadatenname |
|
pattern
|
data1.pattern | string |
Metadatenmuster |
|
options
|
data1.options | array of object |
options |
|
value
|
data1.options.value | string |
Metadatenwert |
|
type
|
data1.type | string |
type |
|
Beschreibung
|
data2.description | string |
Metadatenbeschreibung |
|
name
|
data2.name | string |
Metadatenname |
|
pattern
|
data2.pattern | string |
Metadatenmuster |
|
options
|
data2.options | array of object |
options |
|
value
|
data2.options.value | string |
Metadatenwert |
|
type
|
data2.type | string |
type |
|
Beschreibung
|
data3.description | string |
Metadatenbeschreibung |
|
name
|
data3.name | string |
Metadatenname |
|
pattern
|
data3.pattern | string |
Metadatenmuster |
|
options
|
data3.options | array of object |
options |
|
value
|
data3.options.value | string |
Metadatenwert |
|
type
|
data3.type | string |
type |
|
Beschreibung
|
data4.description | string |
Metadatenbeschreibung |
|
name
|
data4.name | string |
Metadatenname |
|
pattern
|
data4.pattern | string |
Metadatenmuster |
|
options
|
data4.options | array of object |
options |
|
value
|
data4.options.value | string |
Metadatenwert |
|
type
|
data4.type | string |
type |
|
Beschreibung
|
data5.description | string |
Metadatenbeschreibung |
|
name
|
data5.name | string |
Metadatenname |
|
pattern
|
data5.pattern | string |
Metadatenmuster |
|
options
|
data5.options | array of object |
options |
|
value
|
data5.options.value | string |
Metadatenwert |
|
type
|
data5.type | string |
type |
|
Beschreibung
|
data6.description | string |
Metadatenbeschreibung |
|
name
|
data6.name | string |
Metadatenname |
|
pattern
|
data6.pattern | string |
Metadatenmuster |
|
options
|
data6.options | array of object |
options |
|
value
|
data6.options.value | string |
Metadatenwert |
|
type
|
data6.type | string |
type |
|
Beschreibung
|
data7.description | string |
Metadatenbeschreibung |
|
name
|
data7.name | string |
Metadatenname |
|
pattern
|
data7.pattern | string |
Metadatenmuster |
|
options
|
data7.options | array of object |
options |
|
value
|
data7.options.value | string |
Metadatenwert |
|
type
|
data7.type | string |
type |
|
Beschreibung
|
data8.description | string |
Metadatenbeschreibung |
|
name
|
data8.name | string |
Metadatenname |
|
pattern
|
data8.pattern | string |
Metadatenmuster |
|
options
|
data8.options | array of object |
options |
|
value
|
data8.options.value | string |
Metadatenwert |
|
type
|
data8.type | string |
type |
Dokument
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
erstellt
|
created | integer |
Erstellungsdatum. |
|
groupId
|
groupId | string |
ID für die Gruppe des Dokumentbesitzers |
|
id
|
id | string |
ID des Dokuments |
|
Teile
|
parts | array of part |
Teile |
|
pdfSignatureFields
|
pdfSignatureFields | array of pdfSigField |
pdfSignatureFields |
|
signatureProfileId
|
signatureProfileId | string |
ID des Signaturprofils des Dokuments |
|
tenantId
|
tenantId | string |
Mandanten-ID |
|
aktualisierte
|
updated | integer |
Datum der letzten Änderung |
|
userId
|
userId | string |
Benutzer-ID des Dokumentbesitzers |
|
viewAuthorizedGroups
|
viewAuthorizedGroups | array of string |
Liste der Gruppen, die zum Anzeigen des Dokuments zugelassen sind |
|
viewAuthorizedUsers
|
viewAuthorizedUsers | array of string |
Liste der Benutzer, die das Dokument anzeigen dürfen |
|
workflowId
|
workflowId | string |
ID des Workflows, zu dem das Dokument gehört |
|
WorkflowName
|
workflowName | string |
Name des Workflows, zu dem das Dokument gehört |
Urkunden
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
items
|
items | array of document |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
totalItems
|
totalItems | integer |
totalItems |
Layout
Metadatenlayout
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
erstellt
|
created | number |
Erstellungsdatum. |
|
id
|
id | string |
Layout-ID |
|
isDisabled (istDeaktiviert)
|
isDisabled | boolean |
Wenn der Wert auf "true" festgelegt ist, wurde das Layout nicht angezeigt. |
|
name
|
name | string |
Der Name des Layouts |
|
tenantId
|
tenantId | string |
ID des Mandanten |
|
aktualisierte
|
updated | number |
Datum der letzten Änderung |
|
dataConfigurations
|
dataConfigurations | array of object | |
|
Schlitz
|
dataConfigurations.slot | string |
Metadatenelement (Daten1 zu Daten8) |
|
Standardeinstellung
|
dataConfigurations.default | string |
Standardwert für Metadaten in diesem Layout |
|
optional
|
dataConfigurations.optional | boolean |
Wenn "true", ist die Angabe eines Werts für diese Metadaten nicht obligatorisch. |
|
readonly
|
dataConfigurations.readonly | boolean |
Der Wert kann außer Kraft gesetzt werden. |
|
rememberLastValue
|
dataConfigurations.rememberLastValue | boolean |
Wenn dieser Wert auf "true" festgelegt ist, wird der Wert über Workflows hinweg beibehalten. |
Layouts
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
items
|
items | array of object | |
|
erstellt
|
items.created | number |
Erstellungsdatum. |
|
dataConfigurations
|
items.dataConfigurations | array of layout | |
|
itemsPerPage
|
itemsPerPage | number |
Anzahl der Elemente pro Seite |
|
pageIndex
|
pageIndex | number |
Index der zurückgegebenen Seite |
|
totalItems
|
totalItems | number |
Gesamtanzahl der vom Antrag betroffenen Elemente |
part
Dokumentteil
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Inhaltstyp
|
contentType | string |
Inhaltstyp |
|
filename
|
filename | string |
filename |
|
hash
|
hash | string |
hash |
|
size
|
size | integer |
size |
pdfSigField
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
imageHeight
|
imageHeight | float |
imageHeight |
|
imagePage
|
imagePage | float |
imagePage |
|
imageWidth
|
imageWidth | float |
imageWidth |
|
imageX
|
imageX | float |
imageX |
|
imageY
|
imageY | float |
imageY |
signatureProfile
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
erstellt
|
created | number |
Erstellungsdatum. |
|
documentType
|
documentType | string |
Typ der Dokumente |
|
forceScrollDocument
|
forceScrollDocument | boolean |
Erzwingen, dass der Signierer zum Ende des Dokuments scrollt |
|
id
|
id | string |
die Signaturprofil-ID |
|
isDefault
|
isDefault | boolean |
Macht dieses Signaturprofil zum Standardprofil |
|
isDisabled (istDeaktiviert)
|
isDisabled | boolean |
Dieses Signaturprofil deaktivieren |
|
name
|
name | string |
Der Signaturprofilname |
|
pdfSignatureImageText
|
pdfSignatureImageText | string |
Text, der in Signaturenpads angezeigt wird |
|
pdfSignatureImageTextColor
|
pdfSignatureImageTextColor | string |
Farbe des Texts, der in den Singaturen pads angezeigt wird |
|
pdfSignatureImageTextSize
|
pdfSignatureImageTextSize | number |
Größe des Texts, der in den Singaturenpads angezeigt wird |
|
pdfVisibleSignatureMode
|
pdfVisibleSignatureMode | string |
Sichtbarer Signaturmodus (zulässig, deaktiviert, noImage) |
|
Signaturtyp
|
signatureType | string |
pades, xadesDetached, xadesDetachedManifest, cades, helios |
|
tenantId
|
tenantId | string |
Mandanten-ID |
|
aktualisierte
|
updated | number |
Datum der letzten Änderung |
signatureProfiles
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
items
|
items | array of signatureProfile | |
|
itemsPerPage
|
itemsPerPage | number |
Anzahl der Elemente pro Seite |
|
pageIndex
|
pageIndex | number |
Index der zurückgegebenen Seite |
|
totalItems
|
totalItems | number |
Gesamtanzahl der vom Antrag betroffenen Elemente |
user
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
approveAllowed
|
approveAllowed | boolean |
Wenn dieser Wert auf "true" festgelegt ist, kann der Benutzer Dokumente genehmigen |
|
country
|
country | string |
Land des Benutzers |
|
erstellt
|
created | integer |
Erstellungsdatum. |
|
E-Mail
|
string |
E-Mail-Adresse des th-Benutzers |
|
|
Vorname
|
firstName | string |
Vorname des Benutzers |
|
groupId
|
groupId | string |
ID der Gruppe des Benutzers |
|
id
|
id | string |
ID des Benutzers |
|
isDisabled (istDeaktiviert)
|
isDisabled | boolean |
Bei "true" ist der Benutzer deaktiviert. |
|
lastLogin
|
lastLogin | integer |
Das datum der letzten Anmeldung des Benutzers |
|
lastName
|
lastName | string |
Nachname des Benutzers |
|
name
|
name | string |
Name (Vorname + Nachname) des Benutzers |
|
organizationTitles
|
organizationTitles | array of |
Die Witze des Benutzers in seinen Organisationen |
|
Telefonnummer
|
phoneNumber | string |
Telefonnummer des Benutzers |
|
signAllowed
|
signAllowed | boolean |
Bei Festlegung auf "true" kann der Benutzer Dokumente signieren. |
|
subject
|
subject | string |
Interner Unterkect-Code des Benutzers |
|
tenantId
|
tenantId | string |
ID des Mandanten |
|
aktualisierte
|
updated | integer |
Datum der letzten Änderung |
|
viewAuthorizedGroups
|
viewAuthorizedGroups | array of string |
Liste der Gruppen, in denen der Benutzer als Beobachter fungieren kann |
Arbeitsablauf
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
erstellt
|
created | integer |
erstellt |
|
currentRecipientEmails
|
currentRecipientEmails | array of |
currentRecipientEmails |
|
currentRecipientUsers
|
currentRecipientUsers | array of |
currentRecipientUsers |
|
Data1
|
data1 | string |
Metadaten 1 |
|
data2
|
data2 | string |
Metadaten 2 |
|
Data3
|
data3 | string |
Metadaten 3 |
|
data4
|
data4 | string |
Metadaten 4 |
|
Data5
|
data5 | string |
Metadaten 5 |
|
data6
|
data6 | string |
Metadaten 6 |
|
data7
|
data7 | string |
Metadaten 7 |
|
data8
|
data8 | string |
Metadaten 8 |
|
Beschreibung
|
description | string |
Beschreibung des Workflows |
|
E-Mail
|
string |
E-Mail des Workflowbesitzers |
|
|
Vorname
|
firstName | string |
Vorname des Workflowbesitzers |
|
groupId
|
groupId | string |
ID der Gruppe des Workflowbesitzers |
|
id
|
id | string |
ID des Workflows |
|
lastName
|
lastName | string |
Nachname des Workflowbesitzers |
|
layoutId
|
layoutId | string |
ID des Metadatenlayouts des Workflows |
|
logs
|
logs | array of |
Protokolliert Elemente des Wokflows |
|
name
|
name | string |
Name (Vorname + Nachname) des Workflowbesitzers |
|
notifiedEvents
|
notifiedEvents | array of string |
Lis von Ereignissen, die vom Workflow benachrichtigt werden |
|
Fortschritt
|
progress | integer |
Fortschritt des Workflows in Prozent |
|
steps
|
steps | array of object |
steps |
|
allowComments
|
steps.allowComments | boolean |
Erlaubt/verbietet interaktive Kommentare ara auf dem Schritt erlaubt |
|
hideAttachments
|
steps.hideAttachments | boolean |
Steuert die Anzeige von Anlagen für Signierer |
|
hideWorkflowRecipients
|
steps.hideWorkflowRecipients | boolean |
Steuert die Anzeige anderer Signierer an den Signierer. |
|
id
|
steps.id | string |
Schritt-ID |
|
invitePeriod
|
steps.invitePeriod | integer |
invitePeriod |
|
isFinished
|
steps.isFinished | boolean |
isFinished |
|
isStarted
|
steps.isStarted | boolean |
isStarted |
|
logs
|
steps.logs | array of |
logs |
|
maxInvites
|
steps.maxInvites | integer |
maxInvites |
|
recipients
|
steps.recipients | array of object |
recipients |
|
consentPageId
|
steps.recipients.consentPageId | string |
consentPageId |
|
country
|
steps.recipients.country | string |
country |
|
E-Mail
|
steps.recipients.email | string |
|
|
Vorname
|
steps.recipients.firstName | string |
Vorname |
|
lastName
|
steps.recipients.lastName | string |
lastName |
|
Telefonnummer
|
steps.recipients.phoneNumber | string |
Telefonnummer |
|
userId
|
steps.recipients.userId | string |
userId |
|
requiredRecipients
|
steps.requiredRecipients | integer |
requiredRecipients |
|
sendDownloadLink
|
steps.sendDownloadLink | boolean |
sendDownloadLink |
|
stepType
|
steps.stepType | string |
stepType |
|
gültigkeitPeriod
|
steps.validityPeriod | integer |
gültigkeitPeriod |
|
tenantId
|
tenantId | string |
tenantId |
|
aktualisierte
|
updated | integer |
aktualisierte |
|
userId
|
userId | string |
userId |
|
viewAuthorizedGroups
|
viewAuthorizedGroups | array of string |
Liste der Gruppen, in denen Benutzer als Beobachter fungieren können |
|
viewAuthorizedUsers
|
viewAuthorizedUsers | array of string |
viewAuthorizedUsers |
|
watchers
|
watchers | array of object |
watchers |
|
E-Mail
|
watchers.email | string |
|
|
notifiedEvents
|
watchers.notifiedEvents | array of string |
notifiedEvents |
|
userId
|
watchers.userId | string |
userId |
|
workflowStatus
|
workflowStatus | string |
workflowStatus |
workflows
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
items
|
items | array of workflow |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
totalItems
|
totalItems | integer |
totalItems |
binär
Dies ist der grundlegende Datentyp "binary".