Du er her:
Eksempel på Salesforce Contracts API-sekvens
Her er et eksempel på en sekvens av Salesforce Contracts API-kall, som dekker en optimal bane for en livssyklus for slutt-til-slutt-kontrakter. Livssyklusen starter når du oppretter en kontrakt og kontrakten er i utkasttilstand til kontraktsaktivering.
| API-sekvens | Scenario | Metodetype | API-bane | Beskrivelse |
|---|---|---|---|---|
| 1 | Opprette kontrakt | POST | <URL-adressen til domenet ditt>/services/data/{API version}/connect/clm/contract | For å opprette en kontrakt fra salgsmulighet, tilbud, bestilling eller et annet standardobjekt eller tilpasset objekt. Når en kontrakt har blitt opprettet, er den i utkaststatus. Forespørselstekst: Hvis konfigurasjonstypen Auto Generate Document On Contract Creation er satt til true, genererer programmet automatisk en kontraktdokumentversjon når en kontrakt opprettes. |
| 2 | Hente dokumentmaler | GET | <URL-adressen til domenet ditt>/services/data/{API version}/connect/clm/document-template?usageType=Contract_LifeCycle_Management&isActive=true&type=MicrosoftWord | Viser alle de aktive dokumentmalene. Malene som oppfyller disse kriteriene, er som standard oppført: Type = 'Microsoftword', UsageType = 'Contract_Lifecycle_Management', IsActive = sann Hvis du vil ha informasjon om tilpasset filtrering, kan du se Bruk tilpasset dokumentmalfiltrering for Salesforce Contracts. |
| 3 | Generere kontraktsdokument | PATCH | <URL-adressen til domenet ditt>/services/data/{API version}/connect/clm/contract/{ContractId}/contract-document-version | For å generere en ny kontraktsdokumentversjon. Kontraktsstatusen må være i utkasttilstanden for å kunne generere en ny kontraktsdokumentversjon. Forespørselstekst: |
| 4 | Innsjekking | PATCH | <URL-adressen til domenet ditt>/services/data/{API version}/connect/clm/contract-document-version/${kontraktsdokumentversjons-ID}/checkin | Slik sjekker du den nyeste kontraktdokumentversjonen som er både inaktiv og låst.Merk: Bare brukeren som genererte dokumentet, kan utføre Innsjekking. |
| 5 | Lås | PATCH | <URL-adressen til domenet ditt>/services/data/{API version}/connect/clm/contract-document-version/${kontraktsdokumentversjons-ID}/lock | For å låse den gjeldende kontraktsdokumentversjonen. Du kan bare låse en kontraktsdokumentversjon når kontrakten er i utkasttilstand og kontraktsdokumentversjonen er aktiv eller merket inn. |
| 6 | Lås opp | PATCH | <URL-adressen til domenet ditt>/services/data/{API version}/connect/clm/contract-document-version/${kontraktsdokumentversjons-ID}/unlock | Slik låser du opp den gjeldende kontraktsdokumentversjonen. Bare brukeren som låste kontraktsdokumentversjonen, eller en systemadministrator, kan låse opp en låst kontraktsdokumentversjon. |
| 7 | Se gjennom Generer | PATCH | <URL-adressen til domenet ditt>/services/data/{API version}/connect/clm/contract-document-version/{$contract document version id}/Checkout | Hvis du vil generere en ny kontraktsdokumentversjon ved å bruke den samme eller forskjellige malen, bruker du utkontrollert genereringshandling. Forespørselstekst: Etter utsjekking må du kjøre APIen for innsjekking. |
| 8 | Send til godkjenning (utfør handling) | PATCH | <URL-adressen til domenet ditt>/services/data/{API version}/connect/clm/contract/${contractid} | For å kalle opp handlingen Send til godkjenning med Execute Action API. Sluttpunktet forblir det samme, men hver API har forskjellige forespørselsparametere. Godkjenningsprosess må være konfigurert. |
| 9 | Godkjenn | Ikke relevant | Ikke relevant | Dette er en generell Salesforce Approval API. Hvis du vil ha mer informasjon, kan du se https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_process_approvals_approve.htm. |
| 10 | Hente dokumenter for eSign med kontrakt | GET | <URL-adressen til domenet ditt>/services/data/{API version}/connect/e-sign/documents?sourceObjectId=${contractId} | For å vise listen over dokumenter som er knyttet til en kontrakt som du vil sende for e-signatur. Dokumentdetaljene er obligatoriske for e-signatur. Du kan tilpasse dokumentlisten med en tilpasset Apex. Apex må legges til i konfigurasjonen for elektronisk signatur. |
| 11 | Hent mottakere | GET | <URL-adressen til domenet ditt>/services/data/{API version}/connect/e-sign/recipients?recipientSelector=ESignContactList&sourceObjectId={$contractId} | For å vise en liste over dokumentmottakere. Mottakerdetaljene må sendes for e-signatur. Du kan tilpasse mottakerlisten med en tilpasset Apex. Apex må legges til i konfigurasjonen for elektronisk signatur. |
| 12 | Hent varsel-innstillinger | GET | <URL-adressen til domenet ditt>/services/data/{API version}/connect/e-sign/notification-settings?sourceObjectId={$contractId} | For å vise innstillinger for påminnelse og varsel om utløp.Merk: Varseldetaljene er obligatoriske for e-signatur. |
| 13 | Hente signeringsroller | GET | <URL-adressen til domenet ditt>/services/data/{API version}/connect/e-sign/signer-roles | For å vise listen over signatører som signerer og legger til data for å danne felt i dokumentene i konvolutten. Signeringsdetaljene er obligatoriske for e-signatur. |
| 14 | Send for e-sign (utfør handling) | PATCH | <URL-adressen til domenet ditt>/services/data/{API version}/connect/clm/contract/${contractid} | Slik aktiverer du en ny DocuSign-transaksjon med Send envelope API. Handlings-API-et må dekke følgende parametere: Eksempel på Forespørselstekst. Du må konvertere JSON-detaljer til Streng og legge den til i forespørselsteksten ovenfor. actionData er en strengert JSON-fil som inneholder dokumentinnstillinger, oppskriftsinnstillinger, signeringsroller og varselinnstillinger. |
| 15 | Oppdatere konvoluttsstatus | PATCH | <URL-adressen til domenet ditt>/services/data/{API version}/connect/clm/contract/${contractid} | For å sende en ad hoc-forespørsel til DocuSign om å oppdatere konvoluttsstatusen. Når signeringen har signert dokumentet, kan du kalle opp Update Envelope API. |
| 16 | Aktivere kontrakt (utfør handling) |
PATCH | <URL-adressen til domenet ditt>/services/data/{API version}/connect/clm/contract/${contractid} | For å aktivere kontrakten. Bruk APIen til å aktivere kontrakten. |
| 17 | Avslutte kontrakt | PATCH | <dine organisasjonsdetaljer>/services/data/{API version}/connect/clm/contract/${contractid} | For å avslutte kontrakten. |
Andre API-er
| Scenario | Metodetype | API-bane | Beskrivelse |
|---|---|---|---|
| Hente liste over kontraktsdokumentversjoner | GET | <URL-adressen til domenet ditt>/services/data/{API version}/connect/clm/contract/<contractid>/contract-document-version | For å vise listen over kontraktsdokumentversjoner som allerede er tilgjengelig i kontrakten. |
| Hente SpecificContract-dokumentversjon | GET | <URL-adressen til domenet ditt>/services/data/{API version}/connect/clm/contract/{ContractId}/contract-document-version?contractDocumentVersionId={ContractDocumentVersionId} | For å vise en bestemt kontraktsdokumentversjon som allerede er tilgjengelig i kontrakten. |
