Verwenden von FetchXML zum Abrufen von Daten

Sie können FetchXml verwenden, um Daten aus Dataverse abzurufen, indem Sie entweder das SDK für .NET oder die Web-API verwenden. Mithilfe von Power Automate können Sie Daten über die Web-API abrufen, indem Sie den Parameter "Xml-Abfrage abrufen" des Befehls "Listenzeilen" verwenden. Verwenden Sie mithilfe der PAC CLI den Befehl "pac env fetch ".

Möglicherweise möchten Sie auch Communitytools wie FetchXML Studio im Power Platform ToolBox für FetchXML Builder in der XrmToolBox verwenden.

Wie Sie Daten abrufen, hängt davon ab, ob Sie das SDK für .NET oder dataverse Web API verwenden.

SDK für .NET

Verwenden Sie die FetchExpression-Klasse, um die FetchXml-Abfrage als Zeichenfolge zu speichern. FetchExpression ist vom allgemeinen Typ QueryBase-Klasse abgeleitet, sodass Sie ihn verwenden können, wenn dieser Typ ein Methodenparameter oder eine Klasseneigenschaft ist.

Verwenden Sie die IOrganizationService.RetrieveMultiple-Methode für die meisten Fälle.

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

Sie können auch die RetrieveMultipleRequest-Klasse mit der IOrganizationService.Execute-Methode verwenden, aber es gibt einige Szenarien, in denen dieser Ansatz erforderlich ist.

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

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

   return response.EntityCollection;
}

Schnellstart: Eine SDK für .NET-Anforderung ausführen (C#)
Weitere Informationen zur Verwendung von Nachrichten mit dem SDK für .NET

Web-API

Übergeben Sie Ihre FetchXml-Abfrage als URL-codierten Zeichenfolgenwert an die Entitätssatzsammlung mithilfe des fetchXml Abfrageparameters.

Anmerkung

Im Gegensatz zu Abfragen, welche die OData-Syntax verwenden, geben FetchXML-Abfragen, die über die Web-API gesendet werden, keine Eigenschaften mit NULL-Werten zurück. Weitere Informationen zu diesem Verhalten

Wenn Sie beispielsweise Daten aus dem Kontoentitätssatz abrufen möchten, verfassen Sie eine fetchXml-Abfrage, mit der der Entitätselementparametername festgelegt accountwird.

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

Kodieren Sie dann den Wert als URL. Die meisten Programmiersprachen enthalten eine Funktion zur URL-Kodierung einer Zeichenfolge.

• Verwenden Sie in JavaScript die encodeURI-Funktion.
• Verwenden Sie in .NET die System.NET.WebUtility.UrlEncode(String)-Methode.

Tipp

Das XrmToolBox-Tool FetchXML Builder bietet eine Option, um FetchXML zu escapen.

Die URL-kodierte Zeichenfolge für das Beispiel mit der vorherigen Abfrage sieht folgendermaßen aus:

%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

Senden Sie dann Ihre Anfrage an die accounts-Entität, die mit dem Parameter fetchXml in der URL festgelegt ist.

Anforderung:

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

Antwort:

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"
        }
    ]
}

Verwenden Sie FetchXML innerhalb einer Batch-Anforderung

Die Länger einer URL in einer GET-Anforderung wird auf 32 KB (32.768 Zeichen) begrenzt. Das Einschließen von FetchXML als Parameter in der URL kann diesen Grenzwert erreichen. Sie können einen $batch Vorgang ausführen, indem Sie eine POST Anforderung verwenden, um fetchXML aus der URL und in den Textkörper der Anforderung zu verschieben, in dem der Grenzwert nicht gilt. Das Senden einer GET-Anfrage innerhalb eines $batch lässt URLs mit einer Länge von bis zu 64 KB (65.536 Zeichen) zu. Dieser Grenzwert ist höher als bei einer normalen GET Anforderung, ist aber nicht unbegrenzt. Weitere Informationen finden Sie unter Ausführen von Batchvorgängen mithilfe der Web-API.

Schnellstart: Web API Beispiel (C#)
Verwenden der Microsoft Dataverse-Web-API

Null-Spaltenwerte werden nicht zurückgegeben.

Wenn eine Tabellenspalte einen NULL-Wert enthält oder wenn die Spalte nicht angefordert wurde, enthält der zurückgegebene Datensatz nicht den Wert. Es gibt keinen Schlüssel für den Zugriff darauf oder den Wert, der zurückgegeben werden soll. Das Fehlen des Attributs gibt an, dass es Null ist. Dieses Verhalten tritt auf, wenn das SDK für .NET verwendet wird. Erfahren Sie mehr über dieses Verhalten.

Spalten, die für Lesevorgänge nicht gültig sind, geben immer Nullwerte zurück. Diese Spalten haben die Eigenschaft "AttributeMetadata.IsValidForRead" auf "false" festgelegt.

Nächste Schritte,

Lernen Sie, wie man Spalten auswählt.

Spalten auswählen

Probieren Sie beispielcode aus.

FetchXml-Beispielcode