위치:
샘플 Salesforce Contracts API 시퀀스
다음은 Salesforce Contracts API 호출의 예시 순서이며, 이는 종단간 계약 수명 주기의 최적 경로를 설명합니다. 계약을 만들고 계약이 계약 활성화를 위한 초안 상태가 되면 수명 주기가 시작됩니다.
| API 순서 | 시나리오 | 메서드 유형 | API 경로 | 설명 |
|---|---|---|---|---|
| 1 | 계약 만들기 | POST | <your domain URL>/services/data/{API version}/connect/clm/contract | 기회, 견적서, 주문 또는 기타 표준 또는 사용자 정의 개체에서 계약을 만듭니다. 계약이 생성되면 초안 상태가 됩니다. 요청 본문: 계약 생성 시 자동으로 문서 생성 구성 유형이 true로 설정된 경우 응용 프로그램이 계약 생성 시 계약 문서 버전을 자동으로 생성합니다. |
| 2 | 문서 템플릿 가져오기 | GET | <your domain URL>/services/data/{API version}/connect/clm/document-template?usageType=Contract_LifeCycle_Management&isActive=true&type=MicrosoftWord | 모든 활성 문서 템플릿을 나열합니다. 기본적으로 다음 기준을 충족하는 템플릿이 나열됩니다. 유형 = ‘Microsoftword’, UsageType = 'Contract_Lifecycle_Management' IsActive = true 사용자 정의 필터링에 대한 자세한 내용은 Salesforce Contracts에 사용자 정의 문서 템플릿 필터링 사용을 참조하십시오. |
| 3 | 계약 문서 생성 | PATCH | <your domain URL>/services/data/{API version}/connect/clm/contract/{ContractId}/contract-document-version | 새 계약 문서 버전을 생성합니다. 새 계약 문서 버전을 생성하려면 계약 상태가 초안 상태여야 합니다. 요청 본문: |
| 4 | 체크인 | PATCH | <your domain URL>/services/data/{API version}/connect/clm/contract-document-version/${contract document version ID}/checkin | 비활성 및 잠긴 최신 계약 문서 버전을 체크인합니다.참고: 문서를 생성한 사용자만 체크인을 수행할 수 있습니다. |
| 5 | 잠금 | PATCH | <your domain URL>/services/data/{API version}/connect/clm/contract-document-version/${contract document version ID}/lock | 현재 계약 문서 버전을 잠그려면 계약이 초안 상태이고 계약 문서 버전이 활성 상태이거나 체크인된 경우에만 계약 문서 버전을 잠금 설정할 수 있습니다. |
| 6 | 잠금 해제 | PATCH | <your domain URL>/services/data/{API version}/connect/clm/contract-document-version/${contract document version ID}/unlock | 현재 계약 문서 버전의 잠금을 해제합니다. 계약 문서 버전을 잠긴 사용자 또는 시스템 관리자만 잠긴 계약 문서 버전의 잠금을 해제할 수 있습니다. |
| 7 | 생성 확인 | PATCH | <your domain URL>/services/data/{API version}/connect/clm/contract-document-version/{$contract document version id}/Checkout | 확인을 사용하여 동일하거나 다른 템플릿을 사용하여 새 계약 문서 버전을 생성하려면 생성 작업을 수행합니다. 요청 본문: 체크아웃 후 체크인 API를 실행해야 합니다. |
| 8 | 승인을 위해 제출(작업 실행) | PATCH | <your domain URL>/services/data/{API version}/connect/clm/contract/${contractid} | 작업 실행 API를 사용하여 승인을 위해 제출 작업을 호출합니다. 끝점은 동일하게 유지되지만 각 API에는 요청 매개 변수가 다릅니다. 승인 프로세스를 구성해야 합니다. |
| 9 | 승인 | N/A | N/A | 일반 Salesforce 승인 API입니다. 자세한 내용은 https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_process_approvals_approve.htm을 참조하십시오. |
| 10 | 계약으로 전자 서명용 문서 가져오기 | GET | <your domain URL>/services/data/{API version}/connect/e-sign/documents?sourceObjectId=${contractId} | 전자 서명을 위해 보낼 계약과 연결된 문서의 목록을 봅니다. 문서 세부 사항은 전자 서명을 위해 전송해야 합니다. 사용자 정의 Apex 클래스를 사용하여 문서 목록을 사용자 정의할 수 있습니다. Apex 클래스 세부 사항은 전자 서명 구성에 추가해야 합니다. |
| 11 | 수신자 가져오기 | GET | <your domain URL>/services/data/{API version}/connect/e-sign/recipients?recipientSelector=ESignContactList&sourceObjectId={$contractId} | 문서 수신자 목록을 봅니다. 수신자 세부 사항은 전자 서명을 위해 전송해야 합니다. 사용자 정의 Apex 클래스를 사용하여 수신자 목록을 사용자 정의할 수 있습니다. Apex 클래스 세부 사항은 전자 서명 구성에 추가해야 합니다. |
| 12 | 알림 설정 가져오기 | GET | <your domain URL>/services/data/{API version}/connect/e-sign/notification-settings?sourceObjectId={$contractId} | 미리 알림 및 만료 알림 설정 보기.참고: 알림 세부 사항은 전자 서명을 위해 전송해야 합니다. |
| 13 | 서명자 역할 가져오기 | GET | <your domain URL>/services/data/{API version}/connect/e-sign/signer-roles | 서명하고 데이터를 추가하여 봉투의 문서에 필드를 작성하는 서명자 목록을 봅니다. 서명자 세부 사항은 전자 서명을 위해 전송해야 합니다. |
| 14 | 전자 신호 보내기(작업 실행) | PATCH | <your domain URL>/services/data/{API version}/connect/clm/contract/${contractid} | 봉투 보내기 API를 사용하여 새 DocuSign 트랜잭션을 활성화합니다. 작업 API는 다음 매개 변수를 포함해야 합니다. 샘플 요청 본문 JSON 세부 사항을 문자열로 변환하고 위 요청 본문에 추가해야 합니다. actionData는 문서, receptint, 서명자 롤러, 알림 설정을 포함하는 문자열 지정 JSON입니다. |
| 15 | 봉투 상태 업데이트 | PATCH | <your domain URL>/services/data/{API version}/connect/clm/contract/${contractid} | DocuSign에 임시 요청을 보내 봉투 상태를 업데이트합니다. 서명자가 문서에 서명한 후에는 봉투 업데이트 API를 호출할 수 있습니다. |
| 16 | 계약 활성화(작업 실행) |
PATCH | <your domain URL>/services/data/{API version}/connect/clm/contract/${contractid} | 계약을 활성화합니다. API를 사용하여 계약을 활성화합니다. |
| 17 | 계약 종료 | PATCH | <조직 세부 사항>/services/data/{API version}/connect/clm/contract/${contractid} | 계약을 종료합니다. |
추가 API
| 시나리오 | 메서드 유형 | API 경로 | 상세 설명 |
|---|---|---|---|
| 계약 문서 버전 목록 가져오기 | GET | <your domain URL>/services/data/{API version}/connect/clm/contract/<contractid>/contract-document-version | 계약에서 이미 사용할 수 있는 계약 문서 버전의 목록을 봅니다. |
| SpecificContract 문서 버전 가져오기 | GET | <your domain URL>/services/data/{API version}/connect/clm/contract/{ContractId}/contract-document-version?contractDocumentVersionId={ContractDocumentVersionId} | 계약에서 이미 사용할 수 있는 특정 계약 문서 버전을 봅니다. |
