Utiliser FetchXML pour récupérer des données

Vous pouvez utiliser FetchXml pour récupérer des données à partir de Dataverse à l’aide du Kit de développement logiciel (SDK) pour .NET ou de l’API web. À l’aide de Power Automate, vous pouvez récupérer des données via l’API web à l’aide du paramètre Fetch Xml Query de la commande List Rows. À l’aide de l’interface CLI PAC, utilisez la commande pac env fetch .

Vous pouvez également utiliser des outils de communauté, tels que FetchXML Studio dans Power Platform ToolBox pour FetchXML Builder dans XrmToolBox.

La façon dont vous récupérez des données varie selon que vous utilisez le Kit de développement logiciel (SDK) pour .NET ou l’API Web Dataverse.

SDK pour .NET

Utilisez la classe FetchExpression pour maintenir la requête FetchXml sous forme de chaîne. FetchExpression est dérivé du type commun de la classe QueryBase, vous pouvez donc l’utiliser lorsque ce type est un paramètre de méthode ou une propriété de classe.

Utilisez la méthode IOrganizationService.RetrieveMultiple pour la plupart des cas.

static EntityCollection RetrieveMultipleExample(IOrganizationService service, string fetchXml)
{
   return service.RetrieveMultiple(new FetchExpression(fetchXml));
}

Vous pouvez également utiliser la classe RetrieveMultipleRequest avec la méthode IOrganizationService.Execute, mais il existe quelques scénarios où cette approche est nécessaire.

static EntityCollection RetrieveMultipleRequestExample(IOrganizationService service, string fetchXml)
{
   var request = new RetrieveMultipleRequest()
   {
         Query = new FetchExpression(fetchXml)
   };

   var response = (RetrieveMultipleResponse)service.Execute(request);

   return response.EntityCollection;
}

Démarrage rapide : exécuter une requête SDK pour .NET (C#)
En savoir plus sur l’utilisation de messages avec le SDK pour .NET

API web

Transmettez votre requête FetchXml en tant que valeur de chaîne encodée d’URL à la collection d’ensembles d’entités à l’aide du fetchXml paramètre de requête.

Note

Contrairement aux requêtes qui utilisent la syntaxe OData, les requêtes FetchXML envoyées à l’aide de l’API web ne renvoient pas de propriétés avec des valeurs nulles. En savoir plus sur ce comportement

Par exemple, si vous souhaitez récupérer des données à partir de l’ensemble d'entités « compte », composez une requête FetchXML qui définit le paramètre « élément d’entité » sur account.

<fetch top='5'>
  <entity name='account'>
    <attribute name='name' />
  </entity>
</fetch>

Ensuite, codez en URL la valeur. La plupart des langages de programmation proposent une fonction pour encoder une chaîne au format URL.

• En JavaScript, utilisez la fonction encodeURI.
• Dans .NET, utilisez la méthode System.NET.WebUtility.UrlEncode(String).

Astuce

Le générateur FetchXML de l’outil XrmToolBox fournit une option pour échapper le fetchxml.

La chaîne codée en URL pour l’exemple de requête précédent ressemble à ceci :

%3Cfetch%20top%3D%275%27%3E%0D%0A%3Centity%20name%3D%27account%27%3E%0D%0A%3Cattribute%20name%3D%27name%27%2F%3E%0D%0A%3C%2Fentity%3E%0D%0A%3C%2Ffetch%3E

Ensuite, envoyez ensuite votre requête à l’ensemble d’entités accounts avec le paramètre fetchXml dans l’URL.

Requête :

GET [Organization URI]/api/data/v9.2/accounts?fetchXml=%3Cfetch%20top%3D%275%27%3E%0D%0A%3Centity%20name%3D%27account%27%3E%0D%0A%3Cattribute%20name%3D%27name%27%2F%3E%0D%0A%3C%2Fentity%3E%0D%0A%3C%2Ffetch%3E
Accept: application/json
OData-MaxVersion: 4.0
OData-Version: 4.0

Réponse :

HTTP/1.1 200 OK
Content-Type: application/json; odata.metadata=minimal
OData-Version: 4.0

{
    "@odata.context": "[Organization URI]/api/data/v9.2/$metadata#accounts(name,accountid)",
    "value": [
        {
            "@odata.etag": "W/\"81359849\"",
            "name": "Litware, Inc. (sample)",
            "accountid": "78914942-34cb-ed11-b596-0022481d68cd"
        },
        {
            "@odata.etag": "W/\"80649580\"",
            "name": "Adventure Works (sample)",
            "accountid": "7a914942-34cb-ed11-b596-0022481d68cd"
        },
        {
            "@odata.etag": "W/\"84077591\"",
            "name": "Fabrikam, Inc. (sample)",
            "accountid": "7c914942-34cb-ed11-b596-0022481d68cd"
        },
        {
            "@odata.etag": "W/\"84174320\"",
            "name": "Blue Yonder Airlines (sample)",
            "accountid": "7e914942-34cb-ed11-b596-0022481d68cd"
        },
        {
            "@odata.etag": "W/\"80649588\"",
            "name": "City Power & Light (sample)",
            "accountid": "80914942-34cb-ed11-b596-0022481d68cd"
        }
    ]
}

Utiliser FetchXML dans une demande de traitement par lots

La longueur d’une URL dans une requête GET est limitée à 32 ko (32 768 caractères). L’inclusion de FetchXML en tant que paramètre dans l’URL peut atteindre cette limite. Vous pouvez exécuter une $batch opération à l’aide d’une POST requête pour sortir le FetchXML de l’URL et le placer dans le corps de la requête, où cette limite ne s’applique pas. L’envoi d’une requête GET dans $batch autorise les URL d’une longueur maximale de 64 Ko (65 536 caractères). Cette limite est supérieure à celle d’une requête normale GET , mais elle n’est pas illimitée. Pour plus d’informations, consultez Exécuter des opérations par lots à l’aide de l’API web.

Démarrage rapide : exemple de l’API web (C#)
Utiliser l'API Web Microsoft Dataverse

Les valeurs de colonne Null ne sont pas retournées

Lorsqu’une colonne de table contient une valeur Null ou si la colonne n’a pas été demandée, l’enregistrement retourné n’inclut pas la valeur. Il n’existe ni clé pour y accéder ni valeur à retourner. L’absence de l’attribut indique qu’elle est nulle. Ce comportement se produit lors de l’utilisation du Kit de développement logiciel (SDK) pour .NET. En savoir plus sur ce comportement.

Les colonnes qui ne sont pas valides pour la lecture retournent toujours des valeurs null. Ces colonnes ont la propriété AttributeMetadata.IsValidForRead définie sur false.

Étapes suivantes

Découvrez comment sélectionner les colonnes.

Sélectionner des colonnes

Essayez un exemple de code.

Exemple de code FetchXml