使用 Microsoft Dataverse Web API

若要处理 Dataverse 中的数据以及表和列定义，可以使用 Web API 或 SDK for .NET。

Dataverse Web API 提供了一种开发体验，可用于各种编程语言、平台和设备。 Web API 实现 OData（开放数据协议）版本 4.0，这是一种 OASIS 标准，用于在丰富的数据源上生成和使用 RESTful API。 您可以了解关于此协议的更多信息，请查看 https://www.odata.org/。 有关此 OASIS 标准的详细信息，请参阅 https://www.oasis-open.org/standards#odatav4.0。

由于 Web API 是基于开放标准构建的，因此除了 Python SDK 之外，Microsoft不提供特定开发人员体验的程序集或库。 可以为特定作编写 HTTP 请求，或使用第三方库为所需的任何语言或平台生成类。 可以在 https://www.odata.org/libraries/ 中找到支持 OData 版本 4.0 的库列表。

模型驱动应用程序和 Power Pages 为对象提供使用 Web API 执行数据作的方法。 See:

Web API 和组织服务

认识到 组织服务 定义平台是有价值的。 Web API 提供 RESTful 编程体验，但最终所有数据操作都经过底层的组织服务。 组织服务将支持的操作定义为消息。 每条消息都有一个名称。 这些名称绑定到事件框架中使用的事件，以评估应启动哪些已注册扩展。 有关详细信息，请参阅 事件框架。

Web API 允许你执行与 .NET SDK 相同的操作，但以 RESTful 风格呈现这些操作。 OData v4 通过 函数 或作提供命名 作。 组织服务中提供的大多数消息都公开为相应的命名函数或动作。 CRUD 操作对应的消息在 Web API 中不可用。 作为 RESTful 服务，这些操作具有使用GET、POST、PATCH和DELETE HTTP 方法的实现。 但在平台中，重试， create、update 和 delete 消息的调用方式与对 .NET 程序集使用 SDK 执行的相应作相同。

入门

可以将 Web API 与允许发送经过身份验证的 HTTP 请求的任何语言一起使用。 我们针对四种常见方案准备了一些入门体验：

HTTP 请求工具

可用于撰写和发送经过身份验证的 HTTP 请求的应用程序是一个基本工具。 许多选项都可用，例如 Postman、 Bruno 或 curl。 请选择并使用您最喜欢的工具。 以下步骤介绍如何使用 失眠 ，因为它具有图形用户界面、相对简单的安装，并提供选择退出创建帐户的选项。 了解如何将 Insomnia 与 Dataverse Web API 配合使用。

小窍门

除非你已经有一个喜欢的 HTTP 请求工具，否则你可能会发现，将 PowerShell 与 Visual Studio Code 配合使用同样易于入门，并且还允许强大的脚本功能。

PowerShell 开发人员

将 Web API 与 PowerShell 配合使用是入门的最简单方法之一。 可以使用 Invoke-RestMethod cmdlet 通过 ConvertTo-Json cmdlet 发送请求并处理响应。

有关将 PowerShell 与 Web API 配合使用，可找到以下内容：

JavaScript 开发人员

JavaScript 开发人员经常将 Dataverse Web API 与模型驱动应用配合使用。 模型驱动应用提供 Xrm.WebApi 对象，该对象公开了与 Web API 交互的方法。 详细了解在模型驱动应用中使用 Web API 的客户端 JavaScript。

单页应用程序（SPA）也使用 JavaScript，并且可以连接到 Dataverse Web API。 快速入门：使用客户端 JavaScript 和 Visual Studio Code 的 Web API 介绍了如何使用 SPA 应用程序模式连接到 Web API。 可以在 Web API 数据作示例（客户端 JavaScript）中找到更多示例。

在 Power Apps 组件框架 （PCF） 组件中，JavaScript 开发人员使用 属于 WebAPI 对象的方法来处理 PCF 组件中的 Dataverse 数据。

最后，Power Pages 公开一个 Portals Web API，该 API 提供使用 Web API 的 Dataverse 操作的子集。

.NET 开发人员

.NET开发人员可以使用 Dataverse SDK for .NET 或 Web API。 如果您不想依赖特定的 NuGet 包，或者您的项目要求不需要 .NET 的 SDK 提供的强类型类，那么您可以考虑使用 Web API。

若要将 Web API 与 C# 配合使用，请参阅以下快速入门文章：

有关更多 C# Web API 示例，请参阅 Web API 数据作示例 （C#）。

使用代码处理数据
OData - REST 的最佳方法
OData 版本 4.0 第 1 部分：协议以及勘误表 02
OData 版本 4.0 第 2 部分：URL 约定以及 Errata 02
OData 版本 4.0 第 3 部分：通用架构定义语言 （CSDL） 加上 Errata 02

  • Last updated on