Public Sector Solutions Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Public Sector Solutions Data Models
Public Sector Solutions Standard Objects
PublicSectrSltn Namespace
Public Sector Solutions APIs
Public Sector Solutions Standard Invocable Actions
Public Sector Solutions Tooling API Objects
Public Sector Solutions Metadata API Types
Public Sector Solutions Associated Objects
StandardValueSet Names and Standard Picklist Fields
Accounting Subledger
Action Launcher
Business Rules Engine
Criteria-Based Search and Filter
Metadata API Types
Tooling API Objects
Business APIs
Resources
Criteria-Based Search Filter Configurations
Criteria-Based Search Results
Request Bodies
Response Bodies
Decision Explainer
Discovery Framework
Engagement
Group Membership and Households
Identity Verification
Intelligent Document Reader
Interest Tagging
Omnistudio Business APIs
Outcome Management Developer Guide
Record Alerts
Record Rollup Definitions
Service Process Studio
Timeline
PDF

Criteria-Based Search Results

Returns the results for search based on the searchable object configuration and search criteria configuration defined by the admin.
Resource
/connect/criteria-based-search/searchable-object/results
Example
https://yourInstance.salesforce.com/services/data/v63.0/connect/criteria-based-search/searchable-object/results
Available version
58.0
Requires Chatter
No
HTTP methods
POST
Request body for POST
JSON example
{
  "searchCriteriaConfigurationName": "Config_Name",
  "pageNumber": 1,
  "pageSize": 50,
  "freeTextFieldName": "Field Name",
  "globalSearchTerm": "Keyword",
  "offset": 0,
  "aggregationCriteriaFieldset": [
    "ProviderType",
    "FacilityName"
  ],
  "sortingCriteriaFieldset": [
    {
      "isSortAscending": false,
      "sortFieldName": "FacilityName"
    }
  ],
  "searchCriteria": [
    {
      "searchCriteriaFieldName": "ProviderType",
      "searchCriteriaFieldOperator": "like",
      "searchFieldCriteriaValueList": [
        "Medical Doctor"
      ],
      "searchCriteriaFieldType": "text"
    }
  ]
}
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
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