将 OData 终结点用于 Web 资源

 

发布日期： 2016年11月

适用于： Dynamics CRM 2015

Web 资源的 OData 终结点提供备选接口来处理 Microsoft Dynamics CRM 2015 和 Microsoft Dynamics CRM Online 2015 更新 数据。 您可以通过基于统一资源标识符 (URI) 的服务来使用 OData 端点执行 HTTP 请求。

本主题内容

什么是OData？

0Data 的 Microsoft Dynamics CRM 实施

生成代码的第三方工具

什么是OData？

OData 终结点使用开放数据协议。 该协议实施 “RESTful” 设计模式。 REST 表示代表性状态传输。REST 是一种体系结构样式，在其中可使用唯一的 URI 对每个资源寻址。 在 Microsoft Dynamics 365 中，资源可以是一个实体集合，也可以是一条记录。

REST 工作方式与 Internet 相同。 使用 HTTP 谓词（例如 GET, POST、MERGE 和 DELETE）与资源进行交互。 有多个库可以用于处理 HTTP 请求和响应。REST 提供可用于任何编程语言的标准接口。REST 允许同步或异步处理操作。 执行异步操作的功能使 REST 非常适合于 Microsoft Dynamics CRM 2015 和 Microsoft Dynamics CRM Online 2015 更新 中使用的 Web 资源和脚本。

0Data 的 Microsoft Dynamics CRM 实施

Microsoft Dynamics CRM 2015 和 Microsoft Dynamics CRM Online 2015 更新 使用 Windows Communication Foundation (WCF) 数据服务框架提供基于 REST 数据服务的开放式数据协议 (OData) 端点。 该端点称为 Organization Data Service。 在 Microsoft Dynamics 365 中，服务的根 URI 为：

[Your Organization Root URL]/xrmservices/2011/organizationdata.svc

OData 使用 ATOM 或 JavaScript 对象表示 (JSON) 发送和接收数据。ATOM 是基于 XML 的格式，通常用于 RSS 源。JSON 是一种文本格式，允许对 JavaScript 对象进行序列化。

若要提供与 Microsoft Dynamics 365 中所使用实体对应的一致 URIs 集，实体数据模型 (EDM) 按照“实体类型”记录组织数据和它们之间的关联。

OData 实体数据模型

OData 服务元数据文档中描述了 Microsoft Dynamics 365 EDM，该文档位于以下路径：

[Your Organization Root URL]/xrmservices/2011/organizationdata.svc/$metadata

该 XML 文档使用概念性架构定义语言 (CSDL) 以介绍可用的数据。 下载该文档，并在使用托管代码时将其用于生成类型化类，或在使用 JavaScript 时用作可用对象的引用。

限制

OData 终结点提供 SOAP 终结点的备选端点，但当前存在着一些限制。

• 只能对实体记录执行创建、检索、更新和删除操作。

  • 无法执行需要 Execute 方法的消息。

  • 可以使用导航属性执行关联和取消关联操作。

• OData 协议未完全实现。 某些系统查询选项不可用。
  有关详细信息，请参阅使用 OData 终结点的 OData 系统查询选项。

• 不能通过使用托管代码中使用晚期绑定自定义实体、不存在的属性或关系，则编写代码。
  使用托管代码进行编程时，通常使用 WCF 数据服务客户端数据服务类。 这些类允许早期绑定，以便在设计阶段获得强类型化类。 您只能使用生成类时在系统中定义的那些实体。 这意味着，您无法使用晚期绑定处理生成 WCF 数据服务客户端数据服务类时未包括在这些类中的自定义实体、属性或关系。

生成代码的第三方工具

使用 Microsoft Dynamics 365 的开发人员社区已经创建了一些工具，这些工具演示了 OData 端点是如何工作并生成可用代码的。 下列工具提供了使用 OData 端点，配合使用 Dynamics 365 数据生成代码的能力。

• CRM REST 生成器
  使用该工具构建请求，以便检索数据，并使用各种 JavaScript 库执行操作。

  感谢Microsoft Dynamics 365 MVP Jason Lattimer 构建此工具。

• OData 查询设计器
  OData 查询设计器包含在 Dynamics XRM 工具项目内，允许您使用 OData 端点创建查询，以便检索数据。

  感谢Microsoft Dynamics 365 MVP Rhett Clinton 构建了该工具和其他工具。

另请参阅

使用 Web 资源（OData 和现代应用程序 SOAP 终结点）中的 Web 服务数据
与 Web 资源一同使用现代应用程序的现代应用程序 SOAP 终结点
Microsoft Dynamics CRM 2015 的 Web 资源
使用 Microsoft Dynamics CRM 2015 开发人员资源页面下载终结点
使用 OData 终结点查询 Microsoft Dynamics CRM 2015 数据
使用 OData 终结点执行基本数据操作
与 Ajax 和 JScript Web 资源一起使用 OData 终结点
使用 OData 终结点执行额外的数据操作
示例：将 OData 终结点与 JavaScript 和 jQuery 结合使用来执行创建、检索、更新和删除操作
示例：将 OData 终结点与 JavaScript 一起使用来执行创建、检索、更新和删除操作
示例：OData 终结点 jQuery 联系人编辑器
开放数据协议概述
OData SDK
技术文章：将选项集选项与 REST 端点结合使用 - JScript

© 2017 Microsoft。 保留所有权利。 版权