要自动执行 Workiva 平台内的任务（例如与其他数据源交换数据），请添加一个包含 Workiva 连接命令的步骤。
要启用这些命令，IT 管理员 首先需要设置Workiva连接器。
清除数据表
要清除工作表中的所有数据，请使用 清除工作表数据 命令。
等效 API 调用：https://developers.workiva.com/2022-01-01/updatelegacyspreadsheetdataasync.html
属性
| 摘要信息 | 细节 |
|---|---|
| 电子表格ID | 请输入要清除的工作表的唯一标识符。 |
| 图纸编号/名称 | 请输入要清除的工作表的名称或唯一标识符。 |
输出
没有任何
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
创建文件
要上传逗号分隔值 (CSV)、Javascript 对象表示法 (JSON) 或压缩的 ZIP 文件并列出其记录，请使用 创建文件 命令。您还可以上传文件的 URL，例如 Amazon S3® 签名的指向 S3 存储桶中文件的 URL。
- 如果是 JSON 文件，则每行必须包含一条 JSON 记录——JSON 文件是由换行符分隔的一系列 JSON 对象。
- 如果是 ZIP 文件，则必须包含一个 CSV 或 JSON 文件，该文件的名称将用作导入文件的名称。再次下载该文件会下载源代码。
- 如果是 URL，则端点会使用简单的未经身份验证的
GET请求来请求获取文件。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-uploadfile/
属性
| 摘要信息 | 细节 |
|---|---|
| 表格 ID | 请输入要列出其中文件的表的ID。 |
| 文件 | 请输入要上传的文件。如果输入的是 下载网址 ，则忽略此项。注意：文件必须具有.CSV 或.JSON扩展名，或者是一个包含具有 .CSV 或 .JSON 扩展名文件的 ZIP 文件。 |
| 姓名 | 如果输入 下载 URL ，则输入要上传的文件的名称；默认情况下，为 下载 URL的基本名称。 |
| 下载链接 | 输入指向要下载文件的 URL，例如 Amazon S3 签名 URL。如果输入 文件 ，则此项为可选。 注意：该命令会向 URL 发送一个 。 |
输出
| 输出 | 输出类型 |
|---|---|
| 结果 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
创建新记录编辑
要根据提供的属性创建新的记录编辑，请使用 创建新记录编辑命令。每次编辑至少需要一个操作和一个目标 ID。
限制： 每个请求最多可处理 1000 次编辑。
等效 API 调用： https://developers.workiva.com/platform-v1/platform-createedits/
属性
| 摘要信息 | 细节 |
|---|---|
| 手术 |
选择要执行的操作。 选项：
|
| 标签 | 请输入一个标签，描述这两条记录之间的关系。用于创建或删除关系。 |
| 属性 | 输入与记录类型相关的属性。用于创建记录或设置其属性。 |
| 记录 ID | 输入来源的 ID 或临时记录 ID。用于创建或删除关系。 |
| 目标 ID | 请输入目标记录的ID。创建记录时，可以使用记录 ID 或临时记录 ID；删除记录时，必须使用实际记录 ID。 |
| 临时记录 ID | 输入创建记录时将使用的临时 ID；此临时 ID 将在处理时被替换。您可以在同一请求中使用此 ID 来创建已创建记录之间的关系。 |
| 类型 | 请输入要创建的记录类型。 |
输出
| 输出 | 输出类型 |
|---|---|
| 透视图 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
创建透视视图
要根据查询和查询结果创建新的 Wdata 视图，请使用 Create pivot view 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-createpivotview/
属性
| 摘要信息 | 细节 |
|---|---|
| 姓名 | 输入一个唯一的名称以帮助识别视图。 |
| 查询 ID | 请输入要从中创建视图的查询的 ID。 |
| 查询结果 ID | 输入要从中创建视图的查询结果的 ID。 |
| 附加元数据 | 输入要附加到视图的用户定义元数据（JSON 对象）（可选）。 |
输出
| 输出 | 输出类型 |
|---|---|
| 透视图 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
创建预览查询
要创建可在表上执行的临时预览查询，请使用 Create preview query 命令。
等效 API 调用：不 适用
属性
| 摘要信息 | 细节 |
|---|---|
| 表格 ID | 请输入要查询的表的ID。 |
| 限制 | 请输入要返回的最大结果数。 |
| 文件 | 如果指定，请输入要查询的表中的文件名。 |
输出
| 输出 | 输出类型 |
|---|---|
| 查询 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
创建查询
要创建新的 Wdata 查询，请使用 Create query 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-createquery/
属性
| 摘要信息 | 细节 |
|---|---|
| 姓名 | 请输入一个唯一的名称，以便识别查询。 |
| 描述 | 请输入查询描述。 |
| 主要结果 ID | 如果指定，请输入要填充查询结果的默认结果的 ID。 |
| 查询文本 | 以 Presto SQL 语法输入查询定义， 就像在查询的SQL编辑器中一样。 |
| 暂时的 | 要临时生成查询， 使其 不会出现在您的工作区中，请选中此框。 |
| 参数 | 请输入运行查询所需的参数。 |
输出
| 输出 | 输出类型 |
|---|---|
| 查询 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
创建记录
此命令仅可通过平台 API 获取。要创建新记录，请使用 创建新记录编辑 端点。
创建下拉列表
要为多选查询参数创建值列表，请使用 Create select list 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-createselectlist/
属性
| 摘要信息 | 细节 |
|---|---|
| 姓名 | 输入一个唯一的名称，以便识别选择列表。 |
| 描述 | 为了帮助进一步识别选择列表，请输入其值或参数的描述。 |
| 值类型 | 选择列表值的数据类型，例如字符串或整数。 |
| 值 | 请输入列表的值。 |
输出
| 输出 | 输出类型 |
|---|---|
| 创建选择列表元数据 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 |
错误 |
创建表格
要向电子表格中添加新工作表，请使用 Create sheet 命令。
等效 API 调用： https://developers.workiva.com/spreadsheets-v1/spreadsheets-createsheet/
属性
| 摘要信息 | 细节 |
|---|---|
| 电子表格ID | 请输入要添加工作表的电子表格的唯一标识符。 |
| 姓名 | 输入一个唯一的名称，以便识别该工作表。 |
| 索引页 | 输入新工作表在电子表格中的索引。注： 默认情况下，该命令会将工作表添加为顶层工作表。 |
| 父级工作表 ID | 输入要创建在其下的工作表的父工作表的 ID。要添加到根电子表格，请留空。 |
输出
| 输出 | 输出类型 |
|---|---|
| 表格元数据 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
创建电子表格
要创建新电子表格，请使用 创建电子表格 命令。
等效 API 调用： https://developers.workiva.com/2022-01-01/createlegacyspreadsheet.html
属性
| 摘要信息 | 细节 |
|---|---|
| 姓名 | 输入唯一名称以帮助识别电子表格。 |
输出
| 输出 | 输出类型 |
|---|---|
| 表格元数据 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
创建表
要在工作区中创建新的 Wdata 表，请使用 Create table 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-createtable/
属性
| 摘要信息 | 细节 |
|---|---|
| 姓名 | 输入一个唯一的名称，以便识别该表。 |
| 描述 | 请输入新表格的描述。 |
| 类型 | 选择是创建数据表（或 事实表）还是查找表（或 维度表）。 |
| 列 | 添加要包含在表格中的列：
|
输出
| 输出 | 输出类型 |
|---|---|
| 表格 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
删除文件
要从 Wdata 工作区中删除文件，请使用 Delete file 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-deletefile/
属性
| 摘要信息 | 细节 |
|---|---|
| 文件 ID | 请输入要删除的文件的ID。 |
输出
没有任何
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
删除透视图
要从工作区中删除 Wdata 视图，请使用 删除透视视图 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-deletepivotview/
属性
| 摘要信息 | 细节 |
|---|---|
| ID | 请输入要删除的视图的ID。 |
输出
没有任何
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
删除查询
要从工作区中删除 Wdata 查询，请使用 Delete query 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-deletequery/
属性
| 摘要信息 | 细节 |
|---|---|
| 查询 ID | 请输入要删除的查询的ID。 |
输出
没有任何
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
删除记录
删除表格
要从电子表格中删除一个工作表及其子工作表（递归地），请使用 Delete sheet 命令。
等效 API 调用： https://developers.workiva.com/2022-01-01/deletelegacysheet.html
属性
| 摘要信息 | 细节 |
|---|---|
| 电子表格ID | 请输入要删除的工作表所在的电子表格的唯一标识符。 |
| 图纸编号/名称 | 请输入要删除的工作表的名称或唯一标识符。 |
输出
没有任何
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
删除电子表格
要从工作区中删除电子表格，请使用 删除电子表格 命令。
等效 API 调用： https://developers.workiva.com/spreadsheets-v1/spreadsheets-deletespreadsheet/
属性
| 摘要信息 | 细节 |
|---|---|
| 电子表格ID | 请输入要删除的电子表格的唯一标识符。 |
输出
没有任何
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
删除表
要从工作区中删除 Wdata 表，请使用 Delete table 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-deletetable/
属性
| 摘要信息 | 细节 |
|---|---|
| 表格 ID | 请输入要删除的表的唯一标识符 |
输出
没有任何
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
下载文件
要从 Wdata 工作区下载数据集，请使用 Download file 命令。
注意：此命令与其他对象类型（例如电子表格、表格或查询 ）不兼容
。等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-downloadfile_1/
属性
| 摘要信息 | 细节 |
|---|---|
| 文件 ID | 请输入要下载的文件的ID。 |
输出
| 输出 | 输出类型 |
|---|---|
| 文件 | 文件 |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
<!--
Download Pivot View
Downloads the content from a pivot view
Inputs
| Input | Detail |
| ID | Enter the ID of the pivot view to download |
Outputs
| Output | Output Type |
| Pivot View Content | File |
Exit Codes
| Code | Type | Detail |
| 0 | Success | Success |
| 1 | Error | Error |
Download pivot view
To download the contents of a view, use a Download pivot view command.
Properties
| Property | Detail |
|---|---|
| ID | Enter the ID of the view to download. |
Outputs
| Output | Output Type |
|---|---|
| Pivot view content | File |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
下载查询结果
要将 Wdata 查询结果下载到文件，请使用 Download query result 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-downloadqueryresult/
属性
| 摘要信息 | 细节 |
|---|---|
| 查询结果 ID | 请输入要下载的查询结果的ID。 |
输出
| 输出 | 输出类型 |
|---|---|
| 查询结果 | 文件 |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
编辑
此命令仅可通过平台 API 获取。要编辑记录，请使用 创建新记录编辑 端点。
将文件导出到电子表格
要将 Wdata 表中的数据集导出到新的或现有的电子表格，请使用 Export file to spreadsheet 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-exportfiletospreadsheets/
属性
| 摘要信息 | 细节 |
|---|---|
| 文件 ID | 请输入要导出的表格数据集的ID。 |
| 电子表格网址 | 请输入要导出到的电子表格的URL。要创建新的电子表格，请留空。 |
输出
| 输出 | 输出类型 |
|---|---|
| 表格信息 | 文件 |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
导出查询结果
要将 Wdata 查询结果导出到新的或现有的电子表格，请使用 Export query result 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-exportqueryresulttospreadsheets/
属性
| 摘要信息 | 细节 |
|---|---|
| 查询结果 ID | 请输入要导出的查询结果的ID。 |
| 电子表格网址 |
请输入要导出到的电子表格的URL。要创建新的电子表格，请留空。 |
| 导出为数据集 |
选中后，数据将导出为关联数据集，并且只能通过在电子表格中更新数据集来编辑单元格。 |
输出
没有任何
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
获取文件属性
要检索 Wdata 工作区中文件的属性，请使用 获取文件属性 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-getfile/
属性
| 摘要信息 | 细节 |
|---|---|
| 文件 ID | 输入要获取其属性的文件ID。 |
输出
| 输出 | 输出类型 |
|---|---|
| 文件属性 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
获取透视图
要检索 Wdata 视图的元数据，请使用 Get pivot view 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-getpivotview/
属性
| 摘要信息 | 细节 |
|---|---|
| ID | 输入要从中获取元数据的透视视图的 ID。 |
输出
| 输出 | 输出类型 |
|---|---|
| 透视图 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
获取查询元数据
要检索 Wdata 查询的元数据，请使用 Get query metadata 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-getquery/
属性
| 摘要信息 | 细节 |
|---|---|
| 查询 ID | 请输入要从中获取元数据的查询的ID。 |
输出
| 输出 | 输出类型 |
|---|---|
| 查询 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
获取记录
此命令仅可通过平台 API 获取。要获取一条记录，请使用 检索单个记录 端点。
获取记录
此命令仅可通过平台 API 获取。要获取多条记录，请使用 检索记录列表 端点。
获取报告
要从您组织的 SOX 和内部审计数据库帐户检索所有报告，请使用 Get reports 命令。
等效 API 调用：https://developers.workiva.com/platform-v1/platform-graphreportexport/
属性
没有任何
输出
| 输出 | 输出类型 |
|---|---|
| 报表 | 文件 |
| 报告计数 | 整数 |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
获取选择列表
要根据列表的 ID 检索多选查询参数的值列表，请使用 Get select list 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-getselectlist/
属性
| 摘要信息 | 细节 |
|---|---|
| 选择列表 ID | 请输入要检索的选择列表的唯一标识符。 |
输出
| 输出 | 输出类型 |
|---|---|
| 获取选择列表有效负载 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
获取表格数据
要检索工作表指定区域中的所有数据，请使用 获取工作表数据 命令。
等效 API 调用： https://developers.workiva.com/spreadsheets-v1/spreadsheets-getdata/
属性
| 摘要信息 | 细节 |
|---|---|
| 电子表格ID | 请输入要从中获取数据的工作表的唯一标识符。 |
| 图纸编号/名称 | 输入要从中获取数据的工作表的名称或唯一标识符。 |
| 地区 | 输入单元格或区域的 A1 样式表示，例如 [起始列][起始行]:[结束列][结束行]。要使范围在任何或所有方向上不受限制，请省略相应的列或行。 |
| 价值风格 | 选择返回单元格的原始值还是计算值。例如，如果单元格的值为 =1+:1，则对于 =1+1 选择“原始值”，对于计算值 2 选择“计算值”。 |
| 修订 | 请输入要从中检索数据的工作表版本。对于当前版本，请输入 -1。 |
| 使用平台 API | 选中此框后，此命令将使用标准十进制表示法返回工作表数据。如果为空，则以科学计数法返回表格数据。这将强制命令使用“从工作表端点检索数据”而不是电子表格 API 的“从区域端点返回数据”。 |
输出
| 输出 | 输出类型 |
|---|---|
| 行数 | 整数 |
| 数据 | 文件 |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
获取表格元数据
要检索电子表格中工作表的元数据，请使用 获取工作表元数据 命令。
等效 API 调用： https://developers.workiva.com/2022-01-01/getsheetdata.html
属性
| 摘要信息 | 细节 |
|---|---|
| 电子表格ID | 输入要从中获取元数据的电子表格的唯一标识符。 |
| 图纸编号/名称 | 输入要从中获取元数据的表格名称或唯一标识符。 |
输出
| 输出 | 输出类型 |
|---|---|
| 表格元数据 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
获取电子表格元数据
要检索电子表格的元数据，请使用 获取电子表格元数据 命令。
等效 API 调用： https://developers.workiva.com/2022-01-01/getplatformspreadsheetbyid.html
属性
| 摘要信息 | 细节 |
|---|---|
| 电子表格ID | 输入要从中获取元数据的电子表格的唯一标识符。 |
输出
| 输出 | 输出类型 |
|---|---|
| 电子表格元数据 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
获取表元数据
要检索 Wdata 表的元数据，请使用 Get table metadata 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-gettable/
属性
| 摘要信息 | 细节 |
|---|---|
| 表格 ID | 请输入要从中获取元数据的表的唯一标识符。 |
输出
| 输出 | 输出类型 |
|---|---|
| 表格 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
获取类型
此命令仅可通过平台 API 获取。要获取一条记录，请使用 检索单个记录 端点。
获取类型
此命令仅可通过平台 API 获取。要获取多个记录类型，请使用 检索类型列表 端点。
<!-- display page content -->
健康检查
要检查 Wdata API 的运行状况，请使用 Health check 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-healthcheck/
属性
没有任何
输出
| 输出 | 输出类型 |
|---|---|
| 回复 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
将文件导入表
要将文件导入 Wdata 表，请使用 Import file into table 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-importfile/
属性
| 摘要信息 | 细节 |
|---|---|
| 表格 ID | 请输入要将文件导入的表的ID。 |
| 文件 ID | 请输入要导入到表中的文件的ID。 |
| 列映射 | 将文件中的每一列映射到表中的列。 |
| 异步运行 | 要使命令异步运行， 并且 不等待导入完成再继续执行链式操作，请选中此框。 |
| 标记 | 要包含组织跟踪的数据元数据，请添加标签并选择其名称和值。 |
输出
| 输出 | 输出类型 |
|---|---|
| 文件导入 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
将电子表格导入表格
要将电子表格导入到表格中并返回文件元数据结果，请使用 Import spreadsheet into table 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-importfromspreadsheets/
属性
| 摘要信息 | 细节 |
|---|---|
| 表格 ID | 请输入要将文件导入到的表的唯一标识符。 |
| 文件 ID | 输入要将电子表格导入的文件的唯一标识符（可选）。 |
| 文件名称 | 输入文件导入表时要赋予的唯一名称。 |
| 电子表格网址 | 请输入要从中导入数据的电子表格的完整URL。 |
| 异步运行 | 要使命令异步运行， 并且 不等待导入完成再继续执行链式操作，请选中此框。 |
| 标记 | 要包含组织跟踪的数据元数据，请添加标签并选择其名称和值。 |
输出
| 输出 | 输出类型 |
|---|---|
| 文件导入 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
列出连接
要列出 Workiva 平台功能之间的数据，请使用 列出连接 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-listconnections/
| 摘要信息 | 细节 |
|---|---|
| 来源类型 | 使用下拉菜单，选择要从中提取数据的文件或项目类型。 |
| 目的地类型 | 使用下拉菜单，选择要发送数据的文件或项目类型。 |
| 源 ID | 请输入要从中提取数据的文件或项目的唯一标识符。 |
| 目标 ID | 请输入要发送数据的文件或项目的唯一标识符。 |
注意：您的请求必须包含 源类型
+ 源ID 或 目标类型 + 目标 ID；如果缺少其中任何一项 ，请求将失败。输出
| 输出 | 输出类型 |
|---|---|
| 连线 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
列出文件错误
要列出与文件相关的错误（例如导入时出现的错误），请使用 列出文件错误 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-geterrors/
属性
| 摘要信息 | 细节 |
|---|---|
| 文件 ID | 输入要获取错误信息的文件ID。 |
输出
| 输出 | 输出类型 |
|---|---|
| 错误列表 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
列出文件
要检索 Wdata 表中的文件列表及其元数据，请使用 List files 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-getfiles/
属性
| 摘要信息 | 细节 |
|---|---|
| 表格 ID | 请输入要从中获取文件的表的ID。 |
输出
| 输出 | 输出类型 |
|---|---|
| 文件列表 | 文件 |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
列表透视视图
要列出工作区中的 Wdata 视图并检索其元数据，请使用 列出透视视图 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-listpivotviews/
属性
没有任何
输出
| 输出 | 输出类型 |
|---|---|
| 透视图 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
列表查询
要列出工作区中的 Wdata 查询并检索其元数据，请使用 List queries 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-listqueries/
属性
没有任何
输出
| 输出 | 输出类型 |
|---|---|
| 查询 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
列出查询结果
要列出 Wdata 查询的可用结果，请使用 列出查询结果 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-listqueryresults/
属性
| 摘要信息 | 细节 |
|---|---|
| 查询 ID | 请输入要获取结果的查询的ID。 |
输出
| 输出 | 输出类型 |
|---|---|
| 查询结果 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
列表选择列表
要列出工作区中多选查询参数的所有值列表并检索其元数据，请使用 List select lists 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-listselectlists/
属性
没有任何
输出
| 输出 | 输出类型 |
|---|---|
| 列表选择列表 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
清单表
要列出电子表格中的所有工作表并检索其元数据，请使用 列出工作表 命令。
等效 API 调用： https://developers.workiva.com/2022-01-01/getlegacysheets.html
属性
| 摘要信息 | 细节 |
|---|---|
| 电子表格ID | 输入要列出工作表的电子表格的唯一标识符。 |
输出
| 输出 | 输出类型 |
|---|---|
| 工作表 | JSON |
| 纸张数量 | 整数 |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
列表表
要列出工作区中的所有 Wdata 表并检索其元数据，请使用 List tables 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-gettables/
属性
没有任何
输出
| 输出 | 输出类型 |
|---|---|
| 表格列表 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
列出用户
要检索有关组织用户的详细信息列表，请使用 List users 命令。您指定的集成用户必须具有组织管理员角色才能执行此命令。
与组织管理员的“人员视图”导出功能类似，详细信息按显示名称排序，并包含用户的以下信息：
- 用户名
- 电子邮件地址
- SAML ID
- 上次登录
- 工作区会员资格
- 执照和角色
等效 API 调用： https://developers.workiva.com/admin-v1/admin-getorgreportusers/
属性
| 摘要信息 | 细节 |
|---|---|
| 组织 ID | 请输入要列出用户的组织的唯一标识符。 |
输出
| 输出 | 输出类型 |
|---|---|
| 用户报告 | 文件 |
| 记录计数 | 整数 |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
覆盖工作表数据
要清除工作表中的所有单元格并将其替换为文件中提供的值，请使用 覆盖工作表数据 命令。
等效 API 调用： https://developers.workiva.com/2022-01-01/updatesheet.html#
属性
| 摘要信息 | 细节 |
|---|---|
| 电子表格ID | 输入要覆盖工作表数据的电子表格的唯一标识符。 |
| 图纸编号/名称 | 输入要覆盖数据的工作表的名称或唯一标识符。 |
| 数据文件 | 输入包含要填充到表格中的数据的 CSV 文件。 |
| 分隔符号 | 输入 数据文件中使用的分隔符。 |
| 使用平台 API | 要使用电子表格单元格值的 输入在 格式，请选中此框。 |
输出
| 输出 | 输出类型 |
|---|---|
| 写行 | 整数 |
| 细胞写入 | 整数 |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
发布电子表格
要发布电子表格中的链接，请使用 发布电子表格 命令。
等效 API 调用： https://developers.workiva.com/spreadsheets-v1/spreadsheets-publish/
属性
| 摘要信息 | 细节 |
|---|---|
| 电子表格ID | 请输入要发布的电子表格的唯一标识符。 |
| 发布所有 个连结 | 选择要发布的电子表格链接：
|
输出
| 输出 | 输出类型 |
|---|---|
| 信息 | 字串 |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
重新整理连线
要根据连接的 ID 刷新特定连接，请使用 Refresh connection 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-refreshconnection/
属性
| 摘要信息 | 细节 |
|---|---|
| 连线 ID | 请输入要刷新的连接的唯一标识符。 |
| 使用之前的源参数 | 选中此框可使用上次运行的源参数；这将覆盖您指定的任何其他源参数。 “刷新连接批次”端点将忽略此输入。 |
| 源参数* |
输入成功刷新后要发送到源的参数。 （如果启用了“使用先前的源参数”，则这些参数将被忽略。） |
| 使用之前的目标参数 | 选中此框可使用上次运行的目标参数；这将覆盖您指定的任何其他目标参数。 “刷新连接批次”端点将忽略此输入。 |
| 目标参数* |
输入刷新成功后要发送到目标位置的参数。 （如果启用了“使用先前的目标参数”，则这些参数将被忽略。） |
注： 目前不支持多选参数。
输出
| 输出 | 输出类型 |
|---|---|
| 刷新状态 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
刷新连接批次
要一次刷新多个连接，请使用 刷新一批连接 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-refreshbatch/
属性
| 摘要信息 | 细节 |
|---|---|
| 连线 |
切换以启用或禁用变量的使用。 启用后：
|
| 连线 ID | 请输入要刷新的连接的唯一标识符。 |
| 使用之前的源参数 | 选中此框可使用上次运行的源参数；这将覆盖您指定的任何其他源参数。 “刷新连接批次”端点将忽略此输入。 |
| 源参数 |
输入刷新成功后要发送到源的参数。 （如果启用了“使用先前的源参数”，则这些参数将被忽略。） |
| 使用之前的目标参数 | 选中此框可使用上次运行的目标参数；这将覆盖您指定的任何其他目标参数。 “刷新连接批次”端点将忽略此输入。 |
| 目标参数 |
输入刷新成功后要发送到目标位置的参数。 （如果启用了“使用先前的目标参数”，则这些参数将被忽略。） |
输出
| 输出 | 输出类型 |
|---|---|
| 批量刷新状态 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
去除边缘
此命令仅可通过平台 API 获取。要删除一条边，请使用 创建新记录编辑 端点。
获取记录列表
要返回与提供的筛选条件匹配的记录列表，请使用 检索记录列表 命令。至少需要一个过滤器。
等效 API 调用： https://developers.workiva.com/platform-v1/platform-getrecords/
属性
| 摘要信息 | 细节 |
|---|---|
| 展开 |
返回与主资源相关的资源。 选项：
|
| 筛选 | 用于筛选结果的属性。 |
输出
| 输出 | 输出类型 |
|---|---|
| 批量刷新状态 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
获取类型列表
要返回记录类型及其属性的列表，请使用 检索类型列表 命令。此命令可让您了解检索记录时可能出现的情况。
等效 API 调用： https://developers.workiva.com/platform-v1/platform-gettypes/
属性
| 摘要信息 | 细节 |
|---|---|
| 展开 |
返回与主资源相关的资源。 选项：
|
输出
| 输出 | 输出类型 |
|---|---|
| 批量刷新状态 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
检索单个记录
要检索单个记录，请使用 检索记录列表 命令。唯一标识符通常是 UUID，但也可能有所不同。
等效 API 调用： https://developers.workiva.com/platform-v1/platform-getrecordbyid/
属性
| 摘要信息 | 细节 |
|---|---|
| 展开 |
返回与主资源相关的资源。 选项：
|
| 记录 ID | 请输入记录的唯一标识符。 |
输出
| 输出 | 输出类型 |
|---|---|
| 批量刷新状态 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
检索单个类型
要检索单个记录，请使用 检索记录列表 命令。唯一标识符通常是 UUID，但也可能有所不同。
等效 API 调用： https://developers.workiva.com/platform-v1/platform-gettypebyid/
属性
| 摘要信息 | 细节 |
|---|---|
| 展开 |
返回与主资源相关的资源。 选项：
|
| 记录 ID | 请输入记录的唯一标识符。 |
输出
| 输出 | 输出类型 |
|---|---|
| 批量刷新状态 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
运行查询
要运行 Wdata 查询并检索其结果，请使用 Run query 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-runquery/
属性
| 摘要信息 | 细节 |
|---|---|
| 查询 ID | 请输入要运行的查询的ID。 |
| 参数 | 如果查询定义了参数，则添加参数名称和值的映射。注： 请在 中输入多选参数的值。多选参数。 |
| 异步运行 | 要异步运行查询， 并且 不等待查询完成以完成命令，请选中此框。 |
| 多选参数 | 如果查询定义了多选参数，请添加每个参数的名称和值。 |
输出
| 输出 | 输出类型 |
|---|---|
| 查询结果 | JSON |
注：查询结果 输出包含一个 ID，可用于下载和导出结果。
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
运行报告
要运行组织 SOX 和内部审计数据库帐户中已保存的报告，并将结果以 CSV 文件形式返回，请使用 运行报告 命令。
等效 API 调用： https://developers.workiva.com/platform-v1/platform-getreportascsv/
属性
| 摘要信息 | 细节 |
|---|---|
| 报告 ID | 输入包含已保存报表的报表的唯一标识符。 |
| 预览内容 | 要在命令日志中包含报告结果的预览，请选中此框。 |
输出
| 输出 | 输出类型 |
|---|---|
| 报表 | 文件 |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
设置边缘
此命令仅可通过平台 API 获取。要设置边，请使用 创建新记录编辑 端点。
设置记录属性
此命令仅可通过平台 API 获取。要设置记录属性，请使用 创建新记录编辑 端点。
从表中取消导入文件
要从 Wdata 表中取消导入并删除文件，请使用 Un-import file From table 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-unimportfile/
属性
| 摘要信息 | 细节 |
|---|---|
| 表格 ID | 请输入要从中删除文件的表的唯一标识符。 |
| 文件 ID | 请输入要从表中删除的文件的唯一标识符。 |
输出
| 输出 | 输出类型 |
|---|---|
| 文件导入 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
更新透视表
要更新 Wdata 视图的元数据，请使用 更新透视视图 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-updatepivotview/
属性
| 摘要信息 | 细节 |
|---|---|
| ID | 请输入要更新的视图的ID。 |
| 姓名 | 请输入视图的新名称。 |
| 查询 ID | 请输入要从中创建视图的查询的 ID。 |
| 查询结果 ID | 输入要从中创建视图的查询结果的 ID。 |
| 附加元数据 | 输入要附加到视图的用户定义元数据，以 JSON 对象的形式（可选）。 |
输出
| 输出 | 输出类型 |
|---|---|
| 透视图 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
更新查询定义
要更新 Wdata 查询的属性，请使用 更新查询定义 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-updatequery/
属性
| 摘要信息 | 细节 |
|---|---|
| 查询 ID | 请输入要更新的查询的ID。 |
| 姓名 | 请输入查询的新名称。 |
| 描述 | 请输入查询的新描述。 |
| 主要结果 ID | 如果指定，请输入要填充查询结果的默认结果的 ID。 |
| 查询文本 | 以 Presto SQL 语法输入查询定义，就像在查询的 SQL 编辑器中输入一样。 |
| 暂时的 | 要仅临时生成查询， 使其 不出现在您的工作区中，请选中此框。 |
| 参数 | 请输入运行查询所需的参数。 |
输出
| 输出 | 输出类型 |
|---|---|
| 查询 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
更新选择列表
要更新多选查询参数的值列表的属性或项，请使用 Update select list 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-updateselectlist/
属性
| 摘要信息 | 细节 |
|---|---|
| ID | 请输入要更新的选择列表的 ID。 |
| 姓名 | 请输入下拉列表的新名称。 |
| 描述 | 请输入下拉列表的新描述。 |
| 值类型 | 选择列表值的数据类型，例如字符串或整数。 |
| 值 | 输入列表的值，包括任何更新。 |
输出
| 输出 | 输出类型 |
|---|---|
| 更新选择列表 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
更新表格元数据
要更新电子表格中工作表的元数据，请使用 更新工作表元数据 命令。
等效 API 调用： https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatesheet/
属性
| 摘要信息 | 细节 |
|---|---|
| 电子表格ID | 输入要更新元数据的电子表格的唯一标识符。 |
| 图纸编号/名称 | 输入要更新元数据的表格名称或唯一标识符。 |
| 姓名 | 请输入工作表的新名称。 |
| 索引页 | 输入电子表格中工作表的新索引。默认情况下，该命令会将工作表更新为顶层工作表。 |
| 父级工作表 ID | 输入要创建在其下的工作表的父工作表的 ID。要向根电子表格添加内容，请留空。 |
输出
没有任何
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
更新电子表格元数据
要更新电子表格的元数据，请使用 更新电子表格元数据 命令。
等效 API 调用： https://developers.workiva.com/2022-01-01/updatesheet.html
属性
| 摘要信息 | 细节 |
|---|---|
| 电子表格ID | 输入要更新元数据的电子表格的唯一标识符。 |
| 姓名 | 请输入电子表格的新名称。 |
输出
没有任何
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
更新表
要更新 Wdata 表的列，请使用 Update table 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-updatetable/
属性
| 摘要信息 | 细节 |
|---|---|
| 表格 ID | 请输入要更新的表的唯一标识符。 |
| 姓名 | 请输入要更新的表的名称。 |
| 描述 | 请输入要更新的表格的描述。 |
| 类型 | 选择要更新的是数据表（或 事实表）还是查找表（或 维度表） 。 |
| 列 | 添加要更新的列。请输入每一列的名称、数据类型、别名和描述。对于 模式，保留默认值 Nullable。 |
输出
| 输出 | 输出类型 |
|---|---|
| 表格 | JSON |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
写入表格数据
要将 CSV 数据集中的数据写入工作表的特定区域，请使用 Write sheet data 命令。
属性
| 摘要信息 | 细节 |
|---|---|
| 电子表格ID | 请输入要写入数据的电子表格的唯一标识符。 |
| 图纸编号/名称 | 请输入要写入数据的工作表的唯一标识符。 |
| 数据文件 | 输入包含要写入表格数据的 CSV 文件。 数据范围 不得超出 区域。 |
| 分隔符号 | 输入 数据文件中使用的分隔符。 |
| 地区 | 输入工作表中要写入数据的单元格或单元格区域的 A1 表示形式。要使范围在任何或所有方向上不受限制，请将相应的列或行留空。 |
| 使用异步 |
要异步加载数据（例如对于大型数据集），请选中此框。 注意：使用异步方法时，您必须添加自己的轮询机制来确定作业状态。 |
| 使用平台 API |
要使用输入的格式的区域 单元格值，请选中此复选框。 这将强制命令使用 更新范围端点 中的值，而不是电子表格 API 的 向区域写入数据端点。 注意：使用平台 API 时，此命令将始终异步运行。您必须添加自己的轮询来确定作业状态。 |
输出
| 输出 | 输出类型 |
|---|---|
| 写好的行 | 整数 |
| 细胞写入 | 整数 |
退出代码
| 代码 | 类型 | 细节 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |