Olet tässä:
Esimerkki Salesforce Contracts API -jaksosta
Alla on esimerkki Salesforce Contracts API -kutsujen järjestyksestä, joka kattaa sopimuksen elinkaaren optimaalisen polun. Elinkaari alkaa, kun luot sopimuksen ja sopimus on luonnos-tilassa sopimuksen aktivoimiseksi.
| API-sekvenssi | Skenaario | Metodin tyyppi | API-polku | Kuvaus |
|---|---|---|---|---|
| 1 | Sopimuksen luominen | POST | <oma toimialueesi URL>/services/data/{API version}/connect/clm/contract | Sopimuksen luominen mahdollisuudesta, tarjouksesta, tilauksesta tai muusta vakio-objektista tai mukautetusta objektista. Kun sopimus on luotu, se on luonnos-tilassa. pyynnön tekstiosa: Jos Auto Generate Document On Contract Creation -määritystyypin arvoksi on määritetty true, sovellus luo automaattisesti sopimusasiakirjan version, kun sopimus luodaan. |
| 2 | Asiakirjamallien noutaminen | GET | <oma toimialueesi URL>/services/data/{API version}/connect/clm/document-template?usageType=Contract_LifeCycle_Management&isActive=true&type=MicrosoftWord | Luetteloi kaikki aktiiviset asiakirjamallit. Nämä ehdot täyttävät mallit näytetään oletusarvoisesti luettelossa: Tyyppi = ”Microsoftword”, UsageType = ‘Contract_Lifecycle_Management’, IsActive = true Lisätietoja mukautetusta suodatuksesta on kohdassa Mukautettujen asiakirjamallien suodattamisen käyttäminen Salesforce-sopimuksille. |
| 3 | Sopimusasiakirjan luominen | PATCH | <oma toimialueesi URL>/services/data/{API version}/connect/clm/contract/{ContractId}/contract-document-version | Uuden sopimusasiakirjan version luominen: Sopimuksen tilan täytyy olla luonnostilassa luodakseen uuden sopimusasiakirjan version. pyynnön tekstiosa: |
| 4 | Sisäänkuittaus | PATCH | <oma toimialueesi URL>/services/data/{API version}/connect/clm/contract-document-version/${contract document version ID}/checkin | Jos haluat tarkastaa sopimusasiakirjan uusimman version, joka ei ole aktiivinen tai lukittu.Huomautus: Vain asiakirjan luonut käyttäjä voi suorittaa sisäänkuittauksen. |
| 5 | Lukko | PATCH | <oma toimialueesi URL>/services/data/{API version}/connect/clm/contract-document-version/${contract document version ID}/lock | Sopimusasiakirjan tämänhetkisen version lukitseminen: Voit lukita sopimusasiakirjan version vain, kun sopimus on luonnostilassa ja sopimusasiakirjan versio on aktiivinen tai valittuna. |
| 6 | Avaa lukitus | PATCH | <oma toimialueesi URL>/services/data/{API version}/connect/clm/contract-document-version/${contract document version ID}/unlock | Sopimusasiakirjan tämänhetkisen version lukituksen avaaminen. Vain käyttäjä, joka on lukinnut sopimusasiakirjan version tai järjestelmän pääkäyttäjä, voi avata lukitun sopimusasiakirjan version. |
| 7 | Uloskuittauksen generointi | PATCH | <oma toimialueesi URL>/services/data/{API version}/connect/clm/contract-document-version/{$contract document version id}/Checkout | Luo uusi sopimusasiakirjan versio käyttämällä samaa tai eri mallia käyttämällä valintaruudun luontitoimintoa. pyynnön tekstiosa: Sinun täytyy suorittaa Check In API uloskuittauksen jälkeen. |
| 8 | Lähetä hyväksyttäväksi (suorita toiminto) | PATCH | <oma toimialueesi URL>/services/data/{API version}/connect/clm/contract/${contractid} | Lähetyksen kutsuminen hyväksymistoimintoa varten Execute Action API -rajapinnan avulla. Päätepiste pysyy samana, mutta jokaisella API:lla on eri pyyntöparametrit. Hyväksymisprosessi täytyy määrittää. |
| 9 | Hyväksy | N/A | N/A | Tämä on yleinen Salesforce Approval API. Lisätietoja on kohdassa https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_process_approvals_approve.htm. |
| 10 | Asiakirjojen hankkiminen eSignilla sopimuksella | GET | <toimialueesi URL>/services/data/{API version}/connect/e-sign/documents?sourceObjectId=${contractId} | Voit tarkastella sähköistä allekirjoitusta varten lähetettävään sopimukseen liittyvien asiakirjojen luetteloa. Asiakirjan lisätiedot täytyy lähettää sähköistä allekirjoitusta varten. Voit mukauttaa asiakirjaluetteloa käyttämällä mukautettua Apex. Apex lisätiedot täytyy lisätä sähköisen allekirjoituksen kokoonpanoon. |
| 11 | Nouda vastaanottajia | GET | <toimialueesi URL>/services/data/{API version}/connect/e-sign/recipients?recipientSelector=ESignContactList&sourceObjectId={$contractId} | Asiakirjojen vastaanottajien luettelon tarkasteleminen: Vastaanottajan tiedot täytyy lähettää sähköistä allekirjoitusta varten. Voit mukauttaa vastaanottajaluetteloa käyttämällä mukautettua Apex. Apex lisätiedot täytyy lisätä sähköisen allekirjoituksen kokoonpanoon. |
| 12 | Nouda ilmoitusasetukset | GET | <toimialueesi URL>/services/data/{API version}/connect/e-sign/notification-settings?sourceObjectId={$contractId} | Muistutus- ja vanhentumisilmoitusten asetusten tarkasteleminen.Huomautus: Sähköisen allekirjoituksen lähettäminen ilmoituksen tiedoista on pakollista. |
| 13 | Allekirjoittajan roolien noutaminen | GET | <oma toimialueesi URL>/services/data/{API version}/connect/e-sign/signer-rooles | Tarkastele allekirjoittajien luetteloa, jotka allekirjoittavat ja lisäävät tietoja muotoillakseen kenttiä kirjekuorassa oleviin asiakirjoihin. Allekirjoittajan tiedot on lähetettävä pakollisesti sähköistä allekirjoitusta varten. |
| 14 | Lähetä sähköpostiksi (suorita toiminto) | PATCH | <oma toimialueesi URL>/services/data/{API version}/connect/clm/contract/${contractid} | Uuden DocuSign-transaktion ottaminen käyttöön Send Envelope API -rajapinnan avulla. API-toiminnon täytyy kattaa seuraavat parametrit: Esimerkki pyynnön tekstiosasta. Sinun täytyy muuntaa JSON-tiedot merkkijonoksi ja lisätä se yllä olevaan pyynnön tekstiosaan. actionData on tiivistetty JSON, joka sisältää asiakirjan, reseptin, allekirjoittajan roolin ja ilmoitusasetukset. |
| 15 | Päivitä kirjekuoren tila | PATCH | <oma toimialueesi URL>/services/data/{API version}/connect/clm/contract/${contractid} | Ad hoc -pyynnön lähettäminen DocuSignille kirjekuoren tilan päivittämiseksi. Kun allekirjoittaja on allekirjoittanut asiakirjan, voit kutsua Update Envelope API -rajapintaa. |
| 16 | Sopimuksen aktivoiminen (toiminnon suorittaminen) |
PATCH | <oma toimialueesi URL>/services/data/{API version}/connect/clm/contract/${contractid} | Sopimuksen aktivoiminen. Käytä sopimuksen aktivoimiseen API:a. |
| 17 | Sopimuksen lopettaminen | PATCH | <organisaatiosi lisätiedot>/services/data/{API version}/connect/clm/contract/${contractid} | Sopimuksen lopettaminen. |
Muut API-rajapinnat
| Skenaario | Metodin tyyppi | API-polku | Kuvaus |
|---|---|---|---|
| Sopimusasiakirjojen versioiden luettelon noutaminen | GET | <oma toimialueesi URL>/services/data/{API version}/connect/clm/contract/<contractid>/contract-document-version | Tarkastele sopimusasiakirjan versioiden luetteloa, jotka ovat jo käytettävissä sopimuksessa. |
| SpecificContract-asiakirjan version noutaminen | GET | <toimialueesi URL>/services/data/{API version}/connect/clm/contract/{ContractId}/contract-document-version?contractDocumentVersionId={ContractDocumentVersionId} | Tarkastellaksesi tiettyä sopimusasiakirjan versiota, joka on jo käytettävissä sopimuksessa. |
