{"id":36044,"date":"2023-09-21T15:01:05","date_gmt":"2023-09-21T09:31:05","guid":{"rendered":"https:\/\/www.inogic.com\/blog\/?p=36044"},"modified":"2023-09-21T15:01:05","modified_gmt":"2023-09-21T09:31:05","slug":"use-dataverse-search-suggestions-api-of-microsoft-dynamics-365","status":"publish","type":"post","link":"https:\/\/www.inogic.com\/blog\/2023\/09\/use-dataverse-search-suggestions-api-of-microsoft-dynamics-365\/","title":{"rendered":"Use Dataverse search Suggestions API of Microsoft Dynamics 365"},"content":{"rendered":"

Dataverse Search has been a prominent feature in the Microsoft Dynamics 365 CRM environment, offering access to advanced search capabilities. The earlier “Relevance Search” has been upgraded to “Dataverse Search” with some interesting additional enhancements.<\/p>\n

Previously, we demonstrated how to utilize the Relevance Search API in Power Automate and Canvas Apps<\/a>. Today, let\u2019s explore the enhancements.<\/p>\n

Configuring Dataverse Search<\/strong><\/p>\n

Before you use this feature, an Administrator<\/strong> must enable \u201cDataverse search<\/strong>\u201d in the target environment.<\/p>\n

Note: Enabling “Dataverse Search<\/strong>” is required to make \u201cSuggestions Search<\/strong>\u201d work.<\/p>\n

To enable \u201cDataverse Search\u201d simply follow the steps given below:<\/p>\n

    \n
  1. Navigate to\u00a0Power Platform Admin Center<\/a>, and select the appropriate environment<\/li>\n
  2. Click on the \u201cSettings\u201d in the \u201cProduct\u201d area and click open the \u201cFeatures\u201d section<\/li>\n
  3. Under the \u201cSearch\u201d section, there is an option to turn on the \u201cDataverse Search\u201d<\/li>\n
  4. Click on the Save button to save the changes<\/li>\n<\/ol>\n

    \"Dataverse
    \nSuggestion Search<\/strong><\/p>\n

    Now, let’s understand the usage of Dataverse Search Suggestions<\/strong>.<\/p>\n

    Suggestion is another feature of the Dataverse Search API. With the HTTP POST<\/strong> endpoint [Organization URI]\/api\/search\/v1.0\/suggest<\/em><\/strong>, a list of records where their primary field matches the input term will be returned.<\/p>\n

    Search requests scan through all dataverse search-enabled entity fields.<\/p>\n

    The comprehensive list of input parameters is outlined in Microsoft’s documentation<\/a>. Perhaps the most critical parameter is the “usefuzzy<\/em><\/strong>” option, which holds a Boolean value to determine whether to enable fuzzy search.<\/p>\n

    By default, the result records that are retrieved are 5 and the Top Max count is 100.<\/p>\n

    Here, is a List of Some Similar Records inside our Account Entity-<\/strong><\/p>\n

    \"Dataverse<\/p>\n

    To use the fuzzy search inside our suggested API:<\/p>\n

    POST [Organization URI]\/api\/search\/v1.0\/suggest
    \n{<\/p>\n

    “search”: “aiden”,<\/p>\n

    “usefuzzy”: true ,<\/p>\n

    }<\/p>\n

    \"Dataverse<\/p>\n

    In this scenario, we are issuing the POST API request with a JSON-formatted request body.<\/p>\n

    The Below content is our received response:<\/p>\n

    {\r\n\r\n\"value\":\u00a0[\r\n\r\n{\r\n\r\n\"text\":\u00a0\"{crmhit}Aiden{\/crmhit}\",\r\n\r\n\"document\":\u00a0{\r\n\r\n\"@search.objectid\":\u00a0\"07a22dec-6750-ee11-be6e-000d3af2ec33\",\r\n\r\n\"@search.entityname\":\u00a0\"account\",\r\n\r\n\"@search.objecttypecode\":\u00a01,\r\n\r\n\"name\":\u00a0\"Aiden\",\r\n\r\n\"versionnumber\":\u00a07401941,\r\n\r\n\"statecode\":\u00a0[\r\n\r\n\"Active\"\r\n\r\n],\r\n\r\n\"statuscode\":\u00a0[\r\n\r\n\"Active\"\r\n\r\n],\r\n\r\n\"entityimage_url\":\u00a0null<\/strong>,\r\n\r\n\"createdon\":\u00a0\"9\/11\/2023\u00a011:26\u00a0AM\",\r\n\r\n\"modifiedon\":\u00a0\"9\/11\/2023\u00a011:26\u00a0AM\",\r\n\r\n\"accountnumber\":\u00a0null<\/strong>,\r\n\r\n\"address1_city\":\u00a0null<\/strong>,\r\n\r\n\"emailaddress1\":\u00a0null<\/strong>,\r\n\r\n\"primarycontactid\":\u00a0null<\/strong>,\r\n\r\n\"primarycontactidname\":\u00a0null<\/strong>,\r\n\r\n\"telephone1\":\u00a0null<\/strong>\r\n\r\n}\r\n\r\n},\r\n\r\n{\r\n\r\n\"text\":\u00a0\"{crmhit}Ayden{\/crmhit}\",\r\n\r\n\"document\":\u00a0{\r\n\r\n\"@search.objectid\":\u00a0\"a2bc4df3-6750-ee11-be6e-000d3af2ec33\",\r\n\r\n\"@search.entityname\":\u00a0\"account\",\r\n\r\n\"@search.objecttypecode\":\u00a01,\r\n\r\n\"name\":\u00a0\"Ayden\",\r\n\r\n\"versionnumber\":\u00a07401943,\r\n\r\n\"statecode\":\u00a0[\r\n\r\n\"Active\"\r\n\r\n],\r\n\r\n\"statuscode\":\u00a0[\r\n\r\n\"Active\"\r\n\r\n],\r\n\r\n\"entityimage_url\":\u00a0null<\/strong>,\r\n\r\n\"createdon\":\u00a0\"9\/11\/2023\u00a011:26\u00a0AM\",\r\n\r\n\"modifiedon\":\u00a0\"9\/11\/2023\u00a011:26\u00a0AM\",\r\n\r\n\"accountnumber\":\u00a0null<\/strong>,\r\n\r\n\"address1_city\":\u00a0null<\/strong>,\r\n\r\n\"emailaddress1\":\u00a0null<\/strong>,\r\n\r\n\"primarycontactid\":\u00a0null<\/strong>,\r\n\r\n\"primarycontactidname\":\u00a0null<\/strong>,\r\n\r\n\"telephone1\":\u00a0null<\/strong>\r\n\r\n}\r\n\r\n},\r\n\r\n{\r\n\r\n\"text\":\u00a0\"{crmhit}Aaden{\/crmhit}\u00a0K\",\r\n\r\n\"document\":\u00a0{\r\n\r\n\"@search.objectid\":\u00a0\"7366032a-6850-ee11-be6e-000d3af2ec33\",\r\n\r\n\"@search.entityname\":\u00a0\"account\",\r\n\r\n\"@search.objecttypecode\":\u00a01,\r\n\r\n\"name\":\u00a0\"Aaden\u00a0K\",\r\n\r\n\"versionnumber\":\u00a07401953,\r\n\r\n\"statecode\":\u00a0[\r\n\r\n\"Active\"\r\n\r\n],\r\n\r\n\"statuscode\":\u00a0[\r\n\r\n\"Active\"\r\n\r\n],\r\n\r\n\"entityimage_url\":\u00a0null<\/strong>,\r\n\r\n\"createdon\":\u00a0\"9\/11\/2023\u00a011:28\u00a0AM\",\r\n\r\n\"modifiedon\":\u00a0\"9\/11\/2023\u00a011:28\u00a0AM\",\r\n\r\n\"accountnumber\":\u00a0null<\/strong>,\r\n\r\n\"address1_city\":\u00a0null<\/strong>,\r\n\r\n\"emailaddress1\":\u00a0null<\/strong>,\r\n\r\n\"primarycontactid\":\u00a0null<\/strong>,\r\n\r\n\"primarycontactidname\":\u00a0null<\/strong>,\r\n\r\n\"telephone1\":\u00a0null<\/strong>\r\n\r\n}\r\n\r\n}\r\n\r\n],\r\n\r\n\"querycontext\":\u00a0null<\/strong>\r\n\r\n}<\/pre>\n
    Our response will be in JSON Format, <\/strong>we can Deserialize the JSON as per our requirement, We\u2019ll show you that later in the Code.<\/p>\n
    We got three Responses Names\u2013<\/p>\n
    ” Ayden “,<\/p>\n
    ” Aaden\u00a0K “,<\/p>\n
    ” Aiden “.<\/p>\n
    \"Dataverse<\/p>\n
    In this case, we are getting records from all CRM Database entities, However, if we wish to perform entity-specific searches, that is also achievable.<\/p>\n
    Note<\/strong>: It is necessary to specify the entity within the request body. Moreover, it’s possible to define multiple entities by separating them with commas.<\/p>\n
    {\r\n\r\n\"entities\":\u00a0[\"contact\",\u201d account\u201d],\r\n\r\n\"search\":\u00a0\"aiden\",\r\n\r\n\"usefuzzy\":\u00a0true<\/strong>\r\n\r\n}<\/pre>\n
    One can also include or exclude an entity from the Dataverse search.<\/p>\n
    To Configure Dataverse<\/strong> in a way that allows you to Include or Exclude<\/strong> entities based on your requirements, you should refer to our Blog<\/a> post.<\/p>\n
    Note: <\/strong>
    \nFuzzy matches the search term with the PrimaryAttribute <\/strong>of the entity only and even if not specified in the <\/em>    documentation<\/em><\/a>, it seems that the fuzzy search shows only those records with just 1 letter misspelled. <\/em><\/p>\n
    If you want to apply this API search inside the Console App<\/strong> and WPF (Windows Presentation Foundation)<\/strong>, you can utilize the following code snippet within them to capture the response<\/p>\n
    In the below code, we\u2019re using the search term \u201cAiden<\/strong>\u201d inside the \u201cAccount<\/strong>\u201d Entity,<\/p>\n
    using Microsoft.Xrm.Tooling.Connector;\r\nusing Newtonsoft.Json;\r\n\r\nusing System;\r\n\r\nusing System.Net.Http;\r\n\r\nusing System.Threading.Tasks;\r\n\r\n\u00a0\r\n\r\nnamespace FuzzyAPIinConsole\r\n\r\n{\r\n\r\nclass Program\r\n\r\n{\r\n\r\nstatic void Main(string[] args)\r\n\r\n{\r\n\r\n\/\/Create a connection string inside which you\u2019ve to pass your Credentials in the given format\r\n\r\nstring connectionString = @\"AuthType=OAuth;Url=https:\/\/YOUR_URL.crm8.dynamics.com;Username=YOUR_USERNAME.onmicrosoft.com;Password=YOUR_PASSWORD;AppId=51f81489-12ee-4a9e-aaae-a2591f45987d; RedirectUri=app:\/\/58145B91-0C36-4500-8554-080854F2AC97;LoginPrompt=Auto\";\r\n\r\n\u00a0\r\n\r\n\/\/Creating CrmServiceClient object to build the connection by passing the connectionString as a parameter\r\n\r\nCrmServiceClient crmService = new CrmServiceClient(connectionString);\r\n\r\n\u00a0\r\n\r\nif (crmService != null)\r\n\r\n{\r\n\r\n\/\/Create an object of the current class and call the ExecuteAsync method\r\n\r\nProgram obj = new Program();\r\n\r\nConsole.WriteLine(\"connected\");\r\n\r\nobj.ExecuteAsync(crmService);\r\n\r\nConsole.ReadLine();\r\n\r\n\u00a0\r\n\r\n}\r\n\r\nelse\r\n\r\nConsole.WriteLine(\"connnection error\");\r\n\r\n}\r\n\r\n\u00a0\r\n\r\npublic async Task ExecuteAsync(CrmServiceClient crmService)\r\n\r\n{\r\n\r\n\/\/Access token get from CrmServiceClient\r\n\r\nstring accesstoken = crmService.CurrentAccessToken;\r\n\r\n\u00a0\r\n\r\n\/\/ HttpClient Object\r\n\r\nHttpClient client = new HttpClient();\r\n\r\n\u00a0\r\n\r\n\/\/ Endpoint URL inside HttpRequestMessage to send the request\r\n\r\nHttpRequestMessage request = new HttpRequestMessage(HttpMethod.Post, $\"https:\/\/YOUR_URL.crm8.dynamics.com\/api\/search\/v1.0\/suggest\");\r\n\r\n\u00a0\r\n\r\n\/\/Passing access token in the request so that it can connect to the environment\r\n\r\nrequest.Headers.Add(\"Authorization\", $\"{accesstoken}\");\r\n\r\n\u00a0\r\n\r\n\/\/Specify the request body, as per the body it'll give us the output\r\n\r\nvar searchRequest = new\r\n\r\n{\r\n\r\nentities = \"account\",\r\n\r\nsearch = \"aiden\",\r\n\r\nusefuzzy = true,\r\n\r\n};\r\n\r\n\u00a0\r\n\r\n\/\/ Serializing the Search Response in JSON format\r\n\r\nstring jsonContent = JsonConvert.SerializeObject(searchRequest);\r\n\r\n\u00a0\r\n\r\nHttpContent content = new StringContent(jsonContent, System.Text.Encoding.UTF8, \"application\/json\");\r\n\r\n\u00a0\r\n\r\nrequest.Content = content;\r\n\r\n\u00a0\r\n\r\nvar response = await client.SendAsync(request);\r\n\r\n\u00a0\r\n\r\nresponse.EnsureSuccessStatusCode();\r\n\r\n\u00a0\r\n\r\n\/\/ Converting the response in string format\r\n\r\nstring result = await response.Content.ReadAsStringAsync();\r\n\r\n\u00a0\r\n\r\n\/\/ Deserialize the JSON response into a dynamic object which is captured in the result variable\r\n\r\ndynamic jsonResponse = JsonConvert.DeserializeObject(result);\r\n\r\n\u00a0\r\n\r\n\/\/ You'll get all the Data of the record, Here I'm getting the names of the records by the \"name\" property from each object in the array\r\n\r\nforeach (var item in jsonResponse.value)\r\n\r\n{\r\n\r\nstring name = item.document.name;\r\n\r\nConsole.WriteLine(\"Name: \" + name);\r\n\r\n}\r\n\r\nConsole.ReadLine();\r\n\r\n}\r\n\r\n}\r\n\r\n}<\/pre>\n
    Here is the Result we received in our Console App Based on Fuzzy Logic,<\/strong><\/p>\n
    \"Dataverse<\/p>\n
    Code Summary<\/strong><\/p>\n