Recherche par exécution automatique Dataverse

Cet exemple est tiré de l’exemple du SDK pour les opérations de recherche .NET sur GitHub. La méthode statique OutputAutoComplete accepte une valeur pour le paramètre de recherche.

/// <summary>
/// Demonstrate autocomplete API
/// </summary>
/// <param name="service">The authenticated IOrganizationService instance to use.</param>
/// <param name="searchTerm">The term to use</param>
/// <returns></returns>
static void OutputAutoComplete(IOrganizationService service, string searchTerm)
{
    Console.WriteLine("OutputAutoComplete START\n");

    searchautocompleteRequest request = new()
    {
        search = searchTerm,
        filter = null,
        fuzzy = true,
        entities = JsonConvert.SerializeObject(new List<SearchEntity>()
            {
                new SearchEntity()
                {
                    Name = "account",
                    SelectColumns = new List<string>() { "name", "createdon" },
                    SearchColumns = new List<string>() { "name" },
                }
            }
        )
    };

    var searchautocompleteResponse = (searchautocompleteResponse)service.Execute(request);

    SearchAutoCompleteResults results = JsonConvert.DeserializeObject<SearchAutoCompleteResults>(searchautocompleteResponse.response);

    Console.WriteLine($"\tSearch: {request.search}");
    Console.WriteLine($"\tValue: {results.Value}");

    Console.WriteLine("\nOutputAutoComplete END\n");
}

Sortie

Lorsque vous appelez la méthode OutputAutoComplete avec une instance authentifiée de la classe ServiceClient avec le searchTerm défini sur Cont :

OutputAutoComplete(service: serviceClient, searchTerm: "Con");

Le résultat ressemble à ce qui suit :

OutputAutoComplete START

        Search: Con
        Value: {crmhit}contoso{/crmhit}

OutputAutoComplete END

Classes de soutien

La méthode OutputAutoComplete dépend des classes de soutien suivantes pour envoyer la requête et traiter le résultat :

Classes searchautocompleteRequest et searchautocompleteResponse

Ces classes sont générées à l’aide de la commande de CLI Power Platform pac modelbuilder build comme décrit dans Générer des classes à liaison anticipée pour le SDK pour .NET.

Classe SearchEntity

Cette classe est la même classe SearchEntity utilisée pour l’exemple de requête. Dans ce cas, vous l’utiliser pour définir la propriété searchautocompleteRequest.entities.

Classe SearchAutoCompleteResults

À utiliser pour désérialiser les données JSON de la propriété de chaîne searchautocompleteResponse.response.

class SearchAutoCompleteResults
{
   /// <summary>
   /// The Azure Cognitive error detail returned as part of response.
   /// </summary>
   public ErrorDetail? Error {  get; set; }

   /// <summary>
   /// The text
   /// </summary>
   public string? Value { get; set; }

   /// <summary>
   /// This request is used for backend search, this is included for future feature releases, it is not currently used.
   /// </summary>
   public QueryContext? QueryContext { get; set; }
}

Classe ErrorDetail

Cette classe est la même classe ErrorDetail utilisée pour l’exemple de requête.

Classe QueryContext

Cette classe est la même classe QueryContext utilisée pour l’exemple de requête.

Utilisez l’action searchautocomplete pour recevoir un type complexe searchautocompleteResponse.

Cet exemple est tiré de l’exemple d’opérations de recherche d’API Web sur GitHub.

Le JSON formaté non échappé transmis au paramètre de chaîne entities ressemble à ceci :

[
  {
    "Name": "account",
    "SelectColumns": ["name", "createdon"],
    "SearchColumns": ["name"],
    "Filter": null
  }
]

Requête

POST [Organization Uri]/api/data/v9.2/searchautocomplete
OData-MaxVersion: 4.0
OData-Version: 4.0
If-None-Match: null
Accept: application/json
Content-Type: application/json; charset=utf-8
Content-Length: 191

{
  "entities": "[{\"Name\":\"account\",\"SelectColumns\":[\"name\",\"createdon\"],\"SearchColumns\":[\"name\"],\"Filter\":null}]",
  "search": "Con",
  "fuzzy": true,
  "filter": null
}

Response

HTTP/1.1 200 OK
CRM.ServiceId: framework
OData-Version: 4.0

{
  "@odata.context": "[Organization Uri]/api/data/v9.2/$metadata#Microsoft.Dynamics.CRM.searchautocompleteResponse",
  "response": "{\"Error\":null,\"Value\":\"{crmhit}contoso{/crmhit}\",\"QueryContext\":null}"
}

La valeur JSON formatée non échappée pour la propriété response de chaîne ressemble à ceci :

{
  "Error": null,
  "Value": "{crmhit}contoso{/crmhit}",
  "QueryContext": null
}

Les paramètres de requête et la réponse du point de terminaison search/v2.0/autocomplete sont les mêmes que ceux de l’API Web. Seule l’URL est différente.

URL requête

POST [Organization Uri]/api/search/v2.0/autocomplete