要在 Workiva 平台内自动执行作为链条一部分的任务，例如与其他数据源交换数据，可添加包含 Workiva 连接命令的步骤。
要启用这些命令，IT 管理员首先要 设置 Workiva 连接器。
净纸数据
要清除工作表中的所有数据，请使用 清除工作表数据 命令。
等效 API 调用： https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatedataasync/
属性
| 摘要信息 | 详细信息 |
|---|---|
| 电子表格ID | 输入要清除工作表的电子表格的唯一标识符。 |
| 纸张 ID/名称 | 输入要清除的工作表名称或唯一标识符。 |
输出
没有任何
退出代码
| 代码 | 类型 | 详细信息 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
创建文件
要上传逗号分隔值 (CSV)、Javascript 对象符号 (JSON) 或压缩 ZIP 文件并列出其记录，请使用 Create file 命令。您还可以上传文件的 URL，例如将 Amazon S3® 签名 URL 上传到 S3 存储桶中的文件。
- 如果是 JSON 文件，则每行必须有一条 JSON 记录--JSON 文件是以换行符分隔的一系列 JSON 对象。
- 如果是 ZIP 文件，则必须包含一个 CSV 或 JSON 文件，其名称用于命名导入的文件。再次下载文件可下载源文件。
- 如果是 URL，端点会使用简单的未认证
GET请求来获取文件。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-uploadfile/
属性
| 摘要信息 | 详细信息 |
|---|---|
| 表格 ID | 输入要列出文件的表格 ID。 |
| 文件 | 输入要上传的文件。如果输入 下载 URL ，则忽略。注意： 文件的扩展名必须是 .CSV 或 .JSON，或者是包含 .CSV 或 .JSON 扩展名文件的 ZIP 文件。 |
| 姓名 | 如果输入 下载 URL ，则输入要上传的文件名；默认情况下，基本名称为 下载 URL。 |
| 下载 URL | 输入指向要下载文件的 URL，例如 Amazon S3 签名 URL。如果输入 File ，则为可选项。 注： 该命令针对 URL 提出简单的 |
输出
| 输出 | 输出类型 |
|---|---|
| 结果 | JSON |
退出代码
| 代码 | 类型 | 详细信息 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
创建新的记录编辑
要根据提供的属性创建新的记录编辑，请使用 Create new record edits 命令。每次编辑至少需要一个操作和 targetId。
限制：
- 每次申请最多可处理 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 调用： https://developers.workiva.com/wdata-v1/wdata-previewqueryusingpost/
属性
| 摘要信息 | 详细信息 |
|---|---|
| 表格 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 | 错误 | 错误 |
创建记录
该命令只能通过 Platform API 使用。要创建新记录，请使用 创建新记录编辑 端点。
创建选择列表
要为多选查询参数创建值列表，请使用 Create select list 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-createselectlist/
属性
| 摘要信息 | 详细信息 |
|---|---|
| 姓名 | 输入一个唯一的名称，以帮助识别选择列表。 |
| 描述 | 为帮助进一步识别选择列表，请输入其值或参数的描述。 |
| 值类型 | 选择列表值的数据类型，如字符串或整数。 |
| 值 | 输入列表值。 |
输出
| 输出 | 输出类型 |
|---|---|
| 创建选择列表元数据 | JSON |
退出代码
| 代码 | 类型 | 详细信息 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 |
错误 |
创建工作表
要在电子表格中添加新工作表，请使用 创建工作表 命令。
等效 API 调用： https://developers.workiva.com/spreadsheets-v1/spreadsheets-createsheet/
属性
| 摘要信息 | 详细信息 |
|---|---|
| 电子表格ID | 输入要添加工作表的电子表格的唯一标识符。 |
| 姓名 | 输入一个唯一的名称，以帮助识别工作表。 |
| 纸张索引 | 输入电子表格中新工作表的索引。注： 默认情况下，该命令将工作表添加为顶页。 |
| 母纸张 ID | 输入要在其下创建工作表的父工作表 ID。要添加到根电子表格中，请留空。 |
输出
| 输出 | 输出类型 |
|---|---|
| 纸张元数据 | JSON |
退出代码
| 代码 | 类型 | 详细信息 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
创建电子表格
要创建新的电子表格，请使用 创建电子表格 命令。
等效 API 调用： https://developers.workiva.com/spreadsheets-v1/spreadsheets-createspreadsheet/
属性
| 摘要信息 | 详细信息 |
|---|---|
| 姓名 | 输入有助于识别电子表格的唯一名称。 |
输出
| 输出 | 输出类型 |
|---|---|
| 纸张元数据 | JSON |
退出代码
| 代码 | 类型 | 详细信息 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
创建表格
要在工作区创建新的 Wdata 表，请使用 Create table 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-createtable/
属性
| 摘要信息 | 详细信息 |
|---|---|
| 姓名 | 输入一个唯一的名称，以帮助识别表格。 |
| 描述 | 输入新表的描述。 |
| 类型 | 选择是创建数据表（或 fact）还是查找表（或 dimension）。 |
| 列 | 添加要包含在表格中的列：
|
输出
| 输出 | 输出类型 |
|---|---|
| 表格 | JSON |
退出代码
| 代码 | 类型 | 详细信息 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
删除文件
要从 Wdata 工作区删除文件，请使用 Delete file 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-deletefile/
属性
| 摘要信息 | 详细信息 |
|---|---|
| 文件 ID | 输入要删除文件的 ID。 |
输出
没有任何
退出代码
| 代码 | 类型 | 详细信息 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
删除透视图
要从工作区删除 Wdata 视图，请使用 Delete pivot view 命令。
等效 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 | 错误 | 错误 |
删除记录
该命令只能通过 Platform API 使用。要删除记录， 创建新记录编辑 端点。删除纸张
要从电子表格中删除工作表及其子工作表（递归），请使用删除工作表命令。属性
| 摘要信息 | 详细信息 |
|---|---|
| 电子表格ID | 输入要删除工作表的电子表格的唯一标识符。 |
| 纸张 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 | 错误 | 错误 |
编辑
该命令只能通过 Platform API 使用。要编辑记录，请使用 创建新记录编辑 端点。
将文件导出到电子表格
要将 Wdata 表中的数据集导出到新的或现有的电子表格中，请使用 Export file to spreadsheet 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-exportfiletospreadsheets/
属性
| 摘要信息 | 详细信息 |
|---|---|
| 文件 ID | 输入要导出的表数据集的 ID。 |
| 电子表格 URL | 输入要导出的电子表格的 URL。要创建新电子表格，请留空。 |
输出
| 输出 | 输出类型 |
|---|---|
| 纸张信息 | 文件 |
退出代码
| 代码 | 类型 | 详细信息 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
导出查询结果
要将 Wdata 查询结果导出到新的或现有的电子表格中，请使用 Export query result 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-exportqueryresulttospreadsheets/
属性
| 摘要信息 | 详细信息 |
|---|---|
| 查询结果 ID | 输入要导出的查询结果的 ID。 |
| 电子表格 URL |
输入要导出的电子表格的 URL。要创建新电子表格，请留空。 |
| 导出为数据集 |
选中后，数据将以连接数据集的形式导出，只能通过更新电子表格中的数据集来编辑单元格。 |
输出
没有任何
退出代码
| 代码 | 类型 | 详细信息 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
获取文件属性
要检索 Wdata 工作区中的文件属性，请使用 Get file properties 命令。
等效 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 | 错误 | 错误 |
获取记录
该命令只能通过 Platform API 使用。要获取一条记录，请使用 Retrieve a single record 端点。
获取记录
该命令只能通过 Platform API 使用。要获取多条记录，请使用 Retrieve a list of records 端点。
获取报告
要从组织的 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 | 错误 | 错误 |
获取纸张数据
要检索工作表指定区域内的所有数据，请使用 Get sheet data 命令。
等效 API 调用： https://developers.workiva.com/spreadsheets-v1/spreadsheets-getdata/
属性
| 摘要信息 | 详细信息 |
|---|---|
| 电子表格ID | 输入要获取数据的电子表格的唯一标识符。 |
| 纸张 ID/名称 | 输入要获取数据的工作表名称或唯一标识符。 |
| 地区 | 输入单元格或区域的 A1 风格表示法，如 [起始列][起始行]:[终止列][终止行]。要使范围在任何或所有方向上都不受限制，请删除相应的列或行。 |
| 价值风格 | 选择返回单元格原始值还是计算值。例如，如果一个单元格的值是 =1+:1，请选择 Raw 表示 =1+1，或选择 Calculated 表示计算值 2。 |
| 修订 | 输入要检索数据的工作表版本。对于当前版本，请输入 -1。 |
输出
| 输出 | 输出类型 |
|---|---|
| 行数 | 整数 |
| 数据 | 文件 |
退出代码
| 代码 | 类型 | 详细信息 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
获取工作表元数据
要检索电子表格中工作表的元数据，请使用 Get sheet metadata 命令。
等效 API 调用： https://developers.workiva.com/spreadsheets-v1/spreadsheets-getsheet/
属性
| 摘要信息 | 详细信息 |
|---|---|
| 电子表格ID | 输入要获取元数据的电子表格的唯一标识符。 |
| 纸张 ID/名称 | 输入要获取元数据的工作表名称或唯一标识符。 |
输出
| 输出 | 输出类型 |
|---|---|
| 纸张元数据 | JSON |
退出代码
| 代码 | 类型 | 详细信息 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
获取电子表格元数据
要检索电子表格的元数据，请使用 Get spreadsheet metadata 命令。
等效 API 调用： https://developers.workiva.com/spreadsheets-v1/spreadsheets-getspreadsheet/
属性
| 摘要信息 | 详细信息 |
|---|---|
| 电子表格ID | 输入要获取元数据的电子表格的唯一标识符。 |
输出
| 输出 | 输出类型 |
|---|---|
| 电子表格元数据 | JSON |
退出代码
| 代码 | 类型 | 详细信息 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
获取表元数据
要检索 Wdata 表的元数据，请使用 Get table metadata 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-gettable/
属性
| 摘要信息 | 详细信息 |
|---|---|
| 表格 ID | 输入要获取元数据的表的唯一标识符。 |
输出
| 输出 | 输出类型 |
|---|---|
| 表格 | JSON |
退出代码
| 代码 | 类型 | 详细信息 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
获取类型
该命令只能通过 Platform API 使用。要获取一条记录，请使用 Retrieve a single record 端点。
获取类型
该命令只能通过 Platform API 使用。要获取多个记录类型，请使用 Retrieve a list of types 端点。
<!-- 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 | 输入要导入数据的电子表格的完整 URL。 |
| 异步运行 | 要使命令异步运行，并且 而不是 等待导入完成后再继续链，请选中此复选框。 |
| 标记 | 要包含贵组织跟踪的数据元数据，请添加标签并选择其名称和值。 |
输出
| 输出 | 输出类型 |
|---|---|
| 文件导入 | JSON |
退出代码
| 代码 | 类型 | 详细信息 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
连接清单
要列出 Workiva 平台各功能之间的数据，请使用 List connections 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-listconnections/
| 摘要信息 | 详细信息 |
|---|---|
| 来源类型 | 使用下拉菜单，选择要提取数据的文件或项目类型。 |
| 目的地类型 | 使用下拉菜单，选择要发送数据的文件或项目类型。 |
| 来源 ID | 输入要从中提取数据的文件或项目的唯一标识符。 |
| 目的地标识 | 输入要发送数据的文件或项目的唯一标识符。 |
注意： 您的请求必须包含 源类型 + 源 ID 或 目的地类型 + 目的地 ID；如果其中一对不存在，请求将失败。
输出
| 输出 | 输出类型 |
|---|---|
| 连线 | JSON |
退出代码
| 代码 | 类型 | 详细信息 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
列出文件错误
要列出与文件相关的错误（如导入导致的错误），请使用 List file errors 命令。
等效 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 视图并检索其元数据，请使用 List pivot views 命令。
等效 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 查询的可用结果，请使用 List query results 命令。
等效 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 | 错误 | 错误 |
列表页
要列出电子表格中的所有工作表并检索其元数据，请使用 List sheets 命令。
等效 API 调用： https://developers.workiva.com/spreadsheets-v1/spreadsheets-getspreadsheet/
属性
| 摘要信息 | 详细信息 |
|---|---|
| 电子表格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 | 错误 | 错误 |
覆盖纸张数据
要清除工作表中的所有单元格并代之以文件中提供的值，请使用 Overwrite sheet data 命令。
等效 API 调用： https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatedata/
属性
| 摘要信息 | 详细信息 |
|---|---|
| 电子表格ID | 输入要覆盖工作表数据的电子表格的唯一标识符。 |
| 纸张 ID/名称 | 输入要覆盖数据的工作表名称或唯一标识符。 |
| 数据文件 | 输入包含要填充工作表数据的 CSV 文件。 |
| 分隔符号 | 输入 数据文件中使用的分隔符。 |
| 使用平台应用程序接口 | 要使用电子表格单元格值的 Entered in 格式，请选中此复选框。 |
输出
| 输出 | 输出类型 |
|---|---|
| 行书写 | 整数 |
| 写入的单元格 | 整数 |
退出代码
| 代码 | 类型 | 详细信息 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
发布电子表格
要在电子表格中发布链接，请使用 Publish spreadsheet 命令。
等效 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 | 错误 | 错误 |
刷新一批连接
要一次刷新多个连接，请使用 Refresh batch of connections 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-refreshbatch/
属性
| 摘要信息 | 详细信息 |
|---|---|
| 连线 |
切换以启用或禁用变量的使用。 启用时
|
| 连线 ID | 输入要刷新的连接的唯一标识符。 |
| 使用以前的源参数 | 选中该复选框可使用上一次运行的源参数；这将覆盖您指定的任何其他源参数。 刷新连接批次 "端点将忽略此输入。 |
| 来源参数 |
输入成功刷新时要发送给源的参数。 (如果启用 "使用以前的源参数"，这些参数将被忽略）。 |
| 使用以前的目的地参数 | 选中该复选框可使用上次运行的目标参数；这将覆盖您指定的任何其他目标参数。 刷新连接批次 "端点将忽略此输入。 |
| 目的地参数 |
输入成功刷新后要发送到目的地的参数。 (如果启用 "使用以前的目的地参数"，这些参数将被忽略）。 |
输出
| 输出 | 输出类型 |
|---|---|
| 批量刷新状态 | JSON |
退出代码
| 代码 | 类型 | 详细信息 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
移除边缘
该命令只能通过 Platform API 使用。要删除边缘，请使用 创建新记录编辑 端点。
检索记录列表
要返回符合所提供筛选条件的记录列表，请使用 Retrieve a list of records 命令。始终需要至少一个过滤器。
等效 API 调用： https://developers.workiva.com/platform-v1/platform-getrecords/
属性
| 摘要信息 | 详细信息 |
|---|---|
| 展开 |
返回与主资源内联的相关资源。 选项：
|
| 筛选 | 用于筛选结果的属性。 |
输出
| 输出 | 输出类型 |
|---|---|
| 批量刷新状态 | JSON |
退出代码
| 代码 | 类型 | 详细信息 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
检索类型列表
要返回记录类型及其属性列表，请使用 Retrieve a list of types 命令。该命令可让您了解检索记录的预期结果。
等效 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 文件格式返回结果，请使用 Run report 命令。
等效 API 调用： https://developers.workiva.com/platform-v1/platform-getreportascsv/
属性
| 摘要信息 | 详细信息 |
|---|---|
| 报告 ID | 输入包含已保存报告的报告的唯一标识符。 |
| 预览内容 | 要在命令日志中包含报告结果预览，请选中此复选框。 |
输出
| 输出 | 输出类型 |
|---|---|
| 报表 | 文件 |
退出代码
| 代码 | 类型 | 详细信息 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
设置边缘
该命令只能通过 Platform API 使用。要设置边缘，请使用 创建新记录编辑 端点。
设置记录属性
该命令只能通过 Platform 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 | 错误 | 错误 |
更新选择列表
要更新多选查询参数值列表的属性或项目，请使用 更新选择列表 命令。
等效 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 | 输入要在其下创建工作表的父工作表 ID。要添加到根电子表格中，请留空。 |
输出
没有任何
退出代码
| 代码 | 类型 | 详细信息 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
更新电子表格元数据
要更新电子表格的元数据，请使用 更新电子表格元数据 命令。
等效 API 调用： https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatespreadsheet/
属性
| 摘要信息 | 详细信息 |
|---|---|
| 电子表格ID | 输入要更新元数据的电子表格的唯一标识符。 |
| 姓名 | 输入电子表格的新名称。 |
输出
没有任何
退出代码
| 代码 | 类型 | 详细信息 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
更新表格
要更新 Wdata 表的列，请使用 Update table 命令。
等效 API 调用： https://developers.workiva.com/wdata-v1/wdata-updatetable/
属性
| 摘要信息 | 详细信息 |
|---|---|
| 表格 ID | 输入要更新的表的唯一标识符。 |
| 姓名 | 输入要更新的表的名称。 |
| 描述 | 输入要更新表格的描述。 |
| 类型 | 选择是否更新数据-或 事实-或查找-或 维度-表 |
| 列 | 添加要更新表格的列。为每一列输入名称、数据类型、别名和说明。Mode，保留默认值 Nullable。 |
输出
| 输出 | 输出类型 |
|---|---|
| 表格 | JSON |
退出代码
| 代码 | 类型 | 详细信息 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |
写入纸张数据
要将 CSV 数据集中的数据写入工作表的特定区域，请使用 Write sheet data 命令。
等效 API 调用： https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatedata/
属性
| 摘要信息 | 详细信息 |
|---|---|
| 电子表格ID | 输入要写入数据的电子表格的唯一标识符。 |
| 纸张 ID/名称 | 输入要写入数据的工作表的唯一标识符。 |
| 数据文件 | 输入包含要写入工作表的数据的 CSV 文件。数据的范围 不得超过区域。 |
| 分隔符号 | 输入 数据文件中使用的分隔符。 |
| 地区 | 输入工作表中要写入数据的单元格或单元格区域的 A1 表示形式。要使范围在任何或所有方向上都不受限制，请将相应的列或行留空。 |
| 使用异步 |
若要异步加载数据（如大型数据集），请选中此复选框。 注意：使用异步时，必须添加自己的轮询以确定作业的状态。 |
| 使用平台应用程序接口 |
要使用 Region 单元格值的ntered-in 格式，请选中此复选框。 这将强制命令使用 更新范围端点 中的值，而不是电子表格 API 的 将数据写入区域端点。 注意：使用平台 API 时，该命令将始终异步运行。您必须添加自己的轮询来确定任务的状态。 |
输出
| 输出 | 输出类型 |
|---|---|
| 已写行数 | 整数 |
| 写入的单元格 | 整数 |
退出代码
| 代码 | 类型 | 详细信息 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | 错误 | 错误 |