FetchXML を使用してデータのクエリを実行する

  • [アーティクル]

FetchXml は、Dataverse からデータを取得するために使用される独自の XML ベースのクエリー言語です。 データの取得に使われる要素については、FetchXml の参照 を参照してください。

注意

FetchXml は、モデル駆動型アプリのビューや一部のレポート機能を定義するためにも使用されます。 これらのユースケースの要素と属性はここには含まれていません。 コードによるモデル駆動型アプリのビューのカスタマイズの詳細情報。

クエリを作成する

すべてのクエリは単一のテーブルに基づいています。 ルート要素は fetch です。 エンティティ要素 を使用して、クエリがデータを取得するテーブルを選択します。 次の例は、単純な FetchXml クエリを表しています。

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

このクエリは、テーブルの LogicalName を使用して エンティティ name 属性を設定し、Account テーブルから最初の 5 行の Name 列 を返します。

行数の制限

返される行数を制限するには、 取り込み要素 top 属性を使用します。 top 属性を指定しない場合、Dataverse は最大 5,000 行を返します。

または、ページングを使用して、返すレコードの数を指定します。 データのページをリクエストするときには、top 属性を使わないでください。 ページングされた結果をリクエストする方法を解説します

top 属性を使用して行数をリクエストする場合は、returntotalrecordcount を使用できません。 行の計測方法について説明します。

明確な結果を返します

取り込み要素 distinct 属性を使用して、クエリで結果内の重複値を除外するように要求します。

distinct 属性を使用する場合、ページングの一貫性を保つために、 順序要素 を少なくとも 1 つ追加する必要があります。

distinct 属性を使用すると、各レコードの主キー値はすべての個別の値の集計を表すため、返される結果には含まれません。

データの取得

クエリから結果を取得するには、リクエストを Dataverse に送信する必要があります。 FetchXml を使用して Dataverse からデータを取得する方法について解説します

クエリを絞り込む

クエリを開始するテーブルを選択した後、クエリを調整して必要なデータを取得します。 次の記事では、クエリを完了する方法について説明します。

記事 Task
列を選択する 返すデータの列を指定します。
テーブルの結合 結果としてどの関連テーブルを返すかを指定します。
行を並べ替える 返す行の並べ替え順を指定します。
行のフィルター 返すデータの行を指定します。
ページの結果 各リクエストで返すデータの行数を指定します。
データの集計 返されたデータのグループ化と集計を行う方法。
行数をカウントする 返された行数を取得する方法。
パフォーマンスの最適化 パフォーマンスを最適化する方法

コミュニティ ツール

XrmToolBox FetchXmlBuilderは、FetchXML のリクエストを作成およびテストする際に役立つツールです。

注意

コミュニティによって作成されたツールは、Microsoft によってサポートされていません。 コミュニティ ツールに関する質問や問題は、ツールの公開元にお問い合わせください。

FetchXml をメッセージ パラメーターとして使用する

また、次のメッセージなどの Dataverse 操作のパラメータとして FetchXml を使用します。

メッセージ名 SDK for .NET リクエスト クラス Web API 操作
BackgroundSendEmail BackgroundSendEmailRequest BackgroundSendEmail アクション
BulkDetectDuplicates BulkDetectDuplicatesRequest BulkDetectDuplicates アクション
FullTextSearchKnowledgeArticle FullTextSearchKnowledgeArticleRequest FullTextSearchKnowledgeArticle アクション
QueryExpressionToFetchXml QueryExpressionToFetchXmlRequest QueryExpressionToFetchXml アクション
SendBulkMail SendBulkMailRequest SendBulkMail アクション
Rollup RollupRequest ロールアップ機能

次の手順

列を選択する方法について説明します。

列を選択する

FetchXml でデータを取得する方法について説明します。

FetchXml を使用してデータを取得する

注意

ドキュメントの言語設定についてお聞かせください。 簡単な調査を行います。 (この調査は英語です)

この調査には約 7 分かかります。 個人データは収集されません (プライバシー ステートメント)。