Start an asynchronous risk analysis for a contract document version, or get the status and results of the most recent risk analysis run.
1/connect/contracts-ai/contract-document-version/$CONTRACT_DOCUMENT_VERSION_ID/risk-analysis68.0
GET, POST
| Parameter Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
contractDocumentVersionId | String | ID of the contract document version to analyze. | Required | 68.0 |
contractRiskAnalysisRunId | String | ID of the contract risk analysis run. Available for GET only. If omitted, the response returns the most recent risk analysis run for the contract document version. | Optional | 68.0 |
1https://YOUR_INSTANCE.salesforce.com/services/data/v68.0/connect/contracts-ai/contract-document-version/0qtRM0000004CGv/risk-analysisJSON Example
1{
2 "documentPlaybookVersionId" : "00OEE000003530L2AQ"
3}Properties
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
documentPlaybookVersionId | String | ID of the playbook version to use for risk analysis standards and comparison. | Optional | 68.0 |
1https://YOUR_INSTANCE.salesforce.com/services/data/v68.0/connect/contracts-ai/contract-document-version/0qtRM0000004CGv/risk-analysis
j