Du är här:
Exempel på Salesforce Contracts API-sekvens
Här är ett exempel på en sekvens av Salesforce Contracts API-anrop, som täcker en optimal väg för en livscykel för hela kontraktet. Livscykeln startar när du skapar ett kontrakt och kontraktet är i utkastläget för att kontraktsaktivering.
| API-sekvens | Scenario | Metodtyp | API-sökväg | Beskrivning |
|---|---|---|---|---|
| 1 | Skapa kontrakt | POST | <din domän-URL>/services/data/{API-version}/connect/clm/contract | Skapa ett kontrakt från säljprojekt, offert, order eller något annat standardobjekt eller eget objekt. När ett kontrakt har skapats är det i utkaststatus. begärans brödtext: Om konfigurationstypen Skapa dokument automatiskt är inställd på sant skapar programmet automatiskt en kontraktdokumentversion när ett kontrakt skapas. |
| 2 | Hämta dokumentmallar | GET | <din domän-URL>/services/data/{API-version}/connect/clm/document-template?usageType=Contract_LifeCycle_Management&isActive=true&type=MicrosoftWord | Listar alla aktiva dokumentmallar. Som standard listas de mallar som uppfyller dessa kriterier: Typ = ‘Microsoftword’, UsageType = ‘Contract_Lifecycle_Management’, IsActive = sant Mer information om egen filtrering finns i Använd egen dokumentmallfiltrering för Salesforce Contracts. |
| 3 | Skapa kontraktdokument | PATCH | <din domän-URL>/services/data/{API-version}/connect/clm/contract/{ContractId}/contract-document-version | Skapa en ny kontraktdokumentversion. Kontraktstatusen måste vara i utkastläget för att skapa en ny kontraktdokumentversion. begärans brödtext: |
| 4 | Checka in | PATCH | <din domän-URL>/services/data/{API-version}/connect/clm/contract-document-version/${contract document version ID}/checkin | För att checka in den senaste kontraktdokumentversionen som är både inaktiv och låst.Obs! Endast användaren som skapade dokumentet kan utföra incheckning. |
| 5 | Lås | PATCH | <din domän-URL>/services/data/{API-version}/connect/clm/contract-document-version/${contract document version ID}/lock | Låsa den aktuella kontraktdokumentversionen. Du kan endast låsa en kontraktdokumentversion när kontraktet är i utkastläge och kontraktdokumentversionen är aktiv eller incheckad. |
| 6 | Lås upp | PATCH | <din domän-URL>/services/data/{API-version}/connect/clm/contract-document-version/${contract document version ID}/unlock | För att låsa upp den aktuella kontraktdokumentversionen. Endast användaren som låste kontraktdokumentversionen eller en systemadministratör kan låsa upp en låst kontraktdokumentversion. |
| 7 | Skapa checkout | PATCH | <din domän-URL>/services/data/{API-version}/connect/clm/contract-document-version/{$contract document version id}/Checkout | För att skapa en ny kontraktdokumentversion med samma eller en annan mall med hjälp av åtgärden Skapa i checkout. begärans brödtext: Efter Checka ut måste du köra Checka in API. |
| 8 | Skicka för godkännande (Kör åtgärd) | PATCH | <din domän-URL>/services/data/{API-version}/connect/clm/contract/${contractid} | För att anropa åtgärden Skicka för godkännande med Execute Action API. Slutpunkten förblir densamma, men varje API har olika begärandeparametrar. Godkännandeprocessen måste vara konfigurerad. |
| 9 | Godkänn | Saknas | Saknas | Detta är en allmän Salesforce Approval API. Mer information finns på https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_process_approvals_approve.htm. |
| 10 | Hämta dokument för eSign med kontrakt | GET | <din domän-URL>/services/data/{API-version}/connect/e-sign/documents?sourceObjectId=${contractId} | För att visa listan över dokument som är associerade med ett kontrakt som du vill skicka för e-signatur. Dokumentdetaljerna är obligatoriska att skicka för e-signatur. Du kan anpassa dokumentlistan med hjälp av en egen Apex klass. Detaljerna för Apex måste läggas till i konfigurationen för elektronisk signatur. |
| 11 | Hämta mottagare | GET | <din domän-URL>/services/data/{API-version}/connect/e-sign/recipients?recipientSelector=ESignContactList&sourceObjectId={$contractId} | För att visa en lista över dokumentmottagare. Mottagaruppgifterna är obligatoriska att skicka för e-signatur. Du kan anpassa mottagarlistan med hjälp av en egen Apex klass. Detaljerna för Apex måste läggas till i konfigurationen för elektronisk signatur. |
| 12 | Hämta notisinställningar | GET | <din domän-URL>/services/data/{API-version}/connect/e-sign/notification-settings?sourceObjectId={$contractId} | För att se inställningar för påminnelser och notiser om att de går ut.Obs! Notisdetaljerna är obligatoriska att skicka för e-signatur. |
| 13 | Hämta signerarroller | GET | <din domän-URL>/services/data/{API-version}/connect/e-sign/signer-roles | För att visa listan över signerare som signerar och lägger till data i formulärfält i dokumenten i kuvertet. Signeraruppgifterna är obligatoriska att skicka för e-signatur. |
| 14 | Skicka för e-signering (utför åtgärd) | PATCH | <din domän-URL>/services/data/{API-version}/connect/clm/contract/${contractid} | Aktivera en ny DocuSign-transaktion med Skicka kuvert-API. Åtgärds-API måste omfatta följande parametrar: Exempel på begärantext. Du måste konvertera JSON-detaljer till Sträng och lägga till den i ovanstående begärans brödtext. actionData är en strängad JSON som innehåller inställningar för dokument, receptint, signerarroller och notiser. |
| 15 | Uppdatera kuvertstatus | PATCH | <din domän-URL>/services/data/{API-version}/connect/clm/contract/${contractid} | Skicka en ad hoc-begäran till DocuSign för att uppdatera kuvertstatusen. När signeraren har signerat dokumentet kan du anropa Update Envelope API. |
| 16 | Aktivera kontrakt (utför åtgärd) |
PATCH | <din domän-URL>/services/data/{API-version}/connect/clm/contract/${contractid} | Aktivera kontraktet. Använd API för att aktivera kontraktet. |
| 17 | Avsluta kontrakt | PATCH | <your org details>/services/data/{API version}/connect/clm/contract/${contractid} | Avsluta kontraktet. |
Ytterligare API
| Scenario | Metodtyp | API-sökväg | Beskrivning |
|---|---|---|---|
| Hämta lista över kontraktdokumentversioner | GET | <din domän-URL>/services/data/{API-version}/connect/clm/contract/<contractid>/contract-document-version | För att se listan över kontraktdokumentversioner som redan är tillgängliga i kontraktet. |
| Hämta dokumentversion för SpecificContract | GET | <din domän-URL>/services/data/{API-version}/connect/clm/contract/{ContractId}/contract-document-version?contractDocumentVersionId={ContractDocumentVersionId} | För att se en specifik kontraktdokumentversion som redan är tillgänglig i kontraktet. |
