Sie befinden sich hier:
Beispiel-API-Sequenz für Salesforce Contracts
Im Folgenden finden Sie eine Beispielsequenz von Salesforce Contracts API-Aufrufen, die einen optimalen Pfad für einen durchgängigen Vertragslebenszyklus abdeckt. Der Lebenszyklus beginnt, wenn Sie einen Vertrag erstellen und sich der Vertrag im Entwurfsstatus zur Vertragsaktivierung befindet.
| API-Sequenz | Szenario | Methodentyp | API-Pfad | Beschreibung |
|---|---|---|---|---|
| 1 | Vertrag erstellen | POST | <Ihr Domänen-URL>/services/data/{API version}/connect/clm/contract | Erstellen eines Vertrags anhand einer Opportunity, eines Angebots, eines Auftrags oder eines anderen standardmäßigen oder benutzerdefinierten Objekts. Nachdem ein Vertrag erstellt wurde, befindet er sich im Entwurfsstatus. Anforderungstext: Wenn der Konfigurationstyp "Dokument bei Vertragserstellung automatisch generieren" auf "true" festgelegt ist, generiert die Anwendung beim Erstellen eines Vertrags automatisch eine Vertragsdokumentversion. |
| 2 | Abrufen von Dokumentvorlagen | GET | <Ihre Domäne URL>/services/data/{API version}/connect/clm/document-template?usageType=Contract_LifeCycle_Management&isActive=true&type=MicrosoftWord | Listet alle aktiven Dokumentvorlagen auf. Standardmäßig werden die Vorlagen aufgeführt, die diese Kriterien erfüllen: Typ = "Microsoftword", UsageType = "Contract_Lifecycle_Management", IsActive = true Informationen zur benutzerdefinierten Filterung finden Sie unter Verwenden der benutzerdefinierten Dokumentvorlagenfilterung für Salesforce Contracts. |
| 3 | Vertragsdokument generieren | PATCH | <Ihre Domänen-URL>/services/data/{API version}/connect/clm/contract/{ContractId}/contract-document-version | Generieren einer neuen Vertragsdokumentversion. Der Vertragsstatus muss sich im Entwurfsstatus befinden, um eine neue Vertragsdokumentversion zu generieren. Anforderungstext: |
| 4 | Begrüßungsformel | PATCH | <Ihre Domänen-URL>/services/data/{API version}/connect/clm/contract-document-version/${contract document version ID}/checkin | Einchecken der neuesten Vertragsdokumentversion, die inaktiv und gesperrt ist.Hinweis: Nur der Benutzer, der das Dokument generiert hat, kann den Check-in durchführen. |
| 5 | Sperren | PATCH | <Ihre Domänen-URL>/services/data/{API version}/connect/clm/contract-document-version/${contract document version ID}/lock | Sperren der aktuellen Vertragsdokumentversion. Sie können eine Vertragsdokumentversion nur sperren, wenn sich der Vertrag in einem Entwurfsstatus befindet und die Vertragsdokumentversion aktiv oder eingecheckt ist. |
| 6 | Entsperren | PATCH | <Ihre Domänen-URL>/services/data/{API version}/connect/clm/contract-document-version/${contract document version ID}/unlock | Entsperren der aktuellen Vertragsdokumentversion. Nur der Benutzer, der die Vertragsdokumentversion gesperrt hat, oder ein Systemadministrator können eine gesperrte Vertragsdokumentversion entsperren. |
| 7 | Check Out Generieren | PATCH | <URL Ihrer Domäne>/services/data/{API version}/connect/clm/contract-document-version/{$contract document version id} / Checkout | Wenn Sie eine neue Vertragsdokumentversion mit derselben oder einer anderen Vorlage generieren möchten, sehen Sie sich die Aktion zum Generieren an. Anforderungstext: Nach dem Check-out müssen Sie die Check-in-API ausführen. |
| 8 | Zur Genehmigung senden (Aktion ausführen) | PATCH | <Ihre Domänen-URL>/services/data/{API version}/connect/clm/contract/${contractid} | Aufrufen der Aktion "Zur Genehmigung senden" mithilfe der API zum Ausführen von Aktionen. Der Endpunkt bleibt gleich. Jede API weist jedoch unterschiedliche Anforderungsparameter auf. Der Genehmigungsprozess muss konfiguriert sein. |
| 9 | Genehmigen | entfällt | entfällt | Dies ist eine generische Salesforce-Genehmigungs-API. Weitere Informationen finden Sie unter https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_process_approvals_approve.htm. |
| 10 | Abrufen von Dokumenten für eSign mit Vertrag | GET | <Ihre Domänen-URL>/services/data/{API version}/connect/e-sign/documents?sourceObjectId=${contractId} | Anzeigen der Liste der Dokumente, die einem Vertrag zugeordnet sind, den Sie zur elektronischen Signatur senden möchten. Die Dokumentdetails müssen zur elektronischen Signatur gesendet werden. Sie können die Dokumentliste mithilfe einer benutzerdefinierten Apex-Klasse anpassen. Die Details der Apex-Klasse müssen in der Konfiguration der elektronischen Signatur hinzugefügt werden. |
| 11 | Empfänger abrufen | GET | <Ihre Domänen-URL>/services/data/{API version}/connect/e-sign/recipients?recipientSelector=ESignContactList&sourceObjectId={$contractId} | Anzeigen einer Liste der Dokumentempfänger. Die Empfängerdetails müssen zur elektronischen Signatur gesendet werden. Sie können die Empfängerliste mithilfe einer benutzerdefinierten Apex-Klasse anpassen. Die Details der Apex-Klasse müssen in der Konfiguration der elektronischen Signatur hinzugefügt werden. |
| 12 | Einstellungen für "Benachrichtigung abrufen" | GET | <Ihre Domänen-URL>/services/data/{API version}/connect/e-sign/notification-settings?sourceObjectId={$contractId} | Anzeigen der Einstellungen für Erinnerungen und Ablaufbenachrichtigungen.Hinweis: Die Benachrichtigungsdetails müssen zur elektronischen Signatur gesendet werden. |
| 13 | Abrufen von Unterzeichnerrollen | GET | <Ihre Domänen-URL>/services/data/{API version}/connect/e-sign/signer-roles | Anzeigen der Liste der Unterzeichner, die Formularfeldern in den Dokumenten im Umschlag unterschreiben und Daten hinzufügen. Die Unterzeichnerdetails sind obligatorisch, um sie zur elektronischen Signatur zu senden. |
| 14 | Für E-Sign senden (Aktion ausführen) | PATCH | <Ihre Domänen-URL>/services/data/{API version}/connect/clm/contract/${contractid} | Aktivieren einer neuen DocuSign-Transaktion mithilfe der API "Umschlag senden". Die Aktion api muss die folgenden Parameter abdecken: Beispiel-Anforderungstext. Sie müssen JSON-Details in "Zeichenfolge" konvertieren und sie im obigen Anforderungstext hinzufügen. actionData ist eine JSON-Zeichenfolge, die Dokument-, Rezeptint-, Unterzeichnerrollen- und Benachrichtigungseinstellungen enthält. |
| 15 | Aktualisieren des Umschlagstatus | PATCH | <Ihre Domänen-URL>/services/data/{API version}/connect/clm/contract/${contractid} | Senden einer Ad-hoc-Anforderung an DocuSign zum Aktualisieren des Umschlagstatus. Sobald der Unterzeichner das Dokument signiert hat, können Sie die API "Umschlag aktualisieren" aufrufen. |
| 16 | Vertrag aktivieren (Aktion ausführen) |
PATCH | <Ihre Domänen-URL>/services/data/{API version}/connect/clm/contract/${contractid} | Aktivieren des Vertrags. Verwenden Sie die API zum Aktivieren des Vertrags. |
| 17 | Vertrag kündigen | PATCH | <Ihre Organisationsdetails>/services/data/{API version}/connect/clm/contract/${contractid} | Zum Kündigen des Vertrags. |
Zusätzliche APIs
| Szenario | Methodentyp | API-Pfad | Beschreibung |
|---|---|---|---|
| Abrufen der Liste der Vertragsdokumentversionen | GET | <Ihre Domänen-URL>/services/data/{API version}/connect/clm/contract/<contractid>/contract-document-version | Anzeigen der Liste der Vertragsdokumentversionen, die bereits im Vertrag verfügbar sind. |
| Abrufen der Dokumentversion "SpecificContract" | GET | <Ihre Domänen-URL>/services/data/{API version}/connect/clm/contract/{ContractId}/contract-document-version?contractDocumentVersionId={ContractDocumentVersionId} | Anzeigen einer bestimmten Vertragsdokumentversion, die bereits im Vertrag verfügbar ist. |
