フィードバック

OData v2.0 エンドポイントを使用しないでください

  • [アーティクル]

カテゴリ: サポート可能性

影響の可能性: 高い

現象

すぐに影響はありませんが、このエンドポイントを使用するコードは非推奨のエンドポイントの廃止によって機能しなくなります。

このエンドポイントは 2022 年 11 月 11 日に廃止される予定です。 OData v2.0 サービスの廃止日のお知らせ

ガイダンス

代わりに Dataverse Web API (OData v4.0) エンドポイントを使用するように、組織データ サービス (OData v2.0) に依存するコードを変更する必要があります。

モデル駆動型アプリの場合、JavaScript Web リソースを使用して、クライアント サイド拡張機能に対応した Dataverse Web API へのアクセスを提供する、Xrm.WebApi (クライアント API 参照) を使用する必要があります。

問題となるパターン

組織データ サービスはこのエンドポイントを使用します: /XRMServices/2011/OrganizationData.svc。 このエンドポイントを使用してアクティブなコードを見つける必要があります。

Dynamics CRM SDK は sample_/Scripts/SDK.REST.js という名前の JavaScript Web リソースとしてサンプル JavaScript ライブラリを提供します。こちら からご利用ください。 Xrm.WebApi (クライアント API 参照) は、レコードの作成、更新、削除、取得を行う同様の機能を提供します。

組織データ サービス エンドポイントは、Invoke-WebRequest を使用する PowerShell スクリプトでも利用する場合があります。

追加情報

組織データ サービスは Dynamics CRM 2011 で導入された OData v2.0 エンドポイントです。 Dynamics 365 Customer Engagement v8.0 で非推奨になりました。 リリース時には OData エンドポイント や REST エンドポイント と呼ばれており、このエンドポイントはテーブルに対して作成、取得、更新、削除の操作を実行する機能のみを提供します。

注意

どちらも OData エンドポイントですが、実装する方法は異なります。 小さな変更だけで既存のコードを機能させることは期待できません。

主な相違点のいくつかを以下で説明します。

リソース名

テーブルの Web API リソース名は EntitySetName に基づきます。 組織データ サービスの名前には、SchemaName に Set が追加されていました。 例 :

Web API 組織のデータ サービス
accounts AccountSet
取引先担当者 ContactSet
関連のタスク TaskSet

列名

Web API の列名はすべて LogicalName を使用した小文字です。 組織データ サービスでは列名に SchemaName を使用します。

HTTP メソッド

組織データ サービスは、PATCH ではなく MERGE や PUT を使用します。

データの書式

組織データ サービスは JSON と ATOM の両方をサポートします。 ATOM は、通常 RSS フィードに使用する XML ベースの形式です。 Web API は JSON のみをサポートします。

返されるレコード数の制限

組織データ サービスは一度に 50 件のレコードのみを返し、最大ページ サイズを指定する方法を提供しません。

Web API では最大ページ サイズを設定でき、最大 5000 件のレコードを返します。 詳細情報: 返されるテーブル行 (エンティティ) 件数の制限.

レガシー ドキュメント

組織データ サービスの解説ドキュメントは、こちらからご利用ください: Microsoft Dynamics 2015 SDK: Web リソースで OData エンドポイントを使用する。

関連項目

Microsoft Dataverse Web API の使用