Web API 多表查找示例 （PowerShell）

此 PowerShell 示例演示如何使用 Dataverse Web API 创建和使用多表查找列（有时称为 多态查找）。

在 GitHub

此示例演示了 使用多表查找列 中所述的操作，并使用 Dataverse Web API PowerShell 帮助函数 管理身份验证，提供可重用的函数以执行常见操作。 该示例通过点引用引用这些脚本。

. $PSScriptRoot\..\Core.ps1
. $PSScriptRoot\..\TableOperations.ps1
. $PSScriptRoot\..\CommonFunctions.ps1
. $PSScriptRoot\..\MetadataOperations.ps1

注释

此示例应适用于 Windows、Linux 和 macOS，但作者仅在Windows上对其进行测试。

先决条件

在运行此示例之前，应阅读以下文章来解释这些示例使用的概念和模式：

这些文章具有相同的先决条件。

安装或验证是否已安装以下内容

验证安装

  1. 打开Visual Studio代码。

  2. 在“终端”菜单中，选择“新终端”。

  3. 在 Visual Studio Code 导航窗格中，选择 PowerShell 扩展的图标。

  4. 在Visual Studio Code终端窗口中复制并粘贴以下脚本：

    Write-Host 'PowerShell Version:'$PSVersionTable.PSVersion.ToString()
Write-Host 'PowerShell Az version:'(Get-InstalledModule Az).Version

  5. 按 Enter。 输出应如下所示：

    PowerShell Version: 7.4.0
PowerShell Az version: 11.1.0

如果未看到如下所示的结果，请安装或更新必备组件。

还需要

  • Dataverse 环境的有效用户帐户
  • 要连接到的 Dataverse 环境的 URL。 请参阅 “查看开发人员资源 ”，了解如何查找它。 它看起来如下所示：https://yourorg.crm.dynamics.com/，其中 yourorg.crm 不同。
  • 基本了解 PowerShell 脚本语言

如何运行此示例

  1. 克隆或下载 PowerApps-Samples 存储库。

  2. 使用 Visual Studio Code 打开 /dataverse/webapi/PS/PolymorphicLookup/PolymorphicLookupSample.ps1 文件。

  3. 编辑以下行以使用要连接到的环境的 URL：

    Connect 'https://yourorg.crm.dynamics.com/' # change this

  4. （可选）如果不想删除此示例创建的记录，请将 $deleteCreatedRecords 变量设置为 $false。

  5. 按 F5 运行示例。

  6. 首次运行示例时，将打开浏览器窗口。 在浏览器窗口中，输入或选择要用于进行身份验证的凭据。

若要以其他用户身份进行连接，请运行 Disconnect-AzAccount 命令 ，然后重试。

Code

此示例的代码位于： PowerApps-Samples/dataverse/webapi/PS/PolymorphicLookup/PolymorphicLookupSample.ps1

演示

此示例包含九个部分：

第 0 部分：创建发布者和解决方案

操作：

  1. 通过向examplepublisher发送GET请求来查询具有/publishers唯一名称的现有发布者。
  2. 如果发布者尚不存在，请向 /publishers 发送 POST 请求以创建发布者。
  3. 向 /solutions 发送 GET 请求，查询名为 polymorphiclookupexamplesolution 的现有解决方案。
  4. 如果解决方案尚不存在，请发送 POST 请求至 /solutions 以创建它。

注释

可以通过在此示例中将所创建的所有解决方案组件与解决方案关联，来导出这些组件。 对于没有命名消息的操作，请将 MSCRM.SolutionUniqueName 请求标头设置为解决方案的唯一名称，以创建此关联。 使用发布者自定义前缀为解决方案组件的所有名称添加前缀。

第 1 节：创建引用的表

操作：

  1. 如果 sample_Book 表尚不存在，请向 /EntityDefinitions 发送 POST 请求以创建该表。 此表包括主 sample_name 属性和 sample_CallNumber 字符串列。
  2. 如果 sample_Audio 表尚不存在，请向 /EntityDefinitions 发送 POST 请求以创建该表。 此表包括主 sample_name 属性和 sample_AudioFormat 字符串列。
  3. 如果 sample_Video 表尚不存在，请向 /EntityDefinitions 发送 POST 请求以创建该表。 此表包括主 sample_name 属性和 sample_VideoFormat 字符串列。

这三个表充当多态查找列可指向的 参考表。

第 2 节：创建引用表

操作：如果sample_Media尚不存在，则通过发送POST请求到sample_Media来创建表。 此表包含主 sample_name 属性并托管多态查找列。

该 sample_Media 表充当 引用表 ，即包含多表查找列的表。

第 3 节：创建多态查找属性

操作：

  1. 使用 CreatePolymorphicLookupAttribute 操作，在 sample_Media 表上创建 sample_MediaPolymorphicLookup 查找列，并建立与三个引用表（sample_Book、sample_Audio 和 sample_Video）的一对多关系。 此操作一次性创建属性以及三个关系。
  2. 通过向 /RelationshipDefinitions 发送 GET 请求，检索三个关系（sample_media_sample_book、sample_media_sample_audio、sample_media_sample_video）各自对应的 ReferencingEntityNavigationPropertyName。 需要使用这些导航属性名称来使用 @odata.bind 语法关联记录。

第 4 节：创建示例数据记录

操作：

  1. 通过向 /EntityDefinitions 发送 GET 请求，检索四个表各自对应的 EntitySetName。
  2. 通过发送sample_Book请求到POST来创建两条sample_books记录。
  3. 通过发送sample_Audio请求到POST来创建两条sample_audios记录。
  4. 通过发送sample_Video请求到POST来创建两条sample_videos记录。
  5. 通过发送sample_Media请求到POST以创建四个sample_medias记录。 每个媒体记录使用第 3 节中检索的导航属性名称和 @odata.bind 语法将多态查找设置为指向三个引用表之一的记录。

第 5 节：检索示例数据

操作：

  1. 通过向 /sample_medias 发送 GET 请求，查询所有 sample_Media 记录，并筛选 sample_name 和 _sample_mediapolymorphiclookup_value 列。 该查询使用 Microsoft.Dynamics.CRM.lookuplogicalname 和 OData.Community.Display.V1.FormattedValue OData 注释显示每个查找值的实体类型和格式名称。
  2. 通过向 /sample_medias 发送 GET 请求并附带适当的 $filter，筛选出多态查找指向特定 sample_Book 记录的 sample_Media 记录。
  3. 通过向 /sample_medias 发送 GET 请求并附带适当的 $filter，筛选出多态查找指向特定 sample_Audio 记录的 sample_Media 记录。

第 6 节：导出托管解决方案

操作：使用ExportSolution操作将您在第 0 节：创建发布者和解决方案中创建的解决方案导出为托管解决方案包。 将导出 .zip 的文件保存在本地，以便在第 8 节中使用。

第 7 节：删除示例表和解决方案

操作：

  1. 通过向sample_Media发送DELETE请求来删除/EntityDefinitions表。 必须在删除被引用表之前先删除引用表。
  2. 删除sample_Book、sample_Audio和sample_Video表，通过向DELETE发送/EntityDefinitions请求。
  3. 通过向 /solutions 发送 GET 请求并按唯一名称进行筛选，查询非托管解决方案。
  4. 通过向 /solutions(<solutionid>) 发送 DELETE 请求来删除非托管解决方案。

第 8 部分：导入和删除托管解决方案

操作：

  1. 使用 ImportSolution 操作 导入在 第 6 节：导出托管解决方案 中导出的托管解决方案。
  2. 通过向 /solutions 发送 GET 请求并按唯一名称过滤，查询导入的解决方案。
  3. 通过向 DELETE 发送 /solutions(<solutionid>) 请求来删除导入的托管解决方案。

清理

默认情况下，此示例将删除它创建的所有记录。 如果要在示例完成后查看创建的记录，请将 $deleteCreatedRecords 变量更改为 $false。 然后，系统会提示你决定是否要删除记录。

另请参阅

使用多表查找列
使用 Dataverse Web API
将 Web API 与表定义配合使用
Web API 示例
Web API 表架构作示例 （PowerShell）

  • Last updated on