运行报告和列出用户命令更改

Workiva Connector 命令使用 Workiva 平台 API。当前版本为 2022-01-01，但该版本将被停用。为了保持您的链条正常运行，我们将所有 Workiva 连接器命令升级到 2026-01-01 版本。

大多数 Workiva Connector 命令将于 2026 年 11 月 30 日自动迁移至 2026-01-01，您无需执行任何操作。有关完整列表，请参阅 Workiva Connector：命令迁移到平台 API 2026-01-01 。运行报告 和 列出用户命令有一些更改需要您进行操作，因此您必须选择何时切换它们。您需要在 2027 年 10 月 31 日之前完成这些更改。届时，这些命令将更改为新的 API，并且在正确配置之前将无法工作。

API 版本选择

现在这两个命令都有一个 API 版本字段，允许您指定 2022 或 2026。默认值为 2022，因此没有值的命令将使用 2022。

其他变化

注意： 输出名称保持不变，因此您的链的其余部分将继续工作。

运行报告 现在会在下载报告之前将其导出。如果导出时间超过 5 分钟左右，则导出过程可能会耗时更长并失败。运行时间不应超过10分钟。
列出用户 需要将 organization:read 范围包含在您的 OAuth2 授权中。

有关 API 更改（包括电子表格命令更改）的更多信息，请参阅 Workiva 支持页面 Workiva 连接器：命令迁移到平台 API 2026-01-01。

执行报告

不变的是……

输入： 报告 ID，预览内容。
输出： 报告 CSV 文件。
只有当文件准备就绪后，命令才会完成。

2026年1月1日有哪些变化

该命令启动报告导出，大约每秒检查一次报告状态，然后下载 CSV 文件。
链式日志将显示“正在检查操作状态...”，状态为已确认、已排队或 已启动，如果命令正确完成，则显示“操作已成功完成”。如果命令未能正确完成，则会在日志中记录“操作失败”的消息。
该命令的运行时间可能比 2022-01-01 版本要长，因为连接器最多会检查导出 300 次或最多 10 分钟，以先到者为准。每秒检查一次，大约需要 5 分钟。如果导出操作届时尚未完成，则命令失败。
提示： 如果链式命令超时时间短于导出时间，请延长超时时间，以便文件能够到达。
错误的报告 ID 通常会导致“操作失败”。
无需新的许可。OAuth2 授权仍然需要 graph:read。

将命令切换至 2026

打开链表并选择运行报告 命令。
将 API 版本设置为 2026。
保存并运行该链。
检查报告的输出是否包含您期望的数据。

疑难排解

信息	该怎么办
`尝试次数限制 300 次已超过` 或 `时间限制 10 分钟已超过`	报告导出未能及时完成。减少报告大小或筛选条件，或者将命令设置回“2022”并联系支持人员。
`操作失败` 或 `操作已取消`	请核对报告编号。如果信息正确，请使用日志中显示的 ID 联系支持团队。
`错误：无法运行用户报告。`	检查报告 ID 和授权是否具有 `graph:read。`接下来的消息包含 API 详细信息。

列出用户

不变的是……

输入： 组织 ID。
输出： 用户报告 JSON 文件和记录计数。
OAuth2授权用户必须是组织管理员。

2026年1月1日有哪些变化

连接使用的 OAuth2 授权需要具有 organization:read 范围。
如果没有该范围，该命令将失败并返回“未授权 (401)”或“禁止 (403)”HTML 错误，而不是返回用户列表。

将命令切换至 2026

组织安全管理员将 organization:read 添加到 API 授权中，该授权的客户端 ID 保存在您的 Workiva 连接中：
1. 在右上角，点击用户图标，选择管理员，然后选择组织管理员。
2. 在左侧菜单中，选择安全，然后选择配置选项卡。
3. 找到该授权并从操作菜单打开它。
4. 在 Scopes中，选择 organization:read 并保存。客户端密钥保持不变。
注： organization:read 是一个组织范围。它不是从工作区设置中分配的。
更多信息，请参阅 Workiva 支持页面在组织管理中创建和管理 API 授权。
打开链表并选择 列出用户 命令。
将 API 版本设置为 2026。
保存并运行该链。
（可选，但建议）记录记录计数 值。
1. 将 API 版本 值改回 2022，然后再次运行该链。
2. 确认两次运行的记录计数 值相同。

笔记

默认 API 版本为 2022-01-01，即不带值的命令将使用的版本。
新命令的日期应设置为 2026 年。
您可以为每个运行报告 和 列出用户命令实例选择 2022 或 2026。
2022-01-01 版本将于 2027 年 11 月 30 日停止工作。在此日期之前，您需要将命令迁移到 2026 年。
其他 Workiva Connector 图形命令将于 2026 年 11 月 30 日自动移至 2026-01-01，您无需更改它们。
它们的 JSON 输出可以按不同的顺序列出字段和项目。数值相同。

疑难排解

信息	该怎么办
`错误：无法检索用户报告。`错误表中的状态码为 401 或 403。	检查 API 授权是否具有 `organization:read 权限，以`及授权用户是否为组织管理员。然后再次运行该命令。
`错误：无法检索用户报告。`，状态不同	请检查组织 ID 是否正确。错误表包含 API 详细信息。

电子表格命令更改

这些数据也会自动更新，无需进行任何链式编辑。输入和输出不变，但有些方面有所不同：

删除电子表格将电子表格移至回收站，而不是永久删除它。
获取工作表数据忽略修订值，并返回最新数据，同时发出警告。
现在，执行写入、覆盖、 清除工作表数据、更新工作表元数据、发布电子表格和 删除电子表格操作时，请等待更改完成，并忽略使用异步 设置。如果更改耗时超过约 5 分钟，这些命令将会失败。
获取工作表数据、 写入工作表数据和 覆盖工作表数据忽略使用平台 API 设置。

如果我什么都不做呢？

使用这些命令的命令将继续使用 2022-01-01，直到 2027 年 10 月 31 日。此后，设置为 2022-01-01 的命令将停止工作。

需要协助吗？

联系 Workiva 支持。

Workiva支持中心