Criteria-Based Search Results

Returns the results for search based on the searchable object configuration and search criteria configuration defined by the admin.

Resource

1/connect/criteria-based-search/searchable-object/results

Example

1https://yourInstance.salesforce.com/services/data/v68.0/connect/criteria-based-search/searchable-object/results

Available Version

58.0

Requires Chatter

HTTP Methods

POST

Request Body for POST

JSON Example

1{
2  "searchCriteriaConfigurationName": "Config_Name",
3  "pageNumber": 1,
4  "pageSize": 50,
5  "freeTextFieldName": "Field Name",
6  "globalSearchTerm": "Keyword",
7  "offset": 0,
8  "fetchAllRecordIds": false,
9  "aggregationCriteriaFieldset": [
10    "ProviderType",
11    "FacilityName"
12  ],
13  "sortingCriteriaFieldset": [
14    {
15      "isSortAscending": false,
16      "sortFieldName": "FacilityName"
17    }
18  ],
19  "searchCriteria": [
20    {
21      "searchCriteriaFieldName": "ProviderType",
22      "searchCriteriaFieldOperator": "like",
23      "searchFieldCriteriaValueList": [
24        "Medical Doctor"
25      ],
26      "searchCriteriaFieldType": "text"
27    }
28  ]
29}

Properties

Name	Type	Description	Required or Optional	Available Version
`aggregationCriteriaFieldset`	String[]	Fields that you select in the search criteria configuration as the basis for querying data.	Optional	58.0
`freeTextFieldName`	String	Name of the search criteria field used by the user for the search.	Optional	58.0
`fetchAllRecordIds`	Boolean	When set to `true`, returns up to 2,000 matching record IDs in a single response. When enabled: `searchResultFields` returns an empty array `searchResultRecords` contains only record IDs (one per row.) `pageNumber`, `pageSize`, `offset`, `summary`, and `mapData` are omitted. When set to `false` or omitted, standard pagination applies.	Optional	67.0
`globalSearchTerm`	String	The keyword that you use to perform a comprehensive search across all text-indexed columns of the specified object.	Optional	61.0
`latitude`	Double	User’s latitude that’s used to find search results within a certain distance from the user’s location.	Optional	58.0
`longitude`	Double	User’s longitude that’s used to find search results within a certain distance from the user’s location.	Optional	58.0
`offset`	Integer	Number of records to skip before searching for records. The default value is `0`.	Optional	61.0
`pageNumber`	Integer	Number of the page you want returned. If you don’t specify a value, the first page is returned by default.	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 that you use to sort the search results.	Required	58.0

Response Body for POST

Unified Object Search Data