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.

Unified Object Search Config Metadata Result

Output representation for the unified object search configuration metadata result.

JSON example

1{
2   "errors":[
3      
4   ],
5   "searchCriteriaConfigurationList":[
6      {
7         "actionList":[
8            {
9               "actionReference":"healthcloud/createReferralActionWrapper",
10               "actionScope":"Global",
11               "actionType":"LightningWebComponent",
12               "displayName":"Create Referral"
13            }
14         ],
15         "aggregateFields":[
16            {
17               "displayType":"Checkbox",
18               "fieldLabel":"Provider Gender",
19               "fieldName":"ProviderGender"
20            },
21            {
22               "displayType":"Picklist",
23               "fieldLabel":"Facility Name",
24               "fieldName":"FacilityName"
25            },
26            {
27               "displayType":"Picklist",
28               "fieldLabel":"Provider Type",
29               "fieldName":"ProviderType"
30            },
31            {
32               "displayType":"Picklist",
33               "fieldLabel":"Specialty",
34               "fieldName":"Specialty"
35            },
36            {
37               "displayType":"Picklist",
38               "fieldLabel":"Subspecialty",
39               "fieldName":"SubSpecialty"
40            },
41            {
42               "displayType":"Text",
43               "fieldLabel":"Languages Spoken",
44               "fieldName":"LanguagesSpoken"
45            }
46         ],
47         "description":"",
48         "filterType":"MultipleFields",
49         "objectName":"CareProviderSearchableField",
50         "resultDisplayFormat":"Card",
51         "resultFlexCard":"HealthCloudPSProviderCardContainer",
52         "searchAndFilterFields":[
53            {
54               "options":[
55                  
56               ],
57               "searchFieldLabel":"Provider Name",
58               "searchFieldName":"ProviderName",
59               "searchFieldSourceObjectFieldName":"ProviderName",
60               "searchFieldSourceObjectName":"CareProviderSearchableField",
61               "searchFieldSourceObjectRecordType":"012000000000000AAA",
62               "searchFieldType":"Text"
63            },
64            {
65               "options":[
66                  
67               ],
68               "searchFieldLabel":"Facility Name",
69               "searchFieldName":"FacilityName",
70               "searchFieldSourceObjectFieldName":"FacilityName",
71               "searchFieldSourceObjectName":"CareProviderSearchableField",
72               "searchFieldSourceObjectRecordType":"012000000000000AAA",
73               "searchFieldType":"Text"
74            },
75            {
76               "options":[
77                  
78               ],
79               "searchFieldLabel":"Provider Gender",
80               "searchFieldName":"ProviderGender",
81               "searchFieldSourceObjectFieldName":"ProviderGender",
82               "searchFieldSourceObjectName":"CareProviderSearchableField",
83               "searchFieldSourceObjectRecordType":"012000000000000AAA",
84               "searchFieldType":"Text"
85            },
86            {
87               "options":[
88                  
89               ],
90               "searchFieldLabel":"Provider Type",
91               "searchFieldName":"ProviderType",
92               "searchFieldSourceObjectFieldName":"ProviderType",
93               "searchFieldSourceObjectName":"HealthcareProvider",
94               "searchFieldSourceObjectRecordType":"012000000000000AAA",
95               "searchFieldType":"Picklist"
96            },
97            {
98               "options":[
99                  
100               ],
101               "searchFieldLabel":"Accepts new patients",
102               "searchFieldName":"IsAcceptingNewPatients",
103               "searchFieldSourceObjectFieldName":"IsAcceptingNewPatients",
104               "searchFieldSourceObjectName":"CareProviderSearchableField",
105               "searchFieldSourceObjectRecordType":"012000000000000AAA",
106               "searchFieldType":"Boolean"
107            },
108            {
109               "options":[
110                  
111               ],
112               "searchFieldLabel":"Specialty",
113               "searchFieldName":"Specialty",
114               "searchFieldSourceObjectFieldName":"Specialty",
115               "searchFieldSourceObjectName":"CareProviderSearchableField",
116               "searchFieldSourceObjectRecordType":"012000000000000AAA",
117               "searchFieldType":"Text"
118            },
119            {
120               "options":[
121                  {
122                     "5":"5 miles"
123                  },
124                  {
125                     "10":"10 miles"
126                  },
127                  {
128                     "50":"50 miles"
129                  }
130               ],
131               "searchFieldLabel":"Maximum Distance Range",
132               "searchFieldName":"",
133               "searchFieldSourceObjectFieldName":"",
134               "searchFieldSourceObjectName":"",
135               "searchFieldSourceObjectRecordType":"",
136               "searchFieldType":"Distance"
137            }
138         ],
139         "searchCriteriaConfigurationIsActive":true,
140         "searchCriteriaConfigurationLabel":"Provider Search",
141         "searchCriteriaConfigurationName":"Provider_Search",
142         "sortFields":[
143            
144         ]
145      }
146   ],
147   "status":"SUCCESS"
148}

Property Name	Type	Description	Filter Group and Version	Available Version
`errors`	Timeline Error	Details of the error message returned if the request failed to retrieve the search configuration metadata.	Small, 58.0	58.0
`searchCriteriaConfigurationList`	Unified Object Search Config Metadata	Search criteria configurations to retrieve the definitions.	Small, 58.0	58.0
`status`	String	Indicates whether the request succeeded (`true`) or failed (`false`).	Small, 58.0	58.0

Public Sector Developer Guide

Unified Object Search Config Metadata Result