To automate tasks within the Workiva platform as part of a chain, such as to enable the exchange of data with other data sources, add a step that includes a Workiva connection command.
To enable these commands, an IT admin first sets up a Workiva connector.
Clear sheet data
To clear all data in a sheet, use a Clear sheet data command.
Equivalent API call: https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatedataasync/
Properties
| Property | Detail |
|---|---|
| Spreadsheet ID | Enter the unique identifier for the spreadsheet with the sheet to clear. |
| Sheet ID/name | Enter the name or unique identifier of the sheet to clear. |
Outputs
None
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Create file
To upload a comma-separated values (CSV), Javascript object notation (JSON), or compressed ZIP file and lists its records, use a Create file command. You can also upload the URL to the file, such as an Amazon S3®-signed URL to a file in an S3 bucket.
- If a JSON file, it must have a single JSON record per line—a JSON file is a series of JSON objects delimited by a newline character.
- If a ZIP file, it must contain a single CSV or JSON file, whose name is used to name the imported file. Downloading the file again downloads the source.
- If a URL, the endpoint makes a request to get a file using a simple unauthenticated
GETrequest.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-uploadfile/
Properties
| Property | Detail |
|---|---|
| Table ID | Enter the ID of the table to list the files of. |
| File | Enter the file to upload. Ignored if Download URL is entered.
Note: The file must have a .CSV or .JSON extension, or be a ZIP file that contains a file with a .CSV or .JSON extension. |
| Name | If Download URL is entered, enter the name of the file to upload; by default, the base name of Download URL. |
| Download URL | Enter the URL that points to the file to download, such as an Amazon S3-signed URL. Optional if File is entered.
Note: The command makes a simple
|
Outputs
| Output | Output Type |
|---|---|
| Results | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Create new record edits
To create new record edits given the supplied properties, use a Create new record edits command. Each edit requires at least an operation and targetId.
Limits:
- Up to 1000 edits may be processed per request.
Equivalent API call: https://developers.workiva.com/platform-v1/platform-createedits/
Properties
| Property | Detail |
|---|---|
| Operation |
Select the operation to carry out. Options:
|
| Label | Enter a label describing the relationship between the two records. Used to create or delete a relationship. |
| Properties | Enter the properties related to the record type. Used to create a record or set its properties. |
| Record ID | Enter the ID or temporary record ID of the source. Used to create or delete a relationship. |
| Target ID | Enter the ID of the target record. If creating a record, you can use either the record ID or the temporary record ID; if deleting a record, you must use the actual record ID. |
| Temporary record ID | Enter the temporary ID that will be used when creating a record; this temporary ID is replaced at the time of processing. You can use this ID within the same request to create relationships between created records. |
| Type | Enter the type of record to create. |
Outputs
| Output | Output Type |
|---|---|
| Pivot view | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Create pivot view
To create a new Wdata view given its query and query result, use a Create pivot view command.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-createpivotview/
Properties
| Property | Detail |
|---|---|
| Name | Enter a unique name to help identify the view. |
| Query ID | Enter the ID of the query to create the view from. |
| Query result ID | Enter the ID of the query result to create the view from. |
| Additional metadata | Enter the user-defined metadata to attach to the view as a JSON object (optional). |
Outputs
| Output | Output Type |
|---|---|
| Pivot view | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Create preview query
To create a temporary preview query on a table that can then be executed, use a Create preview query command.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-previewqueryusingpost/
Properties
| Property | Detail |
|---|---|
| Table ID | Enter the ID of the table to query. |
| Limit | Enter the maximum number of results to return. |
| File | If specified, enter the name of the file in the table to query. |
Outputs
| Output | Output Type |
|---|---|
| Query | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Create query
To create a new Wdata query, use a Create query command.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-createquery/
Properties
| Property | Detail |
|---|---|
| Name | Enter a unique name to help identify the query. |
| Description | Enter a description of the query. |
| Primary result ID | If specified, enter the ID of the default result to populate with the query results. |
| Query text | Enter the query definition as Presto SQL syntax, as you would in the query's SQL Editor. |
| Temporary | To generate the query temporarily so it does not appear in your workspace, check this box. |
| Parameters | Enter the parameters required to run the query. |
Outputs
| Output | Output Type |
|---|---|
| Query | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Create record
This command is only available through the Platform API. To create a new record, use the Create new record edits endpoint.
Create select list
To create a list of values for a multi-select query parameter, use a Create select list command.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-createselectlist/
Properties
| Property | Detail |
|---|---|
| Name | Enter a unique name to help identify the select list. |
| Description | To help further identify the select list, enter a description of its values or parameter. |
| Value type | Select the data type of the list's values, such as string or integer. |
| Values | Enter the list's values. |
Outputs
| Output | Output Type |
|---|---|
| Create select list metadata | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error |
Error |
Create sheet
To add a new sheet to a spreadsheet, use a Create sheet command.
Equivalent API call: https://developers.workiva.com/spreadsheets-v1/spreadsheets-createsheet/
Properties
| Property | Detail |
|---|---|
| Spreadsheet ID | Enter the unique identifier of the spreadsheet to add the sheet to. |
| Name | Enter a unique name to help identify the sheet. |
| Sheet index | Enter the index of the new sheet within the spreadsheet.
Note: By default, the command adds the sheet as the top sheet. |
| Parent sheet ID | Enter the ID of the parent sheet to create the sheet under. To add to the root spreadsheet, leave blank. |
Outputs
| Output | Output Type |
|---|---|
| Sheet metadata | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Create spreadsheet
To create a new spreadsheet, use a Create spreadsheet command.
Equivalent API call: https://developers.workiva.com/spreadsheets-v1/spreadsheets-createspreadsheet/
Properties
| Property | Detail |
|---|---|
| Name | Enter the unique name to help identify the spreadsheet. |
Outputs
| Output | Output Type |
|---|---|
| Sheet metadata | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Create table
To create a new Wdata table in your workspace, use a Create table command.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-createtable/
Properties
| Property | Detail |
|---|---|
| Name | Enter a unique name to help identify the table. |
| Description | Enter a description of the new table. |
| Type | Select whether to create a Data (or fact) or Lookup (or dimension) table. |
| Columns | Add the columns to include in the table:
|
Outputs
| Output | Output Type |
|---|---|
| Table | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Delete file
To delete a file from your Wdata workspace, use a Delete file command.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-deletefile/
Properties
| Property | Detail |
|---|---|
| File ID | Enter the ID of the file to delete. |
Outputs
None
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Delete pivot view
To delete a Wdata view from your workspace, use a Delete pivot view command.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-deletepivotview/
Properties
| Property | Detail |
|---|---|
| ID | Enter the ID of the view to delete. |
Outputs
None
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Delete query
To delete a Wdata query from your workspace, use a Delete query command.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-deletequery/
Properties
| Property | Detail |
|---|---|
| Query ID | Enter the ID of the query to delete. |
Outputs
None
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Delete record
This command is only available through the Platform API. To delete a record, Create new record edits endpoint.Delete sheet
To delete a sheet and its child sheets (recursively) from a spreadsheet, use a Delete sheet command.Properties
| Property | Detail |
|---|---|
| Spreadsheet ID | Enter the unique identifier of the spreadsheet with the sheet to delete. |
| Sheet ID/name | Enter the name or unique identifier of the sheet to delete. |
Outputs
None
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Delete spreadsheet
To delete a spreadsheet from your workspace, use a Delete spreadsheet command.
Equivalent API call: https://developers.workiva.com/spreadsheets-v1/spreadsheets-deletespreadsheet/
Properties
| Property | Detail |
|---|---|
| Spreadsheet ID | Enter the unique identifier of the spreadsheet to delete. |
Outputs
None
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Delete table
To delete a Wdata table from your workspace, use a Delete table command.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-deletetable/
Properties
| Property | Detail |
|---|---|
| Table ID | Enter the unique identifier of the table to delete |
Outputs
None
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Download file
To download a dataset from your Wdata workspace, use a Download file command.
Note: This command is not compatible with other object types such as spreadsheets, tables, or queries.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-downloadfile_1/
Properties
| Property | Detail |
|---|---|
| File ID | Enter the ID of the file to download. |
Outputs
| Output | Output Type |
|---|---|
| File | File |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Download query result
To download the results of a Wdata query to a file, use a Download query result command.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-downloadqueryresult/
Properties
| Property | Detail |
|---|---|
| Query result ID | Enter the ID of the query result to download. |
Outputs
| Output | Output Type |
|---|---|
| Query result | File |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Edit
This command is only available through the Platform API. To edit a record, use the Create new record edits endpoint.
Export file to spreadsheet
To export a dataset from a Wdata table to a new or existing spreadsheet, use an Export file to spreadsheet command.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-exportfiletospreadsheets/
Properties
| Property | Detail |
|---|---|
| File ID | Enter the ID of the table dataset to export. |
| Spreadsheet URL | Enter the URL of the spreadsheet to export to. To create a new spreadsheet, leave blank. |
Outputs
| Output | Output Type |
|---|---|
| Sheet info | File |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Export query result
To export a Wdata query result to a new or existing spreadsheet, use an Export query result command.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-exportqueryresulttospreadsheets/
Properties
| Property | Detail |
|---|---|
| Query result ID | Enter the ID of the query result to export. |
| Spreadsheet URL |
Enter the URL of the spreadsheet to export to. To create a new spreadsheet, leave blank. |
| Export as Dataset |
When checked, data will be exported as a connected dataset and the cells can only be edited by updating the dataset in the spreadsheet. |
Outputs
None
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Get file properties
To retrieve the properties of file in your Wdata workspace, use a Get file properties command.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-getfile/
Properties
| Property | Detail |
|---|---|
| File ID | Enter the ID of the file to get properties of. |
Outputs
| Output | Output Type |
|---|---|
| File properties | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Get pivot view
To retrieve the metadata of a Wdata view, use a Get pivot view command.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-getpivotview/
Properties
| Property | Detail |
|---|---|
| ID | Enter the ID of the pivot view to get metadata from. |
Outputs
| Output | Output Type |
|---|---|
| Pivot view | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Get query metadata
To retrieve the metadata of a Wdata query, use a Get query metadata command.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-getquery/
Properties
| Property | Detail |
|---|---|
| Query ID | Enter the ID of the query to get metadata from. |
Outputs
| Output | Output Type |
|---|---|
| Query | JSON |
Exit Codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Get record
This command is only available through the Platform API. To get a record, use the Retrieve a single record endpoint.
Get records
This command is only available through the Platform API. To get multiple records, use the Retrieve a list of records endpoint.
Get reports
To retrieve all reports from your organization's SOX and Internal Audit database account, use a Get reports command.
Equivalent API call: https://developers.workiva.com/platform-v1/platform-graphreportexport/
Properties
None
Outputs
| Output | Output Type |
|---|---|
| Reports | File |
| Report count | Integer |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Get select list
To retrieve a list of values for a multi-select query parameter based on the list's ID, use a Get select list command.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-getselectlist/
Properties
| Property | Detail |
|---|---|
| Select list ID | Enter the unique identifier of the select list to retrieve. |
Outputs
| Output | Output Type |
|---|---|
| Get select list payload | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Get sheet data
To retrieve all data in a specified region of a sheet, use a Get sheet data command.
Equivalent API call: https://developers.workiva.com/spreadsheets-v1/spreadsheets-getdata/
Properties
| Property | Detail |
|---|---|
| Spreadsheet ID | Enter the unique identifier of the spreadsheet with the sheet to get data from. |
| Sheet ID/name | Enter the name or unique identifier of the sheet to get data from. |
| Region | Enter the A1-style representation of a cell or range, such as [Start Column][Start Row]:[Stop Column][Stop Row]. To have the range unbounded in any or all directions, leave off the corresponding column or row. |
| Value style | Select whether to return the Raw or Calculated cell value. For example, if a cell's value is =1+:1, select Raw for =1+1, or Calculated for the calculated value of 2. |
| Revision | Enter the version of the sheet to retrieve data from. For the current version, enter -1. |
Outputs
| Output | Output Type |
|---|---|
| Row count | Integer |
| Data | File |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Get sheet metadata
To retrieve the metadata of a sheet in a spreadsheet, use a Get sheet metadata command.
Equivalent API call: https://developers.workiva.com/spreadsheets-v1/spreadsheets-getsheet/
Properties
| Property | Detail |
|---|---|
| Spreadsheet ID | Enter the unique identifier of the spreadsheet with the sheet to get metadata from. |
| Sheet ID/name | Enter the name or unique identifier of the sheet to get metadata from. |
Outputs
| Output | Output Type |
|---|---|
| Sheet metadata | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Get spreadsheet metadata
To retrieve the metadata of a spreadsheet, use a Get spreadsheet metadata command.
Equivalent API call: https://developers.workiva.com/spreadsheets-v1/spreadsheets-getspreadsheet/
Properties
| Property | Detail |
|---|---|
| Spreadsheet ID | Enter the unique identifier of the spreadsheet to get metadata from. |
Outputs
| Output | Output Type |
|---|---|
| Spreadsheet metadata | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Get table metadata
To retrieve the metadata of a Wdata table, use a Get table metadata command.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-gettable/
Properties
| Property | Detail |
|---|---|
| Table ID | Enter the unique identifier of the table to get metadata from. |
Outputs
| Output | Output Type |
|---|---|
| Table | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Get type
This command is only available through the Platform API. To get a record, use the Retrieve a single record endpoint.
Get types
This command is only available through the Platform API. To get multiple record types, use the Retrieve a list of types endpoint.
Health check
To check the health of the Wdata API, use a Health check command.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-healthcheck/
Properties
None
Outputs
| Output | Output Type |
|---|---|
| Response | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Import file into table
To import a file into a Wdata table, use an Import file into table command.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-importfile/
Properties
| Property | Detail |
|---|---|
| Table ID | Enter the ID of the table to import the file into. |
| File ID | Enter the ID of the file to import into the table. |
| Column mappings | Map each column in the file to the table's columns. |
| Run asynchronously | To have the command run asynchronously and not wait until the import is complete before continuing with the chain, check this box. |
| Tags | To include metadata your organization tracks about the data, add tags and select their names and values. |
Outputs
| Output | Output Type |
|---|---|
| File Import | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Import spreadsheet into table
To import a spreadsheet into a table and returns a file meta result, use an Import spreadsheet into table command.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-importfromspreadsheets/
Properties
| Property | Detail |
|---|---|
| Table ID | Enter the unique identifier of the table to import the file into. |
| File ID | Enter the unique identifier of the file to import the spreadsheet into (optional). |
| File name | Enter the unique name to give the file upon import into the table. |
| Spreadsheet URL | Enter the full URL of the spreadsheet to import data from. |
| Run asynchronously | To have the command run asynchronously and not wait until the import is complete before continuing with the chain, check this box. |
| Tags | To include metadata your organization tracks about the data, add tags and select their names and values. |
Outputs
| Output | Output Type |
|---|---|
| File Import | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
List connections
To list data between features of the Workiva platform, use a List connections command.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-listconnections/
| Property | Detail |
|---|---|
| Source Type | Using the dropdown menu, select the type of file or item to pull data from. |
| Destination Type | Using the dropdown menu, select the type of file or item to send data to. |
| Source ID | Enter the unique identifier of the file or item to pull data from. |
| Destination ID | Enter the unique identifier of the file or item to send data to. |
Note: Your request must contain either a Source Type + Source ID or a Destination Type + Destination ID; the request will fail if one of these pairs is not present.
Outputs
| Output | Output Type |
|---|---|
| Connections | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
List file errors
To list the errors associated with a file, such as due to an import, use a List file errors command.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-geterrors/
Properties
| Property | Detail |
|---|---|
| File ID | Enter the ID of the file to get errors for. |
Outputs
| Output | Output Type |
|---|---|
| Error list | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
List files
To retrieves a list of files in a Wdata table and their metadata, use a List files command.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-getfiles/
Properties
| Property | Detail |
|---|---|
| Table ID | Enter the ID of the table to get files from. |
Outputs
| Output | Output Type |
|---|---|
| Files list | File |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
List pivot views
To list the Wdata views in your workspace and retrieve their metadata, use a List pivot views command.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-listpivotviews/
Properties
None
Outputs
| Output | Output Type |
|---|---|
| Pivot views | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
List queries
To list the Wdata queries in your workspace and retrieve their metadata, use a List queries command.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-listqueries/
Properties
None
Outputs
| Output | Output Type |
|---|---|
| Queries | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
List query results
To list the available results for a Wdata query, use a List query results command.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-listqueryresults/
Properties
| Property | Detail |
|---|---|
| Query ID | Enter the ID of the query to get results from. |
Outputs
| Output | Output Type |
|---|---|
| Query results | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
List select lists
To list all lists of values for multi-select query parameters in your workspace and retrieve their metadata, use a List select lists command.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-listselectlists/
Properties
None
Outputs
| Output | Output Type |
|---|---|
| List select lists | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
List sheets
To list all sheets in a spreadsheet and retrieve their metadata, use a List sheets command.
Equivalent API call: https://developers.workiva.com/spreadsheets-v1/spreadsheets-getspreadsheet/
Properties
| Property | Detail |
|---|---|
| Spreadsheet ID | Enter the unique identifier of the spreadsheet to list the sheets of. |
Outputs
| Output | Output Type |
|---|---|
| Sheets | JSON |
| No. of sheets | Integer |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
List tables
To lists all Wdata tables in your workspace and retrieve their metadata, use a List tables command.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-gettables/
Properties
None
Outputs
| Output | Output Type |
|---|---|
| Table list | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
List users
To retrieve a list of details about an organization's users, use a List users command. Your assigned integration user must have the Org Admin role to execute this command.
Similar to an organization admin's "People View" export, the details are sorted by display name and include the users':
- Usernames
- Email addresses
- SAML IDs
- Last logins
- Workspace memberships
- Licenses and roles
Equivalent API call: https://developers.workiva.com/admin-v1/admin-getorgreportusers/
Properties
| Property | Detail |
|---|---|
| Organization ID | Enter the unique identifier of the organization to list users for. |
Outputs
| Output | Output Type |
|---|---|
| Users report | File |
| Record count | Integer |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Overwrite sheet data
To clear all cells in a sheet and replace them with the values provided in the file, use an Overwrite sheet data command.
Equivalent API call: https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatedata/
Properties
| Property | Detail |
|---|---|
| Spreadsheet ID | Enter the unique identifier of the spreadsheet to overwrite sheet data in. |
| Sheet ID/name | Enter the name or unique identifier of the sheet to overwrite data in. |
| Data file | Enter the CSV file containing the data to populate the sheet with. |
| Delimiter | Enter the delimiter used in Data File. |
| Use platform API | To use the Entered in format of the spreadsheet's cell values, check this box. |
Outputs
| Output | Output Type |
|---|---|
| Row written | Integer |
| Cells written | Integer |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Publish spreadsheet
To publish the links in a spreadsheet, use a Publish spreadsheet command.
Equivalent API call: https://developers.workiva.com/spreadsheets-v1/spreadsheets-publish/
Properties
| Property | Detail |
|---|---|
| Spreadsheet ID | Enter the unique identifier of the spreadsheet to publish. |
| Publish all links | Select which of the spreadsheet's links to publish:
|
Outputs
| Output | Output Type |
|---|---|
| Message | String |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Refresh connection
To refresh a specific connection based on its ID, use a Refresh connection command.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-refreshconnection/
Properties
| Property | Detail |
|---|---|
| Connection ID | Enter the unique identifier of the connection to refresh. |
| Use previous source parameters | Check this box to use the source parameters of the previous run; this overrides any other source parameters you've specified. This input will be ignored by the "Refresh batch of connections" endpoint. |
| Source parameters* |
Enter the parameters to send to the source on a successful refresh. (These parameters will be ignored if "Use previous source parameters" is enabled.) |
| Use previous destination parameters | Check this box to use the destination parameters of the previous run; this overrides any other destination parameters you've specified. This input will be ignored by the "Refresh batch of connections" endpoint. |
| Destination parameters* |
Enter the parameters to send to the destination on a successful refresh. (These parameters will be ignored if "Use previous destination parameters" is enabled.) |
Note: Multi-Select Parameters are not currently supported.
Outputs
| Output | Output Type |
|---|---|
| Refresh status | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Refresh batch of connections
To refresh multiple connections at once, use a Refresh batch of connections command.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-refreshbatch/
Properties
| Property | Detail |
|---|---|
| Connections |
Toggle to enable or disable the use of variables. When enabled:
|
| Connection ID | Enter the unique identifier of the connection to refresh. |
| Use previous source parameters | Check this box to use the source parameters of the previous run; this overrides any other source parameters you've specified. This input will be ignored by the "Refresh batch of connections" endpoint. |
| Source parameters |
Enter the parameters to send to the source on a successful refresh. (These parameters will be ignored if "Use previous source parameters" is enabled.) |
| Use previous destination parameters | Check this box to use the destination parameters of the previous run; this overrides any other destination parameters you've specified. This input will be ignored by the "Refresh batch of connections" endpoint. |
| Destination parameters |
Enter the parameters to send to the destination on a successful refresh. (These parameters will be ignored if "Use previous destination parameters" is enabled.) |
Outputs
| Output | Output Type |
|---|---|
| Batch refresh status | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Remove edge
This command is only available through the Platform API. To remove an edge, use the Create new record edits endpoint.
Retrieve a list of records
To return a list of records matching the provided filters, use the Retrieve a list of records command. At least one filter is always required.
Equivalent API call: https://developers.workiva.com/platform-v1/platform-getrecords/
Properties
| Property | Detail |
|---|---|
| Expand |
Returns related resources inline with the main resource. Options:
|
| Filter | The properties to filter the results by. |
Outputs
| Output | Output Type |
|---|---|
| Batch refresh status | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Retrieve a list of types
To return a list of record types and their attributes, use the Retrieve a list of types command. This command lets you know what to expect retrieving records.
Equivalent API call: https://developers.workiva.com/platform-v1/platform-gettypes/
Properties
| Property | Detail |
|---|---|
| Expand |
Returns related resources inline with the main resource. Options:
|
Outputs
| Output | Output Type |
|---|---|
| Batch refresh status | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Retrieve a single record
To retrieve a single record, use the Retrieve a list of records command. The unique identifier is typically a UUID, but this can vary.
Equivalent API call: https://developers.workiva.com/platform-v1/platform-getrecordbyid/
Properties
| Property | Detail |
|---|---|
| Expand |
Returns related resources inline with the main resource. Options:
|
| Record ID | Enter the record's unique identifier. |
Outputs
| Output | Output Type |
|---|---|
| Batch refresh status | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Retrieve a single type
To retrieve a single record, use the Retrieve a list of records command. The unique identifier is typically a UUID, but this can vary.
Equivalent API call: https://developers.workiva.com/platform-v1/platform-gettypebyid/
Properties
| Property | Detail |
|---|---|
| Expand |
Returns related resources inline with the main resource. Options:
|
| Record ID | Enter the record's unique identifier. |
Outputs
| Output | Output Type |
|---|---|
| Batch refresh status | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Run query
To run a Wdata query and retrieve its results, use a Run query command.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-runquery/
Properties
| Property | Detail |
|---|---|
| Query ID | Enter the ID of the query to run. |
| Parameters | If the query has parameters defined, add a map of their names and values.
Note: Enter the values of any multi-select parameters in Multi-select params. |
| Run asynchronously | To run the query asynchronously, and not wait until the query finishes to complete the command, check this box. |
| Multi-select params | If the query has multi-select parameters defined, add the name and values of each. |
Outputs
| Output | Output Type |
|---|---|
| Query result | JSON |
Note: The Query Result output includes an ID, which can be used to download and export the results.
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Run report
To run a saved report in your organization's SOX and Internal Audit database account and return its results as a CSV file, use a Run report command.
Equivalent API call: https://developers.workiva.com/platform-v1/platform-getreportascsv/
Properties
| Property | Detail |
|---|---|
| Report ID | Enter the unique identifier of the report that contains the saved report. |
| Preview content | To include a preview of the report's results in the command's log, check this box. |
Outputs
| Output | Output Type |
|---|---|
| Report | File |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Set edge
This command is only available through the Platform API. To set an edge, use the Create new record edits endpoint.
Set record properties
This command is only available through the Platform API. To set record properties, use the Create new record edits endpoint.
Un-import file from table
To un-import and remove a file from a Wdata table, use an Un-import file From table command.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-unimportfile/
Properties
| Property | Detail |
|---|---|
| Table ID | Enter the unique identifier of the table to remove the file from. |
| File ID | Enter the unique identifier of the file to remove from the table. |
Outputs
| Output | Output Type |
|---|---|
| File import | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Update pivot view
To update the metadata of a Wdata view, use an Update pivot view command.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-updatepivotview/
Properties
| Property | Detail |
|---|---|
| ID | Enter the ID of the view to update. |
| Name | Enter the new name of the view. |
| Query ID | Enter the ID of the query to create the view from. |
| Query result ID | Enter the ID of the query result to create the view from. |
| Additional metadata | Enter the user-defined metadata to attach to the view, as a JSON object (optional). |
Outputs
| Output | Output Type |
|---|---|
| Pivot view | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Update query definition
To update the properties of a Wdata query, use an Update query definition command.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-updatequery/
Properties
| Property | Detail |
|---|---|
| Query ID | Enter the ID of the query to update. |
| Name | Enter the new name of the query. |
| Description | Enter the new description of the query. |
| Primary result ID | If specified, enter the ID of the default result to populate with the query results. |
| Query text | Enter the query definition as Presto SQL syntax, like you would in the query's SQL Editor. |
| Temporary | To generate the query only temporarily so it does not appear in your workspace, check this box. |
| Parameters | Enter the parameters required to run the query. |
Outputs
| Output | Output Type |
|---|---|
| Query | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Update select list
To update the properties or items for a list of values for a multi-select query parameter, use an Update select list command.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-updateselectlist/
Properties
| Property | Detail |
|---|---|
| ID | Enter the ID of the select list to update. |
| Name | Enter the new name of the select list. |
| Description | Enter the new description of the select list. |
| Value type | Select the data type of the list's values, such as string or integer. |
| Values | Enter the list's values, including any updates. |
Outputs
| Output | Output Type |
|---|---|
| Update select list | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Update sheet metadata
To update a metadata of a sheet in a spreadsheet, use an Update sheet metadata command.
Equivalent API call: https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatesheet/
Properties
| Property | Detail |
|---|---|
| Spreadsheet ID | Enter the unique identifier of the spreadsheet with the sheet to update metadata in. |
| Sheet ID/name | Enter the name or unique identifier of the sheet to update metadata in. |
| Name | Enter the new name of the sheet. |
| Sheet index | Enter the new index of the sheet in the spreadsheet. By default, the commands updates the sheet as the top sheet. |
| Parent sheet ID | Enter the ID of the parent sheet to create the sheet under. To add to the root spreadsheet, leave blank. |
Outputs
None
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Update spreadsheet metadata
To update a spreadsheet's metadata, use an Update spreadsheet metadata command.
Equivalent API call: https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatespreadsheet/
Properties
| Property | Detail |
|---|---|
| Spreadsheet ID | Enter the unique identifier of the spreadsheet with the sheet to update metadata in. |
| Name | Enter the new name of the spreadsheet. |
Outputs
None
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Update table
To update a Wdata table's columns, use an Update table command.
Equivalent API call: https://developers.workiva.com/wdata-v1/wdata-updatetable/
Properties
| Property | Detail |
|---|---|
| Table ID | Enter the unique identifier of the table to update. |
| Name | Enter the name of the table to update. |
| Description | Enter a description of the table to update. |
| Type | Select whether to update a Data—or fact—or Lookup—or dimension—table |
| Columns | Add the columns to update the table with. For each column, enter its name, data type, alias, and description. For Mode, leave the default of Nullable. |
Outputs
| Output | Output Type |
|---|---|
| Table | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Write sheet data
To write data in a CSV data set to a specific region of a sheet, use a Write sheet data command.
Equivalent API call: https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatedata/
Properties
| Property | Detail |
|---|---|
| Spreadsheet ID | Enter the unique identifier of the spreadsheet with the sheet to write data to. |
| Sheet ID/name | Enter the unique identifier of the sheet to write data to. |
| Data file | Enter the CSV file with the data to write to the sheet. The range of the data must not exceed the Region. |
| Delimiter | Enter the delimiter used in Data File. |
| Region | Enter an A1 representation of the cell or range of cells in the sheet to write the data to. To have the range unbounded in any or all directions, leave the corresponding column or row blank. |
| Use async |
To load the data asynchronously, such as for a large dataset, check this box. Note: When using async, you must add your own polling to determine the status of the job. |
| Use platform API |
To use the entered-in format of the Region cell values, check this box. This will force the command to use the update values in a range endpoint rather than the spreadsheet API's write data to a region endpoint. Note: This command will always run asynchronously when using the platform API. You must add your own polling to determine the status of the job. |
Outputs
| Output | Output Type |
|---|---|
| Rows written | Integer |
| Cells written | Integer |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |