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
Validate the insights criteria
post
https://IDD_URL/idd/api/{version}
/{tenantId}/insights/validate
Validates each term in the conditions list, ensuring it is correct and ready to be processed.
Conditions are validated as follows:
- There is no scope block in the validate call.
- =fieldType,metaData,keywords,mergedField, orextractedFieldextractedClause
- fieldId is required for all fields except metaData fields
- If =operator, the expression specified in theNLExpressionfield is evaluated to ensure it is valid.value
- If value is a relative expression that contains other fields, these must be valid fields of the primary object. For example, in , Apttus__Contract_Start_Date__c must be a valid field in the specified primary objectvalue = "2 years from ${Apttus__Contract_Start_Date__c}"
tenantId
stringTenant name
Examples:
congasfdc
instanceurl
stringInstance URL of the org
Examples:
https://max1.my.salesforce.com
module
stringModule for display config, such as "clm", "cpq", or "qtc".
Examples:
clm
userid
stringUser ID of the logged-in user
Examples:
0054T000000dqllQAA
username
stringFull name of the logged-in user
Examples:
Gilad Turbahn
iSearch rule query block
primaryObject
stringPrimary object being queried
scope
arrayList of conditions specifying the candidate objects on which the query plan shall be executed
dictionary[string, string]
clause
array[array]dictionary[string, object]
options
objectExample:
{"fetchResults":true,"sessionTreatment":"clear","countRows":true,"enableSynonymSearch":true}
fetchResults
booleanIf true, resolve query and return object IDs matching the query.
Default:
false
fetchQueryPlan
booleanIf true, return query plan used to resolve the NL phrase.
Default:
false
mask
booleanIf true, redact input phrase details in analytics logging.
Default:
false
sessionTreatment
string<string>- "clear" Clears the session
- "keep-alive" Does not alter the session
- "terminate" (or any other value) Terminates the session
Default:
terminate
applyDefaultAlias
booleanIf true, applies a default implicit alias to applicable objects. For example, when querying for opportunities, only opportunities with the stage field set to open are returned.
Default:
true
personalize
booleanIf true, only records owned or created by the searching user are searched.
Default:
true
keywordCacheTimeout
integerTime, in minutes, that document lookups will be cached (0 to 60). If <= 0, cache is disabled.
Default:
30
searchLimit
integerMaximum number of records to pull up during document search
Default:
300
pageSize
integerMaximum number of records to return in a single response
Default:
30
countRows
booleanEnables counting records matching the query, regardless of limit
Default:
false
enableDocVersionSearch
booleanEnables a search of the doc version
Default:
true
enableContentDocumentSearch
booleanEnables a search of document contents
Default:
true
enableAgreementDocSearch
booleanEnables an agreement doc search
Default:
true
singleDocPerRow
booleanIf set, one array row is returned for each document
Default:
false
includeFiles
array[string]List of file names to be included in the document search. If specified, overrides the excludeFiles setting.
Example:
["*Final.pdf","*.docx","Intelligent.*"]
excludeFiles
array[string]List of file names to be excluded from the document search. If includeFiles is also specified, excludeFiles is ignored.
Example:
["*Tentative.pdf","*.rtf","Intelligent*.png"]
timeout
integerTime, in milliseconds, allowed for the execution of a search query. The maximum permissible timeout is 90 seconds.
Default:
15000
context
objectAny JSON object to be logged in an analytics payload.
Responses
200
OK
:
:
:
::::::
curl --request POST \--url 'https://idd_url/idd/api/v2/congasfdc/insights/validate?userid=0054T000000dqllQAA&username=Gilad+Turbahn&instanceurl=https%3A%2F%2Fmax1.my.salesforce.com&module=clm' \--header 'Authorization: Bearer 123' \--header 'Content-Type: application/json' \--header 'X-API-Key: 123' \--data '{"name": "MSA-Risk","primaryObject": "Apttus__APTS_Agreement__c","scope": ["a0C4T000000ifZZUAY"],"clause": {"Apttus__APTS_Agreement__c": {"terms": {"expression": "(1 AND ((2 AND 3) OR 4 OR 5) AND 6 AND (7 OR 8))","conditions": [{"field": "Apttus__Contract_Start_Date__c","fieldType": "mergedField","fieldId": "1039","operator": "NLExpression","value": "less than 30 days from now"},{"field": "Apttus__Contract_End_Date__c","fieldType": "mergedField","fieldId": "1040","operator": "NLExpression","value": "after ${Apttus__Contract_Start_Date__c}"},{"field": "Apttus__Contract_End_Date__c","fieldType": "mergedField","fieldId": "1040","operator": "NLExpression","value": "more than 2 years from ${Apttus__Contract_Start_Date__c}","guidance": "End date is more than 2 years from start date"},{"field": "Apttus__Total_Contract_Value__c","fieldType": "extractedField","fieldId": 681,"operator": ">","value": "1000"},{"field": "Apttus__Remaining_Contracted_Days__c","fieldType": "metaData","operator": "=","value": "0"},{"field": "keywords","fieldType": "ContentVersion","fieldId": "0684T000003u3eeQAA","title": "intellimport","format": "pdf","operator": "NLExpression","value": "Force Majeure and Term"},{"field": "Force Majeure","fieldType": "extractedClause","fieldId": "267","operator": "not contains","value": "Pandemic, earthquake"},{"field": "Limitation of Liability","fieldType": "extractedField","operator": ">","value": "2000000","desc": "High liability"}]}}},"options": {"objectOverride": true,"defaultFieldType": "mergedField","fetchResults": true,"sessionTreatment": "clear","singleDocPerRow": false},"objectData": {"a0C4T000000ifZUUAY": {"Account.Name": "Acme Inc","Limitation of Liability": "1000000"}},"metaData": {"name": "Core risk criteria","score": "0.1"}}'
chevron_right