Newer Version Available
Unified Object Search Data
- JSON example
-
1{ 2 "searchCriteriaConfigName": "VehicleSearchConfigDefault", 3 "pageNumber": 1, 4 "pageSize": 20, 5 "groupByFields": ["dealer"], 6 "sortByFields": [ 7 { 8 "isAsc": true, 9 "fieldName": "field1" 10 }, 11 { 12 "isAsc" : false, 13 "fieldName": "field2" 14 } 15 ], 16 "fieldCriteria": [ 17 { 18 "fieldName" : "model", 19 "comparisonOperator": "equals", 20 "values": [ 21 "creta", 22 "i10" 23 ], 24 "category" : "text" 25 }, 26 { 27 "fieldName" : "dealerLocation", 28 "comparisonOperator": "range", 29 "values": [ 30 0, 31 10 32 ], 33 "category" : "distance" 34 } 35 ] 36} - Properties
-
Name Type Description Required or Optional Available Version aggregationCriteriaFieldset String[] Fields selected in the search criteria configuration as the basis for querying data. Optional 58.0 freeTextFieldName String Name of a search criteria field that the user bases the search on. Optional 58.0 latitude Double User’s latitude. Optional 58.0 longitude Double User’s longitude. Optional 58.0 pageNumber Integer Number of the page you want returned. If you don’t specify a value, the first page is returned. The maximum number of results per page is 20. Optional 58.0 pageSize Integer Number of search result records on each page. Optional 58.0 searchCriteria Unified Object Search Criteria[] Name of the search criteria configuration. Optional 58.0 searchCriteriaConfigurationName String Name of the search definition. Optional 58.0 sortingCriteriaFieldset Unified Object Search Sort By Field[] Details of the fields used to sort the search results. Required 58.0