Unified Object Search Data

Output representation of the unified object search data.

JSON Example

1{
2   "data":{
3      "searchResultFields":[
4         {
5            "fieldLabel":"Provider Name",
6            "fieldName":"ProviderName",
7            "fieldType":"string"
8         },
9         {
10            "fieldLabel":"Provider Type",
11            "fieldName":"ProviderType",
12            "fieldType":"string"
13         },
14         {
15            "fieldLabel":"Specialty",
16            "fieldName":"Specialty",
17            "fieldType":"textarea"
18         }
19      ],
20      "searchResultRecords":[
21         {
22            "fieldValues":[
23               {
24                  "recordTextValue":"Marvin Monroe"
25               },
26               {
27                  "recordTextValue":"Medical Doctor"
28               },
29               {
30                  "recordTextValue":"|Mental Health|"
31               },
32               {
33                  "recordTextValue":"0d0Z60000004CLTIA2"
34               }
35            ]
36         },
37         {
38            "fieldValues":[
39               {
40                  "recordTextValue":"Julius Hibbert"
41               },
42               {
43                  "recordTextValue":"Medical Doctor"
44               },
45               {
46                  "recordTextValue":"|Primary Care|"
47               },
48               {
49                  "recordTextValue":"0d0Z60000004CLbIAM"
50               }
51            ]
52         },
53         {
54            "fieldValues":[
55               {
56                  "recordTextValue":"Nick Riviera"
57               },
58               {
59                  "recordTextValue":"Medical Doctor"
60               },
61               {
62                  "recordTextValue":"|Surgery|"
63               },
64               {
65                  "recordTextValue":"0d0Z60000004CLYIA2"
66               }
67            ]
68         },
69         {
70            "fieldValues":[
71               {
72                  "recordTextValue":"Robert Kelso"
73               },
74               {
75                  "recordTextValue":"Medical Doctor"
76               },
77               {
78                  "recordTextValue":"|Primary Care|"
79               },
80               {
81                  "recordTextValue":"0d0Z60000004CLVIA2"
82               }
83            ]
84         },
85         {
86            "fieldValues":[
87               {
88                  "recordTextValue":"John Dorian"
89               },
90               {
91                  "recordTextValue":"Medical Doctor"
92               },
93               {
94                  "recordTextValue":"|Primary Care|"
95               },
96               {
97                  "recordTextValue":"0d0Z60000004CLWIA2"
98               }
99            ]
100         },
101         {
102            "fieldValues":[
103               {
104                  "recordTextValue":"Percival Cox"
105               },
106               {
107                  "recordTextValue":"Medical Doctor"
108               },
109               {
110                  "recordTextValue":"|Primary Care|"
111               },
112               {
113                  "recordTextValue":"0d0Z60000004CLXIA2"
114               }
115            ]
116         },
117         {
118            "fieldValues":[
119               {
120                  "recordTextValue":"Christopher Turk"
121               },
122               {
123                  "recordTextValue":"Medical Doctor"
124               },
125               {
126                  "recordTextValue":"|Surgery|"
127               },
128               {
129                  "recordTextValue":"0d0Z60000004CLZIA2"
130               }
131            ]
132         },
133         {
134            "fieldValues":[
135               {
136                  "recordTextValue":"Elliot Reid"
137               },
138               {
139                  "recordTextValue":"Medical Doctor"
140               },
141               {
142                  "recordTextValue":"|Primary Care|"
143               },
144               {
145                  "recordTextValue":"0d0Z60000004CLaIAM"
146               }
147            ]
148         }
149      ]
150   },
151   "errors":[
152
153   ],
154   "status":"SUCCESS",
155   "summary":{
156      "aggregateRecordCount":{
157
158      },
159      "aggregateRecordCountByCriteria":{
160         "ProviderType":{
161
162         },
163         "FacilityName":{
164
165         }
166      },
167      "isMoreRecordsPresent":false
168   }
169}

Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`data`	Unified Object Search Result	Details of the criteria-based search and filter results.	Small, 58.0	58.0
`errors`	Timeline Error[]	Details of the errors that were displayed.	Small, 58.0	58.0
`mapData`	Unified Object Search Result Map Data[]	Map details of the records whose location is displayed in search results. Omitted from the response when `fetchAllRecordIds` is `true`.	Small, 61.0	61.0
`offset`	Integer	Number of records that are skipped before returning all records. Omitted from the response when `fetchAllRecordIds` is `true`.	Small, 61.0	61.0
`pageNumber`	Integer	Number of the page. Omitted from the response when `fetchAllRecordIds` is `true`.	Small, 58.0	58.0
`pageSize`	Integer	Number of search result records on each page. Omitted from the response when `fetchAllRecordIds` is `true`.	Small, 58.0	58.0
`resultAggregationFields`	String[]	The fields that are selected in the search criteria configuration and are used to group and aggregate search results.	Small, 58.0	58.0
`status`	String	Indicates whether the request succeeded (`SUCCESS`) or failed (`FAILURE`).	Small, 58.0	58.0
`summary`	Unified Object Search Result Summary	The summary of the count of records for each search result aggregation criteria field. Omitted from the response when `fetchAllRecordIds` is `true`.	Small, 58.0	58.0