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.
Connection Properties
To enable these commands, an IT admin first creates an OAuth2 grant associated with a Workiva integration user, creates a Workiva connection, and configures its credentials and properties:
| Input |
Detail |
| ID |
Enter the randomly generated ID in the OAuth2 grant used to identify the integration user |
| Secret |
Enter the randomly generated secret in the OAuth2 grant used to identify the integration user |
| Cerebral Host Override |
To override the URL host and base path when running in test environments, enter the host to use for the Wdata API |
| Spreadsheets Host Override |
To override the URL host and base path when running in test environments, enter the host to use for the Spreadsheets API |
| IAM Host Override |
To override the URL host and base path when running in test environments, enter the host to use for the IAM API |
| Admin Host Override |
To override the URL host and base path when running in test environments, enter the host to use for the Admin API |
| GraphDB Host Override |
To override the URL host and base path when running in test environments, enter the host to use for the GraphDB API |
Note: All sensitive credentials are automatically encrypted and stored at 2,048-bit encryption.
Clear Sheet Data
Clears all data in a Wdesk spreadsheet
Inputs
| Input |
Detail |
| Spreadsheet ID |
Enter the unique identifier for the spreadsheet to clear |
| Sheet ID/Name |
Enter the name or unique identifier of the sheet with the spreadsheet to clear |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error |
Create File
Uploads a CSV, JSON, or ZIP file, and lists its records. You can also upload the URL to the file, such as an 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
GET request.
Note: All files uploaded must have a .CSV or .JSON extension.
Inputs
| Input |
Detail |
| Table ID |
Enter the ID of the table to list the files of |
| File |
Enter the file to upload. Ignored if the Download URL input is set. |
| Name |
If the Download URL input is set, enter the name of the downloaded file. By default, the base name of the Download URL input. |
| Download URL |
Enter the URL that points to the file to download, such as an Amazon S3®-signed URL. Optional if the File input is set. The command makes a simple GET request against the URL, with no authentication. |
Outputs
| Output |
Output Type |
| Results |
JSON |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error |
Create Pivot View
Given a query and query result, creates a new pivot view
Inputs
| Input |
Detail |
| Name |
Enter the unique name of the pivot 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 pivot 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
Creates a temporary preview query on a table that can then be executed
Inputs
| Input |
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
Creates a new query
Inputs
| Input |
Detail |
| Name |
Enter the unique name of the query |
| Description |
Enter the 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 would be entered in the SQL Editor, as Presto SQL syntax |
| Temporary |
To generate the query only temporarily, and not show it 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
Creates a new record in your organization's SOX and Internal Audit database account
Inputs
| Input |
Detail |
| Record Kind |
Enter the kind of record to create |
| Properties |
Enter the properties to set or change on the record |
Outputs
| Output |
Output Type |
| Edit Reference |
File |
| Record ID |
String |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error |
Create Sheet
Adds a new sheet to a spreadsheet
Inputs
| Input |
Detail |
| Spreadsheet ID |
Enter the unique identifier of the sheet to add the spreadsheet to |
| Name |
Enter the unique name of the sheet to add the spreadsheet to |
| Sheet Index |
The index of the new sheet within the spreadsheet. 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
Creates a new spreadsheet
Inputs
| Input |
Detail |
| Name |
Enter the unique name of the spreadsheet to create |
Outputs
| Output |
Output Type |
| Sheet Metadata |
JSON |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error |
Create Table
Creates a new table in your workspace
Inputs
| Input |
Detail |
| Name |
Enter the unique name of the new table |
| Description |
Enter a description of the new table |
| Type |
Select whether to create a Data or Lookup table |
| Columns |
Add the columns to include in the table. 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 |
Delete File
Deletes a file from your workspace
Inputs
| Input |
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
Deletes a pivot view within the specified ID
Inputs
| Input |
Detail |
| ID |
Enter the ID of the pivot view to delete |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error |
Delete Query
Deletes a query within the specified ID
Inputs
| Input |
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
Deletes a record from your organization's SOX and Internal Audit database account
Inputs
| Input |
Detail |
| Record ID |
Enter the unique identifier of the record to delete |
Outputs
| Output |
Output Type |
| Edit Reference |
File |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error |
Delete Sheet
Deletes a sheet and all of its child sheets (recursively)
Inputs
| Input |
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
Deletes a spreadsheet
Inputs
| Input |
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
Deletes a table from your workspace
Inputs
| Input |
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
Downloads a file from your workspace
Inputs
| Input |
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
Downloads the content from a query result to a file
Inputs
| Input |
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
Submits a list of changes to make to records in your organization's SOX and Internal Audit database account. Changes can include any combination of creating records or setting or deleting their attributes or relationships.
Note: This command applies the changes as a single transaction—either all or none of the changes are applied.
Inputs
| Input |
Detail |
| Data Payload |
Enter the JSON payload of the data to upload.
Note: Don't include the data key. This command places the payload in the data key of the JSON payload object.
|
Outputs
| Output |
Output Type |
| Edit Reference |
File |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error |
Export File to Spreadsheet
Exports a file to a new or existing Wdesk spreadsheet
Inputs
| Input |
Detail |
| File ID |
Enter the ID of the file 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
Exports a query result to a new or existing Wdesk spreadsheet
Inputs
| Input |
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. |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error |
Get File Properties
Gets the properties of file in your Wdata workspace
Inputs
| Input |
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
Gets the metadata of a pivot view
Inputs
| Input |
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
Gets the metadata of a query
Inputs
| Input |
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
Retrieves a single record from your organization's SOX and Internal Audit database account
Inputs
| Input |
Detail |
| Record ID |
Enter the universally unique identifier (UUID) or other unique string of the record to retrieve |
| Include Incoming |
To include incoming relationships with the record, check this box |
| Include Outgoing |
To include outgoing relationships with the record, check this box |
Outputs
| Output |
Output Type |
| Record |
File |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error |
Get Records
Retrieves records from your organization's SOX and Internal Audit database account
Inputs
| Input |
Detail |
| Filters |
Enter the property values of the records to retrieve |
| Include Incoming |
To include incoming relationships with the records, check this box |
| Include Outgoing |
To include outgoing relationships with the records, check this box |
Outputs
| Output |
Output Type |
| Records |
File |
| Record Count |
Integer |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error |
Get Reports
Retrieves all reports from your organization's SOX and Internal Audit database account
Inputs
None
Outputs
| Output |
Output Type |
| Reports |
File |
| Report Count |
Integer |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error |
Get Sheet Data
Fetches all of the data in a specified region of a sheet
Inputs
| Input |
Detail |
| Spreadsheet ID |
Enter the unique identifier of the spreadsheet 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]. The range may be unbounded in any or all directions by leaving 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. |
Outputs
| Output |
Output Type |
| Row Count |
Integer |
| Data |
File |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error |
Get Sheet Metadata
Gets the metadata of a sheet in a spreadsheet
Inputs
| Input |
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
Returns the metadata of a spreadsheet
Inputs
| Input |
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
Returns the metadata of a table
Inputs
| Input |
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
Retrieves the definition for a specific record type in your organization's SOX and Internal Audit database account
Inputs
| Input |
Detail |
| Include Incoming |
To include incoming relationships with the type, check this box |
| Include Outgoing |
To include outgoing relationships with the type, check this box |
| Type Name |
Enter the name of the type to retrieve |
Outputs
| Output |
Output Type |
| Type |
File |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error |
Get Types
Retrieves the definitions of the different record types in your organization's SOX and Internal Audit database account
Inputs
| Input |
Detail |
| Filters |
Enter the property values of the record types to retrieve |
| Include Incoming |
To include incoming relationships with the types, check this box |
| Include Outgoing |
To include outgoing relationships with the types, check this box |
Outputs
| Output |
Output Type |
| Types |
File |
| Type Count |
Integer |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error |
Health Check
Checks the health of the Wdata API
Inputs
None
Outputs
| Output |
Output Type |
| Response |
JSON |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error |
Import File into Table
Imports a data file into a table
Inputs
| Input |
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 asynchonously 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
Imports a spreadsheet into a table and returns a file meta result
Inputs
| Input |
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 asynchonously 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 File Errors
Lists errors associated with a file, usually due to an import
Inputs
| Input |
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
Given a table, retrieves a list of its files and their metadata
Inputs
| Input |
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
Lists the pivot views in your workspace, and retrieves their metadata
Inputs
None
Outputs
| Output |
Output Type |
| Pivot Views |
JSON |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error |
List Queries
Lists the queries in your workspace, and retrieves their metadata
Inputs
None
Outputs
| Output |
Output Type |
| Queries |
JSON |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error |
List Query Results
Lists the available results for a query
Inputs
| Input |
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 Sheets
Lists all sheets in a spreadsheet, and retrieves their metadata
Inputs
| Input |
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
Lists all tables and their metadata in your workspace
Inputs
None
Outputs
| Output |
Output Type |
| Table List |
JSON |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error |
List Users
Returns a list of details about the organization's users. 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
Inputs
| Input |
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
Clears all cells in a sheet, and replaces the sheet with the values provided in the file
Inputs
| Input |
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 the Data File input |
Outputs
| Output |
Output Type |
| Row Written |
Integer |
| Cells Written |
Integer |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error |
Remove Edge
Removes an edge on a record in your SOX & Internal Audit database
Inputs
| Input |
Detail |
| Record ID |
Enter the unique identifier of the record to change |
| Target ID |
Enter the unique identifier of the associated record |
| Label |
Enter the label of the edge to remove |
Outputs
| Output |
Output Type |
| Edit Reference |
File |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error |
Run Query
Runs a query and immediately returns its result entity, which has an ID that can be used to download and export the results
Inputs
| Input |
Detail |
| Query ID |
Enter the ID of the query to run |
| Parameters |
If the query has parameters defined, enter their values |
| Run Asynchronously |
To run the query asynchronously, and not wait until the query finishes to complete the command, check this box |
Outputs
| Output |
Output Type |
| Query Result |
JSON |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error |
Run Report
Executes a saved report in your organization's SOX and Internal Audit database account and returns its results as a CSV file
Inputs
| Input |
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
Sets the edge on a record in your organization's SOX and Internal Audit database account
Inputs
| Input |
Detail |
| Record ID |
Enter the unique identifier of the record to change |
| Target ID |
Enter the unique identifier of the record to associate |
| Label |
Enter the label for the edge |
Outputs
| Output |
Output Type |
| Edit Reference |
File |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error |
Set Record Properties
Sets the properties on a record in your organization's SOX and Internal Audit database account
Inputs
| Input |
Detail |
| Record ID |
Enter the unique identifier of the record to change |
| Properties |
Enter the properties to set or change on the record |
Outputs
| Output |
Output Type |
| Edit Reference |
File |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error |
Un-import File from Table
Un-imports and removes a file from a table
Inputs
| Input |
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
Updates the metadata of a pivot view
Inputs
| Input |
Detail |
| ID |
Enter the ID of the pivot view to update |
| Name |
Enter the unique name of the pivot view |
| Query ID |
Enter the ID of the query to create the pivot view from |
| Query Result ID |
Enter the ID of the query result to create the pivot view from |
| Additional Metadata |
Enter the user-defined metadata to attach to the pivot 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
Updates the properties of an existing query
Inputs
| Input |
Detail |
| Query ID |
Enter the ID of the query to update |
| Name |
Enter the unique name of the query |
| Description |
Enter the 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 defined in the SQL Editor, in the Presto SQL syntax |
| Temporary |
To generate the query only temporarily, and not show it 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 Sheet Metadata
Updates a metadata of a sheet in a spreadsheet
Inputs
| Input |
Detail |
| Spreadsheet ID |
Enter the unique identifier of the spreadsheet wit 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 unique name of the sheet |
| Sheet Index |
Enter the index of the new sheet in the list of sheets. By default, the commands at 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
Updates a spreadsheet's metadata
Inputs
| Input |
Detail |
| Spreadsheet ID |
Enter the unique identifier of the spreadsheet wit the sheet to update metadata in |
| Name |
Enter the unique name of the spreadsheet |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error |
Update Table
Updates a table with the information specified
Inputs
| Input |
Detail |
| Table ID |
Enter the unique identifier of the table to update |
| Name |
Enter the unique name of the table to update |
| Description |
Enter a description of the table to update |
| Type |
Select whether to update a data or lookup 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 |