breadcrumbDescription
Eksempel på Salesforce Contracts API-sekvens
Her er en eksempelsekvens af Salesforce Contracts API-kald, der dækker en optimal sti for en end-to-end kontraktlivscyklus. Livscyklussen starter, når du opretter en kontrakt, og kontrakten er i kladdetilstanden til kontraktaktivering.
| API-sekvens | Scenarie | Metodetype | API-sti | Beskrivelse |
|---|---|---|---|---|
| 1 | Opret kontrakt | POST | <dit domæne-URL>/services/data/{API version}/connect/clm/contract | Hvis du vil oprette en kontrakt fra salgsmulighed, tilbud, bestilling eller ethvert andet standardobjekt eller tilpasset objekt. Når en kontrakt er oprettet, er den i kladdestatus. anmod om brødtekst: Hvis konfigurationstypen Generer automatisk dokument ved kontraktoprettelse er indstillet til true, genererer applikationen automatisk en kontraktdokumentversion, når der oprettes en kontrakt. |
| 2 | Hent dokumentskabeloner | GET | <dit domæne-URL>/services/data/{API version}/connect/clm/document-skabelon?usageType=Contract_LifeCycle_Management&isActive=true&type=MicrosoftWord | Viser alle aktive dokumentskabeloner. Som standard vises de skabeloner, der opfylder disse kriterier: Type = ‘Microsoftword’, UsageType = ‘Contract_Lifecycle_Management’, IsActive = sand Hvis du ønsker oplysninger om tilpasset filtrering, kan du se Brug tilpasset dokumentskabelonfiltrering til Salesforce Contracts. |
| 3 | Generer kontraktdokument | PATCH | <dit domæne-URL>/services/data/{API version}/connect/clm/contract/{ContractId}/contract-document-version | Hvis du vil generere en ny kontraktdokumentversion. Kontraktstatussen skal være i kladdetilstanden for at generere en ny kontraktdokumentversion. anmod om brødtekst: |
| 4 | Check ind | PATCH | <dit domæne-URL>/services/data/{API version}/connect/clm/contract-document-version/${contract document version ID}/checkin | Hvis du vil kontrollere den seneste kontraktdokumentversion, der er både inaktiv og låst.Bemærk: Det er kun den bruger, der genererede dokumentet, der kan foretage indcheckning. |
| 5 | Lås | PATCH | <dit domæne-URL>/services/data/{API version}/connect/clm/contract-document-version/${contract document version ID}/lock | Hvis du vil låse den aktuelle kontraktdokumentversion. Du kan kun låse en kontraktdokumentversion, når kontrakten er i en kladdetilstand, og kontraktdokumentversionen er aktiv eller er checket ind. |
| 6 | Lås op | PATCH | <dit domæne-URL>/services/data/{API version}/connect/clm/contract-document-version/${contract document version ID}/unlock | Hvis du vil låse den aktuelle kontraktdokumentversion op. Kun den bruger, der låste kontraktdokumentversionen eller en systemadministrator, kan låse en låst kontraktdokumentversion op. |
| 7 | Se Generate (Generer) | PATCH | <dit domæne URL>/services/data/{API version}/connect/clm/contract-document-version/{$contract document version id}/Checkout | Hvis du vil generere en ny kontraktdokumentversion ved brug af den samme eller en anden skabelon ved brug af genereringshandlingen Afkryds. anmod om brødtekst: Efter Check Out skal du køre Check In API. |
| 8 | Indsend til godkendelse (udfør handling) | PATCH | <dit domæne-URL>/services/data/{API version}/connect/clm/contract/${contractid} | Hvis du vil kalde indsendelsen til godkendelseshandling ved brug af Kør handlings-API. Slutpunktet forbliver det samme. Men hver API har forskellige anmodningsparametre. Godkendelsesproces skal konfigureres. |
| 9 | Godkend | Ikke gældende | Ikke gældende | Dette er en generisk Salesforce-godkendelses-API. Hvis du ønsker yderligere oplysninger, kan du se https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_process_approvals_approve.htm. |
| 10 | Hent dokumenter til eSign med kontrakt | GET | <dit domæne-URL>/services/data/{API version}/connect/e-sign/documents?sourceObjectId=${contractId} | Hvis du vil se listen over dokumenter, der er tilknyttet en kontrakt, som du ønsker at sende til e-signatur. Dokumentdetaljerne er obligatoriske for at sende til e-signatur. Du kan tilpasse dokumentlisten ved brug af en tilpasset Apex. Apex skal tilføjes i konfigurationen af elektroniske signaturer. |
| 11 | Hent modtagere | GET | <dit domæne-URL>/services/data/{API version}/connect/e-sign/recipients?recipientSelector=ESignContactList&sourceObjectId={$contractId} | Hvis du vil se en liste over dokumentmodtagere. Modtageroplysningerne er obligatoriske for at sende til e-signatur. Du kan tilpasse modtagerlisten ved brug af en tilpasset Apex. Apex skal tilføjes i konfigurationen af elektroniske signaturer. |
| 12 | Hent adviseringsindstillinger | GET | <dit domæne-URL>/services/data/{API version}/connect/e-sign/notification-settings?sourceObjectId={$contractId} | Hvis du vil se indstillinger for påmindelse og udløbsadvisering.Bemærk: Adviseringsdetaljerne er obligatoriske for at sende til e-signatur. |
| 13 | Hent signerroller | GET | <dit domæne-URL>/services/data/{API version}/connect/e-sign/signer-roles | Hvis du vil se listen over underskrivere, der signerer og tilføjer data til at danne felter på dokumenterne i konvolutten. Signeringsdetaljerne er obligatoriske for at sende til e-signatur. |
| 14 | Send for e-sign (udfør handling) | PATCH | <dit domæne-URL>/services/data/{API version}/connect/clm/contract/${contractid} | Hvis du vil aktivere en ny DocuSign-transaktion ved brug af Send konvolut-API. Handlingen api skal dække følgende parametre: Eksempel på anmodningshovedtekst. Du skal konvertere JSON-detaljer til Streng og tilføje dem i anmodningens brødtekst ovenfor. actionData er en strengført JSON, der indeholder dokument, opskrift, signerroller og adviseringsindstillinger. |
| 15 | Opdater konvolutstatus | PATCH | <dit domæne-URL>/services/data/{API version}/connect/clm/contract/${contractid} | Hvis du vil sende en ad hoc-anmodning til DocuSign om at opdatere konvolutstatussen. Når signereren har signeret dokumentet, kan du kalde Update Envelope-API. |
| 16 | Aktiver kontrakt (udfør handling) |
PATCH | <dit domæne-URL>/services/data/{API version}/connect/clm/contract/${contractid} | Hvis du vil aktivere kontrakten. Brug API til at aktivere kontrakten. |
| 17 | Afslut kontrakt | PATCH | <dit organisationsdetaljer>/services/data/{API version}/connect/clm/contract/${contractid} | Hvis du vil opsige kontrakten. |
Yderligere API'er
| Scenarie | Metodetype | API-sti | Beskrivelse |
|---|---|---|---|
| Hent liste over kontraktdokumentversioner | GET | <dit domæne-URL>/services/data/{API version}/connect/clm/contract/<contractid>/contract-document-version | Hvis du vil se listen over kontraktdokumentversioner, der allerede er tilgængelige i kontrakten. |
| Hent SpecificContract-dokumentversion | GET | <dit domæne-URL>/services/data/{API version}/connect/clm/contract/{ContractId}/contract-document-version?contractDocumentVersionId={ContractDocumentVersionId} | Hvis du vil se en specifik kontraktdokumentversion, der allerede er tilgængelig i kontrakten. |
