Workiva Connector 电子表格命令使用 Workiva 平台 API。当前版本为 2022-01-01,但该版本将被停用。为了保持您的供应链正常运行,我们将所有 Workiva Connector 命令升级到 2026-01-01 版本。
大多数 Workiva 连接器命令将于 2026 年 11 月 30 日自动迁移到 2026-01-01,您无需编辑您的链。输入和输出保持不变。
电子表格命令
随着 API 版本 2026-01-01 的推出,Workiva 连接器中的电子表格命令现在有一个 API 版本 字段,要求您选择 2022 或 2026。默认值为 2022,未指定值的命令也使用 2022。这意味着在该字段存在之前保存的 Chain 命令在 2022 年仍将继续运行。
2027年 10 月 31 日,我们将把这些命令移至 2026 年 1 月 1 日。在此之前进行更换,以便您可以在 2026 年测试您的链条。
2026年会发生哪些变化?
下表列出了命令的更改:
| 命令 | 变更 |
|---|---|
| 写入工作表数据、覆盖工作表数据、清除工作表数据、更新工作表元数据、发布电子表格、删除电子表格 |
|
| 删除电子表格 |
将电子表格移至回收站,以便可以恢复。 链中稍后的 获取电子表格元数据 命令将失败,并显示消息“所选电子表格已被删除”。 |
| 获取表格数据 | 修订 将被忽略。该命令返回最新数据和记录 警告:--revision 不受 Platform API 2026 支持。已返回最新的工作表数据。 在日志中。如果您的链需要之前的版本,请将命令设置为 2022。 |
| 创建电子表格 | 失败时不再打印详细的“错误:”列表。 |
| 删除表格 | API 会拒绝包含 XBRL 格式的工作表。 |
| 获取工作表元数据、更新工作表元数据以及其他需要工作表名称的命令 | 现在,位于第一页之后的图纸名称也能正确显示了。 |
其他变化
- 某些“未找到”错误文本在不同版本之间有所不同,因此,如果后续命令检查错误文本,则其在不同版本中的行为可能会有所不同。
- 如果 API 授权缺少
file:read或file:write值,则 2026 个命令将失败,这可能会导致整个链失败。 - 虽然 获取工作表数据、 写入工作表数据和 覆盖工作表数据 的配置对话框中有一个 使用平台 API 复选框,但如果 API 版本为 2026,即使该复选框为空,这些命令也将使用 2026 API。
不变的是……
- 每个命令都有输入和输出名称,以便后续命令能够继续工作。
- 成功消息:“删除成功”、“更新成功”、“发布成功”。
- 主机覆盖连接。您不能添加或更改其中任何一个。
前提条件:file:read 和 file:write
在 2026 年的 API 中,这些命令检查的范围与 2022 年的 API 不同。除非这些授权得到更新,否则使用 2022 API 可以正常运行的命令在使用 2026 API 时将会失败。
- 读取 电子表格的命令需要
file: read。 - 更改 电子 表格的命令需
要 文件:写入。
添加范围值
添加这些权限范围需要 Workiva 组织安全管理员将这些权限范围添加到 API 授权中,该管理员的客户端 ID 保存在您的 Workiva 连接中:
- 在右上角,点击用户图标,选择 管理员,然后选择 组织管理员。
- 在左侧菜单中,选择 安全,然后选择 配置 选项卡。
- 找到该授权并从 操作 菜单打开它。
- 在 Scopes中,选择
file:read和file:write并保存授权。客户端密钥保持不变。
有关更多信息,请参阅 在组织管理中创建和管理 API 授权。
将链条切换至 2026 年的步骤
- 确保授权具有
file:read和file:write。参见 先决条件。 - 打开链条。在每个电子表格命令步骤中,将 API 版本 设置为 2026。
- 保存并运行该链。
- (可选,但建议)将以下输出与 2022 年早些时候的运行进行比较:
写入的行数、写入的单元格数、数据 CSV 和工作表数。
如果出现问题,请将步骤恢复到 2022 并联系 Workiva 支持。
链中仅使用一个 API 版本 Workiva 建议链中的所有电子表格命令步骤使用同一个 API 版本;我们不保证混用多个 API 版本能够按预期或理想方式运行。
疑难排解
| 信息 | 该怎么办 |
|---|---|
凭据不具备所需的权限范围:file:read 或 file:write,HTML 错误代码 401 |
API 授权缺少消息中指定的范围。按照 前提条件中的说明添加,然后再次运行该链。在此之前,请将命令设置为 2022。 |
尝试次数已超过 300 次限制 或时间限制已超过 10 分钟 |
命令未能及时完成。减少数据大小,或将命令设置为 2022 并联系 Workiva 支持。 |
操作失败 或 操作已取消 |
请检查电子表格和工作表 ID。如果信息正确,请使用日志中显示的操作 ID 联系支持部门。 |
选定的电子表格已被删除。 |
之前使用 2026 删除 电子表格 的步骤已将其移至回收站。恢复原状,或者使用另一个电子表格。 |
API 版本必须为 2022 或 2026。 |
该字段还包含另一个值。设置为 2022 年或 2026 年。 |
如果我什么都不做呢?
设置为 2022 的命令有效期至 2027年 10 月 31 日。届时,我们将日期更改为 2026 年 1 月 1 日。提前切换好你的指令,这样你就有时间测试你的指令链。
需要协助吗?
联系 Workiva 支持。