Highlights
Highlights help a user to explore the set of data that was retrieved when a search was initiated. It highlights the operators that resulted in a row being queried.
cURL Command
https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/custom-actions/queries?
Example Request Payload
{ "entity":"Account", "limit":2, "fields": ["PartyUniqueName","PrimaryAddress","CreationDate"], "sort": [{ "attribute":"PartyUniqueName","direction":"ascending"}], "keywords":"united", "highlights" : { "pre": ["<emp>"], "post": ["<emp>"], "fields":["PartyUniqueName"] } }
Example Response Payload
{ "items": [ { "PartyId": 300100169110365, "PartyUniqueName": "Pinnacle Technologies (London, GB)", "CreationDate": "2018-12-08T11:54:06.196+0000", "PrimaryAddress": { "CountryCode_localizedValue": "United Kingdom", "PostalCode": "SE1 4HJ", "State": "Battersea", "Address1": "10 Battersea Park", "CountryCode": "GB", "CurrencyCode": "USD", "OverallPrimary": true, "City": "London", "FormattedAddress": "10 Battersea Park,LONDON,Battersea,SE1 4HJ,UNITED KINGDOM", "PartySiteId": 300100169110369, "IdentifyingAddressFlag": true }, "_entity": "Account", "links": [ { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/entities/Account/300100169110365?onlyData=false&language=US", "kind": "item", "name": "canonical" } ] }, ... "count": 8, "hasMore": false, "limit": 10, "offset": 0, "totalResults": 8 }