Footer Section
Explore
Adobe Sign ServicesAdvantage Platform AdministrationApprovals for Advantage PlatformApprovals for SalesforceBilling for Advantage PlatformBilling for SalesforceCLM for Advantage PlatformCLM for SalesforceContracts for SalesforceCollaborateComposer for Advantage PlatformComposer for SalesforceContractsConga for Google DocsConga Upgrade ProgramContract Intelligence (Standalone)CPQ for Advantage PlatformCPQ for SalesforceDeal MaximizerDigital Commerce for Advantage PlatformDigital Commerce for SalesforceDiscovery AI for Advantage PlatformDiscovery AI for SalesforceDocusign ServiceseSignature Integration with Advantage PlatformGridInvoice GenerationMix FormsOrchestrateOrder Management for Advantage PlatformOrder Management for SalesforcePartner Commerce for Advantage PlatformPartner Commerce for SalesforceQuote GenerationSign for Advantage PlatformSign for SalesforceSmart SearchTurboEnginesX-Author for Contracts 1.0 (Classic)X-Author for ContractsX-Author for Contracts Advanced for Advantage PlatformX-Author for Contracts Advanced for SalesforceX-Author for ExcelX-Author for Migration ManagerRelease NotesGeneral
Analyze an object's insights score
post
https://IDD_URL/idd/api/{version}
/{tenantId}/insights/analyze
Evaluates the conditions specified in Insights and returns individually annotated results and a description of the condition evaluation.
After evaluating the conditions, creates a mapping for the object in the IDD Insights extraction table.
Conditions are evaluated as follows:
- If =fieldType, the value of the field in the object record is used.metaData
- If =fieldType, the value extracted from the document is used.extractedField
- If =fieldType, the clause extracted from the document is used.extractedClause
- If =field, the value is used to search the document specified by fieldId.keywords
- fieldId is used to resolve the values of the extractedField and extractedClause field types. For , the fieldId specifies the document's ID (for example, the ContentVersion ID for an SFDC object). The desc field is used to annotate the result.field=keywords
- If =operator, the expression specified in the value field is evaluated. For example,NLExpressionresolves to a date 30 days in the future.value="30 days from now"
tenantId
stringTenant name
Example:
congasfdc
recordid
stringIDE Job ID
Example:
507423
checkOrgRegistration
booleanCheck if this org is registered for insight maps
Example:
true
docid
stringID of uploaded document (the content document version)
Example:
0684T000003u3eeQAA
instanceurl
stringInstance URL
Example:
https://max1.my.salesforce.com
objectid
stringID of the object (for example, Agreement ID)
Example:
a0C4T000000ifZZUAY
orgID
stringOrg identifier
Example:
0054T012000dqllXAC
recordtype
stringRecord type
Example:
MSA
userid
stringUser ID
Example:
0054T000000dqllQAA
username
stringUser name
Example:
Gilad Turbahn
Request to create an insight extracted with insight analysis
object
string<string>Object (agreement, quote, etc.)
Example:
Apttus__APTS_Agreement__c
module
string<string>Module (for example, clm or cpq)
Example:
clm
title
string<string>Title of document or agreement
Example:
intellimport
format
string<string>Document format (such as pdf or docx)
Example:
PDF
Responses
200
400
404
OK
responses
/
200
summary
objecttotalprovisons
string<string>Total provisions in the insights
Example:
10
totalRiskScore
string<string>Total risk score for insights of a record type (such as NDA or MSA)
Example:
28
categoryTotals
objectinsights
array[object]insightName
string<string>Insight display name
Example:
Liquidated Damage Cap > $20 mil
insightRatingIcon
string<string>Icon for risk
Example:
https://maxstaticcontentsengg.blob.core.windows.net/max-static-content/database/globalContent/Icons/AgreementDetailsIcon.png
insightRating
string<string>Insights rating
Example:
15
insightRatingLevel
string<string>Rating level
Example:
Very High
summary
string<string>Summary of the criteria plan
Example:
Liquidated Damages Cap > 20 Mil AND contains force of god OR start date < 2021-09-02
type
string<string>Type of insight (risk, warning, etc.)
Example:
Risk
guidance
string<string>Insight guidance
Example:
Needs VP of Finance approval
result
string<string>Results of criteria resolved
Example:
true
relatedProvisions
array[object]alternateClause
array[object]criteriaPlan
object:
:
::::::::::
curl --request POST \--url https://idd_url/idd/api/v2/tenantId/insights/analyze \--header 'Accept: application/json' \--header 'Content-Type: application/json' \--header 'X-API-Key: 123' \--data '{"object": "Apttus__APTS_Agreement__c","module": "clm","title": "intellimport","format": "PDF"}'
1{2"tenant": "clmqatesting",3"instanceUrl": "https://mandav2131.my.salesforce.com",4"recordType": "MSA",5"documentId": "ddfd6158-a38c-4e1d-a802-c38bcca9244f",6"docId": "ddfd6158-a38c-4e1d-a802-c38bcca9244f",7"objectId": null,8"isOrgRegistered": true,9"recordId": null,10"insights": [11{12"recordId": "9b13ab0e18c94",13"name": "TAV",14"insightRating": 8,15"insightRatingLevel": "Moderate Risk",16"insightRatingIcon": "https://maxstaticcontentsengg.blob.core.windows.net/max-static-content/IDD/database/iddContent/icons/triangle.png",17"guidance": "",18"summary": "( Extracted Data.Total Contract Value Equals 15000 OR Agreement.Account Equals Conga)",19"type": "Risk",20"result": false,21"provisions": [22{23"fieldName": "",24"fieldNumber": "",25"provider": "",26"fieldType": ""27}28],29"alternateClause": null,30"criteriaPlan": [31{32"field": "Total Contract Value",33"fieldType": "extractedField",34"fieldId": "cai:4e4a2189-1c70-402b-bc92-d0df018508d5",35"fieldLabel": "Total Contract Value",36"operator": "Equals",37"value": "undefined",38"nlResolution": null,39"templateDataMap": null,40"desc": "Total Contract Value Equals '15000'",41"result": false,42"display": "Total Contract Value Equals 15000",43"resolvedDesc": "Total Contract Value = undefined",44"conditionDesc": "Total Contract Value Equals 15000"45},46{47"field": "Apttus__Account__r.Name",48"fieldType": "metaData",49"fieldLabel": "Account",50"operator": "Equals",51"value": "undefined",52"nlResolution": null,53"templateDataMap": null,54"desc": "Account Equals 'Conga'",55"result": false,56"display": "Account Equals Conga",57"resolvedDesc": "Account = undefined",58"conditionDesc": "Account Equals Conga"59}60]61}62]63}
chevron_right