Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Search Input

Input representation for Search API
Root XML tag
<searchInput>
JSON example
1{
2   "searchTerm":"Joe Tester",
3   "verificationContext":{
4      "processDefinition":{
5         "processDetail":{
6            "processDetailList":[
7               {
8                  "verificationProcessFieldList":{
9                     "verificationProcessFields":[
10                          {
11                            "dataSourceType" : "Salesforce",
12                            "developerName" : "SampleAccountName",
13                            "fieldName" : "Name",
14                            "fieldType" : "optionalVerifier",
15                            "label" : "Account Name"
16                          }, {
17                            "dataSourceType" : "Salesforce",
18                            "developerName" : "SampleAccountNumber",
19                            "fieldName" : "AccountNumber",
20                            "fieldType" : "optionalVerifier",
21                            "label" : "Account Number"
22                          }, {
23                            "dataSourceType" : "Salesforce",
24                            "developerName" : "SamplePhone",
25                            "fieldName" : "Phone",
26                            "fieldType" : "optionalVerifier",
27                            "label" : "Phone"
28                          }, {
29                            "dataSourceType" : "Salesforce",
30                            "developerName" : "SamplePostalCode",
31                            "fieldName" : "BillingPostalCode",
32                            "fieldType" : "optionalVerifier",
33                            "label" : "Billing Zip/Postal Code"
34                          }, {
35                            "dataSourceType" : "Salesforce",
36                            "developerName" : "SampleAccount",
37                            "fieldName" : "Name",
38                            "fieldType" : "resultField",
39                            "label" : "Account Name"
40                          }, {
41                            "dataSourceType" : "Salesforce",
42                            "developerName" : "AccountNumberSample",
43                            "fieldName" : "AccountNumber",
44                            "fieldType" : "resultField",
45                            "label" : "Account Number"
46                          }, {
47                            "dataSourceType" : "Salesforce",
48                            "developerName" : "SamplePhoneNumber",
49                            "fieldName" : "Phone",
50                            "fieldType" : "resultField",
51                            "label" : "Phone"
52                          }
53                     ]
54                  },
55                  "searchType": "Text-Based",
56                  "searchSequenceNo": 1,
57                  "searchResultUniqueIdField": "Id",
58                  "searchObjectName": "Account",
59                  "optionalVerifierCount": 1,
60                  "dataSourceType": "Salesforce"
61               }
62            ]
63         }
64      }
65   }
66}
Properties
Name Type Description Required or Optional Available Version
searchTerm String The search term for the account to use when performing a search. Required 54.0
verificationContext Verification Context Input The structure that contains the setup data and context required to perform the search. Required 54.0