DocuSign

Beispiele für Verbindungskonfigurationen

In diesem Abschnitt werden die Beispielwerte für die verschiedenen Felder aufgeführt, die Sie beim Erstellen der Verbindung konfigurieren.

Verbindungstyp „OAUTH 2.0 – Autorisierungscode“

Verbindungstyp „OAuth 2.0 – JWT-Inhaber“

Entitäten, Vorgänge und Aktionen

Alle Integration Connectors bieten eine Abstraktionsebene für die Objekte der verbundenen Anwendung. Sie können nur über diese Abstraktion auf die Objekte einer Anwendung zugreifen. Die Abstraktion wird Ihnen als Entitäten, Vorgänge und Aktionen zur Verfügung gestellt.

• Entität: Eine Entität kann als Objekt oder Sammlung von Attributen in der verbundenen Anwendung oder im verbundenen Dienst verstanden werden. Die Definition einer Entität unterscheidet sich von Connector zu Connector. Beispiel: In einem Datenbank-Connector sind Tabellen die Entitäten, in einem Dateiserver-Connector sind Ordner die Entitäten und in einem Nachrichtensystem-Connector sind Warteschlangen die Entitäten.

  Es ist jedoch möglich, dass ein Connector keine Entitäten unterstützt oder keine Entitäten enthält. In diesem Fall ist die Liste Entities leer.

• Vorgang: Ein Vorgang ist die Aktivität, die Sie für eine Entität ausführen können. Sie können einen der folgenden Vorgänge für eine Entität ausführen:
  • Liste
  • Abrufen
  • Erstellen
  • Aktualisieren
  • Löschen

  Durch Auswahl einer Entität aus der verfügbaren Liste wird eine Liste der Vorgänge generiert, die für die Entität verfügbar sind. Eine detaillierte Beschreibung der Vorgänge finden Sie in den Entitätsvorgängen der Connectors-Aufgabe. Wenn ein Connector jedoch keine der Entitätsvorgänge unterstützt, werden diese nicht unterstützten Vorgänge nicht in der Operations-Liste aufgeführt.

• Aktion: Eine Aktion ist eine Funktion erster Klasse, die über die Connector-Benutzeroberfläche für die Integration verfügbar gemacht wird. Mit einer Aktion können Sie Änderungen an einer oder mehreren Entitäten vornehmen, die von Connector zu Connector unterschiedlich sind. Normalerweise hat eine Aktion einige Eingabeparameter und einen Ausgabeparameter. Es ist jedoch möglich, dass ein Connector keine Aktionen unterstützt. In diesem Fall ist die Actions-Liste leer.

Aktionen

In diesem Abschnitt werden alle von der DocuSign-Verbindung unterstützten Aktionen aufgeführt.

Aktion „CreateAndSendEnvelope“

Erstellt und sendet einen Umschlag oder erstellt einen Umschlagentwurf.

Eingabeparameter der Aktion „CreateAndSendEnvelope“

Beispiele für die Konfiguration der Aktion CreateAndSendEnvelope finden Sie unter Beispiele.

Beispiele für Aktionen

In diesem Abschnitt wird beschrieben, wie Sie einige der Aktionen in diesem Connector ausführen.

Beispiel – CreateAndSendEnvelope

Mit dieser Aktion wird ein Envelope erstellt und gesendet oder ein Envelope-Entwurf erstellt.

1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
2. Wählen Sie die Aktion CreateAndSendEnvelope aus und klicken Sie auf Fertig.
3. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in Feld Default Value ein:

   {
   "EmailSubject": "Please Sign this Document",
   "FileName": "test.txt\ntest.pdf",
   "SignersEmail": "cloudysanfrancisco@gmail.com",
   "SignersRecipientId": "53386460",
   "CcRecipientId": "67173451",
   "CcEmail": "baklavainthebalkans@gmail.com",
   "DocumentId": "1",
   "Status": "sent",
   "CustomFieldAggregate": "CustomFieldName",
   "ContentBytes": "abcd***",
   "HasBytes": true,
   "SignersName": "\"test\"",
   "CcName": "\"test\"",
   "Content": "test content in file"
   }
   

Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload der Connector-Aufgabe einen Wert ähnlich dem folgenden:

 [{
"Success":"true",
"envelopeid":"542a77ff-b533-4b39-9d82-e397ef5a70c9",
"uri":"/envelopes/542a77ff-b533-4b39-9d82-e397ef5a70c9",
"statusdatetime":"2025-04-09T12:33:47.1130000Z",
"status":"sent",
"customfieldaggregate": "CustomFieldName"
}]

Beispiele für Entitätsvorgänge

In diesem Abschnitt wird beschrieben, wie Sie einige Entitätsvorgänge in diesem Connector ausführen.

Der Wert für eine Entitäts-ID sollte direkt übergeben werden, z. B. 16ab549b-95d7-47cb-b557-c2476ef62d9d. Die ID 16ab549b-95d7-47cb-b557-c2476ef62d9d ist der eindeutige Primärschlüsselwert, der übergeben werden muss.

Beispiel – LIST-Vorgang für die Entität „Accounts“

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Liste Entity die Option „Konten“ aus.
3. Wählen Sie den Vorgang LIST aus und klicken Sie auf Fertig.
4. Im Bereich Aufgabeneingabe der Aufgabe Connectors können Sie die filterClause nach Bedarf festlegen.

Beispiel – LIST-Vorgang für die Entität „Documents“

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Liste Entity „Dokumente“ aus.
3. Wählen Sie den Vorgang LIST aus und klicken Sie auf Fertig.
4. Im Bereich Aufgabeneingabe der Aufgabe Connectors können Sie die filterClause nach Bedarf festlegen.

Beispiel – LIST-Vorgang für die Entität „Umschläge“

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Liste Entity „Umschläge“ aus.
3. Wählen Sie den Vorgang LIST aus und klicken Sie auf Fertig.
4. Im Bereich Aufgabeneingabe der Aufgabe Connectors können Sie die filterClause nach Bedarf festlegen.

Beispiel – LIST-Vorgang für die Entität „Folders“ (Ordner)

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Liste Entity „Ordner“ aus.
3. Wählen Sie den Vorgang LIST aus und klicken Sie auf Fertig.
4. Im Bereich Aufgabeneingabe der Aufgabe Connectors können Sie die filterClause nach Bedarf festlegen.

Beispiel – LIST-Vorgang für die Entität „Groups“

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Liste Entity die Option „Gruppen“ aus.
3. Wählen Sie den Vorgang LIST aus und klicken Sie auf Fertig.
4. Im Bereich Aufgabeneingabe der Aufgabe Connectors können Sie die filterClause nach Bedarf festlegen.

Beispiel – LIST-Vorgang für die Entität „Users“

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Liste Entity „Nutzer“ aus.
3. Wählen Sie den Vorgang LIST aus und klicken Sie auf Fertig.
4. Im Bereich Aufgabeneingabe der Aufgabe Connectors können Sie die filterClause nach Bedarf festlegen.

Sie können LIST-Vorgänge auch für die folgenden Entitäten ausführen:

• UserInfo
• UserSignatures
• Arbeitsbereiche
• Empfänger
• AccountBrands
• AccountCustomFields
• EnvelopeTemplates
• EnvelopeAttachments
• EnvelopeConsumerDisclosures
• CloudStorageProviders
• CustomTabs
• Schlösser
• GroupBrands
• GroupUsers
• PowerForms
• RecipientTabs
• SigningGroups
• SigningGroupUsers
• Vorlagen

Beispiel – Einzelnen Datensatz für die Entität „Konten“ abrufen

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Liste Entity die Option „Konten“ aus.
3. Wählen Sie den Vorgang GET aus und klicken Sie auf Fertig.
4. Klicken Sie zum Festlegen der Entitäts-ID im Bereich Data Mapper von Data Mapping auf Open Data Mapping Editor. Geben Sie dann 2.4578824E7 in das Feld Input Value ein und wählen Sie „EntityId“ als lokale Variable aus.

Beispiel – Einzelnen Datensatz für die Entität „Dokumente“ abrufen

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Liste Entity „Dokumente“ aus.
3. Wählen Sie den Vorgang LIST aus und klicken Sie auf Fertig.
4. Klicken Sie zum Festlegen der Filterklausel im Bereich Data Mapper der Aufgabe Data Mapping auf Open Data Mapping Editor (Datenabgleichs-Editor öffnen), geben Sie Type='envelopes' AND Id='8e18be14-3254-4cbe-947d-f0d1cd62f5f8' in das Feld Input Value (Eingabewert) ein und wählen Sie die Filterklausel als lokale Variable aus.

Beispiel – Einzelnen Datensatz für die Entität „Envelopes“ abrufen

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Liste Entity „Umschläge“ aus.
3. Wählen Sie den Vorgang GET aus und klicken Sie auf Fertig.
4. Klicken Sie zum Festlegen der Entitäts-ID im Bereich Data Mapper von Data Mapping auf Open Data Mapping Editor. Geben Sie dann 8e18be14-3254-4cbe-947d-f0d1cd62f5f87 in das Feld Input Value ein und wählen Sie „EntityId“ als lokale Variable aus.

Beispiel – Einzelnen Datensatz für die Entität „Ordner“ abrufen

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Liste Entity „Ordner“ aus.
3. Wählen Sie den Vorgang GET aus und klicken Sie auf Fertig.
4. Klicken Sie zum Festlegen der Entitäts-ID im Bereich Data Mapper von Data Mapping auf Open Data Mapping Editor. Geben Sie dann 05f76d13-a513-492b-8c58-176702768db0 in das Feld Input Value ein und wählen Sie „EntityId“ als lokale Variable aus.

Beispiel – Einzelnen Datensatz für die Entität „Groups“ abrufen

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Liste Entity die Option „Gruppen“ aus.
3. Wählen Sie den Vorgang GET aus und klicken Sie auf Fertig.
4. Klicken Sie zum Festlegen der Entitäts-ID im Bereich Data Mapper von Data Mapping auf Open Data Mapping Editor. Geben Sie dann 1.4167231E7 in das Feld Input Value ein und wählen Sie „EntityId“ als lokale Variable aus.

Beispiel – Einzelnen Datensatz für die Entität „Nutzer“ abrufen

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Liste Entity „Nutzer“ aus.
3. Wählen Sie den Vorgang GET aus und klicken Sie auf Fertig.
4. Klicken Sie zum Festlegen der Entitäts-ID im Bereich Data Mapper von Data Mapping auf Open Data Mapping Editor. Geben Sie dann 16ab549b-95d7-47cb-b557-c2476ef62d9d in das Feld Input Value ein und wählen Sie „EntityId“ als lokale Variable aus.

Sie können auch GET-Vorgänge für die folgenden Entitäten ausführen:

• UserInfo
• UserSignatures
• Arbeitsbereiche
• Empfänger
• AccountBrands
• AccountCustomFields
• EnvelopeTemplates
• EnvelopeAttachments
• EnvelopeConsumerDisclosures
• CloudStorageProviders
• CustomTabs
• Schlösser
• GroupBrands
• GroupUsers
• RecipientTabs
• SigningGroups
• SigningGroupUsers
• Vorlagen