Microsoft DataverseWeb API バージョン

[アーティクル]
04/09/2023

Dynamics 365 の (v9.0) リリース以降、 Web API は同じ環境でのバージョン固有の違いをサポートしています。

これは v8.x リリースでの動作とは異なります。以前のリリースでは、新しい機能はその環境に適用された更新プログラムに応じて、サービスの任意のバージョンに利用可能でした。 v8.2 へのアップグレード後は、v8.0 および v8.1 のサービスはすべて同じでした。これが可能だったのは、全ての変更が付加的だったためです。削除されたものも破損変更もありませんでした。その結果、v8.x のサービス URL で参照される特定のバージョンは、実際には重要ではありませんでした。

今後は、特定の操作の削除などの潜在的な破損変更を含む、サービスの機能変更がなされる可能性があります。これにより、継続的に改善が適用されるようになります。このトピックでは、Web API が.NET 用 SDK とのパリティをまだ達成していないバージョン固有の違いや制限事項をすべて記録します。

注意

v9.x リリースは特定の違いをサポートできますが、v9.0、v9.1、または v9.2 リリースに追加された重大な変更はありません。これらの各リリースには、同一の Web API 動作があります。

API の動作の違いは、製品のバージョンではなく、システムにインストールされているソリューションによって大きく左右されます。ただし、下位互換性のない根本的な変更を行う必要がある場合は、新しいバージョン番号に含まれます。

ガイダンス: コードが記述されたときの最新バージョン番号を使用してください。ここで文書化された違いを探してテストしない状態で、新しいバージョンを自動的に使用しないでください。新しいバージョンに完全な下位互換性があると想定しないでください。

Web API のバージョン固有の相違点

以下の違いは、Web API の v8.2 バージョンと v9.0 バージョンの変更点を示しています。

FetchXML クエリに応答する特殊文字のエンコード

v8.x バージョンの場合、リンクエンティティとその属性を含む FetchXMLクエリへの応答には、「. 」が「x002e」に、「@」が「x0040」になるような Unicode特殊文字が含まれます。この特殊文字のエンコーディングは、v9.xでリリースされた FetchXML クエリの応答には存在していません。

テーブルと列に同じ名前

テーブル (エンティティ) の名前とその列 (属性) のいずれかが同じ場合、v8.x インスタンスの属性名に "1" が付加されます。たとえば、エンティティ new_zipcode に new_zipcode という名前の属性がある場合、属性名は new_zipcode1に変更されます。

v9.x インスタンスの場合は、属性名には何も追加されません。

追加された新しい操作

v9.x リリースの Web API に次の操作が追加されています。

Operations	操作 (続き)	操作 (続き)
GrantAccessRequest	ModifyAccessRequest	RetrieveSharedPrincipalsAndAccessRequest

Web API の制限

Dataverse Web API には、.NET 用 SDK の機能を持つ完全なパリティが用意されています。 Dataverse の場合は、このトピックでは Dataverse v8.x のリリースから繰り越された制限事項について説明します。それ以前のリリースについては、Dynamics CRM 2016 Web API の制限を参照してください。

注意

複雑な戻り値と簡易な戻り値を含むユーザー定義のアクションを定義した場合、対応するアクションは Web API では利用できませんでしたが、組織サービスを使用して利用できました。複雑な戻り値は、EntityReference、Entity、または EntityCollection です。簡易な戻り値、または 1 つの複雑な戻り値の組み合わせを含めることができます。詳細: 独自のアクションの作成。