Table of Contents

Connections

Commands

Connections

Workiva

A connector to the Workiva APIs

Inputs

Input

Type

Detail

Notes

ID

TextField

The randomly generated ID in your OAuth2 Grant that is used to identify the integration user

Secret

TextField

The randomly generated Secret in your OAuth2 Grant that is used to authenticate the integration user

Cerebral Host Override

TextField

OPTIONAL: Use this field to override the URL host and base path for the Cerebral API when running in test environments

Spreadsheets Host Override

TextField

OPTIONAL: Use this field to override the URL host and base path for the Spreadsheets API when running in test environments

IAM Host Override

TextField

OPTIONAL: Use this field to override the URL host and base path for the IAM API when running in test environments

Admin Host Override

TextField

OPTIONAL: Use this field to override the URL host and base path for the Admin API when running in test environments

Graph DB Host Override

TextField

OPTIONAL: Use this field to override the URL host and base path for the Graph DB API when running in test environments

Commands

Clear Sheet Data

Clears all data in a sheet.

Inputs

Input

Type

Detail

Notes

Spreadsheet ID

TextField

A unique identifier for a spreadsheet

Sheet ID/Name

TextField

A unique identifier for a sheet within a spreadsheet

Outputs

None

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Error.

Create File

Accepts CSV/JSON file or a ZIP file with a single CSV or JSON file contained within. The file in the ZIP file must be CSV or JSON file and the name of the CSV or JSON is used to name the imported file. Downloading this file again will download the source. It is also possible to upload a url to a file to be downloaded instead of a file itself. This endpoint will then make a request to get the file using a simple unauthenticated GET request. An example URL would be an S3 signed url to a file in an S3 bucket. Note that all files uploaded must have a .csv or .json extension. JSON files are expected to have a single json record per line, in other words, a JSON file is a series of JSON objects delimited by a newline character.

Inputs

Input

Type

Detail

Notes

Table ID

TextField

The ID of the table this file will be associated with.

File

FileField

The file to upload. This input is ignored if Download URL is set.

Name

TextField

Sets the name of the file in Workiva. This defaults to the base name of the URL provided if Download URL is set, or the name of the file in the File input..

Download URL

TextField

An optional url that points to a file that should be downloaded. This value is required if the file param is not set. This endpoint makes a simple GET request against the URL with no authentication. An example would be an S3 signed url.

Outputs

Output

Output Type

Notes

Result

Json

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Error.

Create Pivot View

Creates a new pivot view from the given query and query result.

Inputs

Input

Type

Detail

Notes

Name

TextField

The name of the pivot view. Must be unique.

Query ID

TextField

The ID of the query to create the view from.

Query Result ID

TextField

The ID of the query result to create the view from.

Additional Metadata

MapField

User-defined metadata to attach to the pivot view. This is any arbitrary JSON object and is not required.

Outputs

Output

Output Type

Notes

Pivot View

Json

Exit Codes

Code

Type

Detail

0

Success

Wdata API is up and running.

1

Error

Error.

Create Preview Query

Creates a temporary preview query on a table that can then be executed.

Inputs

Input

Type

Detail

Notes

Table ID

TextField

The ID of the table to query.

Limit

NumberField

The the maximum number of results.

File

TextField

If specified, the name of the file in the table to query.

Outputs

Output

Output Type

Notes

Query

Json

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Error.

Create Query

Creates a new query.

Inputs

Input

Type

Detail

Notes

Name

TextField

The name of the query. Must be unique.

Description

TextField

The description of the query.

Primary Result ID

TextField

If specified, this is the ID of the result that you would like the results of the query to populate by default.

Query Text

TextField

The query definition as would be defined in Wdata in the Advanced Query Mode. The syntax of the query follows the Presto SQL syntax.

Temporary

BooleanField

If set to true, the query generated will only be temporarily available and will not show up in the queries tab of your Wdata workspace.

Parameters

GroupField

Define the parameters required to run this query.

Outputs

Output

Output Type

Notes

Query

Json

Exit Codes

Code

Type

Detail

0

Success

Wdata API is up and running.

1

Error

Error.

Create Record

Creates a new record

Inputs

Input

Type

Detail

Notes

Record Kind

TextField

The kind of Record to create

Properties

GroupField

The properties to set or change on the Record

Outputs

Output

Output Type

Notes

Edit Reference

File

Record ID

String

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully.

1

Error

Error.

Create Sheet

Creates a new sheet.

Inputs

Input

Type

Detail

Notes

Spreadsheet ID

TextField

A unique identifier for a spreadsheet

Name

TextField

The name of the sheet (Must be unique)

Sheet Index

NumberField

The index of the new sheet in the list of sheets. (Defaults to adding as the top sheet)

Parent Sheet Id

TextField

The ID of the parent sheet you would like this sheet to be created under. Leave blank to add to the root spreadsheet.

Outputs

Output

Output Type

Notes

Sheet Metadata

Json

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Error.

Create Spreadsheet

Creates a new spreadsheet.

Inputs

Input

Type

Detail

Notes

Name

TextField

The name of the sheet (Must be unique)

Outputs

Output

Output Type

Notes

Spreadsheet Metadata

Json

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Error.

Create Table

Creates a new table in your workspace

Inputs

Input

Type

Detail

Notes

Name

TextField

The name of the table. Must be unique.

Description

TextField

The description of the table.

Type

DropdownField

The type of table you are creating. May be a 'lookup' table or a 'data' table.

Columns

GroupField

Define the columns for the table.

Outputs

Output

Output Type

Notes

Table

Json

Exit Codes

Code

Type

Detail

0

Success

Wdata API is up and running.

1

Error

Error.

Delete File

Deletes a file in your Wdata workspace.

Inputs

Input

Type

Detail

Notes

File ID

TextField

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 with the specified ID.

Inputs

Input

Type

Detail

Notes

ID

TextField

The ID of the pivot view.

Outputs

None

Exit Codes

Code

Type

Detail

0

Success

Wdata API is up and running.

1

Error

Error.

Delete Query

Deletes a query with the specified ID.

Inputs

Input

Type

Detail

Notes

Query ID

TextField

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

Inputs

Input

Type

Detail

Notes

Record ID

TextField

The ID of the Record to delete

Outputs

Output

Output Type

Notes

Edit Reference

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully.

1

Error

Error.

Delete Sheet

Deletes a sheet and all of its child sheets (recursively).

Inputs

Input

Type

Detail

Notes

Spreadsheet ID

TextField

The unique identifier of the spreadsheet

Sheet ID/Name

TextField

The unique identifier of the sheet

Outputs

None

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Error.

Delete Spreadsheet

Deletes a spreadsheet.

Inputs

Input

Type

Detail

Notes

Spreadsheet ID

TextField

The unique identifier of the spreadsheet

Outputs

None

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Error.

Delete Table

Deletes a table in your workspace.

Inputs

Input

Type

Detail

Notes

Table ID

TextField

The ID 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 Wdata workspace

Inputs

Input

Type

Detail

Notes

File ID

TextField

The ID of the file to download.

Outputs

Output

Output Type

Notes

File

File

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Error.

Download Pivot View

Downloads the content of a pivot view.

Inputs

Input

Type

Detail

Notes

ID

TextField

The ID of the pivot view.

Outputs

Output

Output Type

Notes

Pivot View Content

File

Exit Codes

Code

Type

Detail

0

Success

Wdata API is up and running.

1

Error

Error.

Download Query Result

Download the contents of a query result to a file.

Inputs

Input

Type

Detail

Notes

Query Result ID

TextField

The ID of the query result.

Outputs

Output

Output Type

Notes

Query Result

File

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Error.

Edit

A generic edit command that accepts the JSON payload as described via the API (https://developers.workiva.com/workiva-graphdb/reference#edits-1)

Inputs

Input

Type

Detail

Notes

Data Payload

TextField

The payload of the edit. DO NOT include the "data" key, this payload will be placed into the "data" key of the JSON payload object.

Outputs

Output

Output Type

Notes

Edit Reference

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully.

1

Error

Error.

Export File to Spreadsheet

Exports a file in Wdata to the URL of the spreadsheet to export to, if present. If not present, a new spreadsheet will be created.

Inputs

Input

Type

Detail

Notes

File ID

TextField

The ID of the file to delete.

Spreadsheet URL

TextField

URL of the spreadsheet to export to, if present. If not present, a new spreadsheet will be created.

Outputs

Output

Output Type

Notes

Sheet info

Json

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Error.

Export Query Result

Exports a query result to the URL of the spreadsheet to export to, if present. If not present, a new spreadsheet will be created.

Inputs

Input

Type

Detail

Notes

Query Result ID

TextField

The ID of the query result.

Spreadsheet URL

TextField

The URL of the spreadsheet to export the query result to.

Outputs

None

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Error.

Get File Properties

Get the properties of a file in your Wdata workspace.

Inputs

Input

Type

Detail

Notes

File ID

TextField

The ID of the file to delete.

Outputs

Output

Output Type

Notes

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

Type

Detail

Notes

ID

TextField

The ID of the pivot view.

Outputs

Output

Output Type

Notes

Pivot View

Json

Exit Codes

Code

Type

Detail

0

Success

Wdata API is up and running.

1

Error

Error.

Get Query Metadata

Gets the metadata of a query.

Inputs

Input

Type

Detail

Notes

Query ID

TextField

The ID of the query.

Outputs

Output

Output Type

Notes

Query

Json

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Error.

Get Record

Retrieves a single record based on its unique identifier. This unique identifier usually is a UUID but may be a different unique string

Inputs

Input

Type

Detail

Notes

Record ID

TextField

The ID of the Record to retrieve

Include Incoming

BooleanField

Include incoming relationships with the record.

Include Outgoing

BooleanField

Include outgoing relationships with the record.

Outputs

Output

Output Type

Notes

Record

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully.

1

Error

Error.

Get Records

Retrieves records from the account

Inputs

Input

Type

Detail

Notes

Filters

GroupField

Filter the results on property values.

Include Incoming

BooleanField

Include incoming relationships with the types.

Include Outgoing

BooleanField

Include outgoing relationships with the types.

Outputs

Output

Output Type

Notes

Records

File

Record Count

Integer

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully.

1

Error

Error.

Get Reports

Retrieves available reports from the account

Inputs

None

Outputs

Output

Output Type

Notes

Reports

File

Report Count

Integer

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully.

1

Error

Error.

Get Sheet Data

Fetches all of the data in the specified region for a sheet.

Inputs

Input

Type

Detail

Notes

Spreadsheet ID

TextField

The unique identifier of the spreadsheet

Sheet ID/Name

TextField

The unique identifier of the sheet

Region

TextField

[Start Column][Start Row]:[Stop Column][Stop Row]A1 style representation of a cell or range. A range may be unbounded in any/all directions by leaving off the corresponding column or row.

Value Style

DropdownField

The style of cell value to return. For example, if a cell's value is =1+:1 Raw value =1+1 or use Calculated to get the calculated value 2

Revision

NumberField

The revision of the sheet to use. (Use the value -1 to get the latest revision)

Outputs

Output

Output Type

Notes

Row Count

Integer

Data

File

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Error.

Get Sheet Metadata

Gets the sheet metadata in a spreadsheet

Inputs

Input

Type

Detail

Notes

Spreadsheet ID

TextField

The unique identifier of the spreadsheet

Sheet ID/Name

TextField

The unique identifier of the sheet

Outputs

Output

Output Type

Notes

Sheet Metadata

Json

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Error.

Get Spreadsheet Metadata

Returns spreadsheet metadata

Inputs

Input

Type

Detail

Notes

Spreadsheet ID

TextField

The unique identifier of the spreadsheet

Outputs

Output

Output Type

Notes

Spreadsheet Metadata

Json

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Error.

Get Table Metadata

Gets the metadata of a table.

Inputs

Input

Type

Detail

Notes

Table ID

TextField

The ID of the table.

Outputs

Output

Output Type

Notes

Table

Json

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Error.

Get Type

Retrieves the definition for a specific type

Inputs

Input

Type

Detail

Notes

Include Incoming

BooleanField

Include incoming relationships with the types.

Include Outgoing

BooleanField

Include outgoing relationships with the types.

Type Name

TextField

The name of the Type to retrieve

Outputs

Output

Output Type

Notes

Type

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully.

1

Error

Error.

Get Types

Retrieves the definitions of the different record types in the account

Inputs

Input

Type

Detail

Notes

Filters

GroupField

Filter the results on property values.

Include Incoming

BooleanField

Include incoming relationships with the types.

Include Outgoing

BooleanField

Include outgoing relationships with the types.

Outputs

Output

Output Type

Notes

Types

File

Type Count

Integer

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully.

1

Error

Error.

Health Check

Checks the health of the Wdata API.

Inputs

None

Outputs

Output

Output Type

Notes

Response

Json

Exit Codes

Code

Type

Detail

0

Success

Wdata API is up and running.

1

Error

Error.

Import File into Table

Imports the provided file into the associated table.

Inputs

Input

Type

Detail

Notes

Table ID

TextField

The ID of the table to import the file into.

File ID

TextField

The ID of the file

Column Mappings

MapField

The column mappings of the import file to the table columns. This is only needed if the file headers do not match the table columns.

Run Asynchronously

BooleanField

If this is checked, the query will run asynchronously and will not wait until the query completes to complete this command.

Tags

MapField

Tags to associate with the import.

Outputs

Output

Output Type

Notes

File Import

Json

Exit Codes

Code

Type

Detail

0

Success

Wdata API is up and running.

1

Error

Error.

Import Spreadsheet into Table

Import spreadsheet data and immediately returns a file meta result.

Inputs

Input

Type

Detail

Notes

Table ID

TextField

The ID of the table to import the file into.

File ID

TextField

The ID of the file to import into. This is not required.

File Name

TextField

The name that is given to the file when imported to the table.

Spreadsheet URL

TextField

The full sheet URL of the sheet you would like to import. When viewing a sheet in Wdesk, this is the URL in the address bar of your browser.

Run Asynchronously

BooleanField

If this is checked, the query will run asynchronously and will not wait until the query completes to complete this command.

Tags

MapField

Tags to associate with the import.

Outputs

Output

Output Type

Notes

File Import

Json

Exit Codes

Code

Type

Detail

0

Success

Wdata API is up and running.

1

Error

Error.

List File Errors

Lists the errors associated with a file. These errors are usually do to an import.

Inputs

Input

Type

Detail

Notes

File ID

TextField

The ID of the file to list errors for.

Outputs

Output

Output Type

Notes

Error list

Json

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Error.

List Files

Retrieves a list of files and their metadata in the specified table.

Inputs

Input

Type

Detail

Notes

Table ID

TextField

The ID of the table of which to list the files.

Outputs

Output

Output Type

Notes

Files list (Deprecated)

Json

Files list

File

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Error.

List Pivot Views

List the pivot views in your workspace and retrieve the metadata.

Inputs

None

Outputs

Output

Output Type

Notes

Pivot Views (Deprecated)

Json

Pivot Views

File

Exit Codes

Code

Type

Detail

0

Success

Wdata API is up and running.

1

Error

Error.

List Queries

List the queries and their metadata in your workspace.

Inputs

None

Outputs

Output

Output Type

Notes

Queries (Deprecated)

Json

Queries

File

Exit Codes

Code

Type

Detail

0

Success

Wdata API is up and running.

1

Error

Error.

List Query Results

Lists the available results for a query.

Inputs

Input

Type

Detail

Notes

Query ID

TextField

The ID of the query.

Outputs

Output

Output Type

Notes

Query Results (Deprecated)

Json

Query Results

File

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Error.

List Sheets

Returns a list of all sheets in a spreadsheet and their metadata.

Inputs

Input

Type

Detail

Notes

Spreadsheet ID

TextField

The unique identifier of the spreadsheet

Outputs

Output

Output Type

Notes

Sheets (Deprecated)

Json

No. of Sheets

Integer

Sheets

File

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Error.

List Tables

List the tables and their metadata in your workspace.

Inputs

None

Outputs

Output

Output Type

Notes

Table List (Deprecated)

Json

Table list

File

Exit Codes

Code

Type

Detail

0

Success

Wdata API is up and running.

1

Error

Error.

List Users

Similar to an organization admin's "People View" export, this returns a list of specific details about the organization's users, including their usernames, display names, email addresses, SAML IDs, last logins, workspace memberships, licenses and roles. Results are sorted by displayName.

Inputs

Input

Type

Detail

Notes

Organization ID

TextField

The Organization Id

Outputs

Output

Output Type

Notes

Users Report

File

Record Count

Integer

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully.

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

Type

Detail

Notes

Spreadsheet ID

TextField

A unique identifier for a spreadsheet

Sheet ID/Name

TextField

A unique identifier for a sheet within a spreadsheet

Data File

FileField

The CSV data containing the data to populate the sheet

Delimiter

TextField

The delimiter of the CSV data provided

Start Cell

TextField

The starting cell to load the data into. The first column in the first row of the data will be loaded here and expand down and to the right accordingly.

Use Async

BooleanField

For large datasets you may need to load the data in an asynchronous fashion. In the future this will be the default.

Outputs

Output

Output Type

Notes

Rows Written

Integer

Cells Written

Integer

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Error.

Publish Spreadsheet

Publishes the links in a spreadsheet

Inputs

Input

Type

Detail

Notes

Spreadsheet ID

TextField

The unique identifier of the spreadsheet

Publish All Links

BooleanField

Whether to publish all links in the spreadsheet (available only as its owner), or only one's own links

Outputs

Output

Output Type

Notes

Message

String

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Error.

Remove edge

Removes an edge on a record.

Inputs

Input

Type

Detail

Notes

Record ID

TextField

The ID of the Record to change

Target ID

TextField

The ID of the record associated.

Label

TextField

The label of the edge.

Outputs

Output

Output Type

Notes

Edit Reference

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully.

1

Error

Error.

Run Query

Runs a query and immediately returns a query result entity. This entity has an id that can be used to download to export the results.

Inputs

Input

Type

Detail

Notes

Query ID

TextField

The ID of the query

Parameters

MapField

The parameter values. This is only needed if the query has parameters defined.

Run Asynchronously

BooleanField

If this is checked, the query will run asynchronously and will not wait until the query completes to complete this command.

Multi-select Params

GroupField

Parameters that have the type Multi-select

Outputs

Output

Output Type

Notes

Query Result

Json

Exit Codes

Code

Type

Detail

0

Success

Wdata API is up and running.

1

Error

Error.

Run Report

Executes a report, and returns the CSV. Use the ID of the record that contains the saved report for the reportID path element

Inputs

Input

Type

Detail

Notes

Report Id

TextField

The ID of the Report

Preview Content

BooleanField

If this is checked a preview of the report contents will be in the logs of the command.

Outputs

Output

Output Type

Notes

Report

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully.

1

Error

Error.

Set Edge

Sets an edge on a record.

Inputs

Input

Type

Detail

Notes

Record ID

TextField

The ID of the Record to change

Target ID

TextField

The ID of the record to associate.

Label

TextField

The label for the edge.

Outputs

Output

Output Type

Notes

Edit Reference

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully.

1

Error

Error.

Set Record Properties

Sets properties on a record

Inputs

Input

Type

Detail

Notes

Record ID

TextField

The ID of the Record to change

Properties

GroupField

The properties to set or change on the Record

Outputs

Output

Output Type

Notes

Edit Reference

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully.

1

Error

Error.

Un-import File from Table

Un-imports a file from a table a removes the file from the table.

Inputs

Input

Type

Detail

Notes

Table ID

TextField

The ID of the table to import the file into.

File ID

TextField

The ID of the file

Outputs

Output

Output Type

Notes

File Import

Json

Exit Codes

Code

Type

Detail

0

Success

Success.

1

Error

Error.

Update Pivot View

Updates a pivot view metadata.

Inputs

Input

Type

Detail

Notes

ID

TextField

The ID of the pivot view.

Name

TextField

The name of the pivot view. Must be unique.

Query ID

TextField

The ID of the query to create the view from.

Query Result ID

TextField

The ID of the query result to create the view from.

Additional Metadata

MapField

User-defined metadata to attach to the pivot view. This is any arbitrary JSON object and is not required.

Outputs

Output

Output Type

Notes

Pivot View

Json

Exit Codes

Code

Type

Detail

0

Success

Wdata API is up and running.

1

Error

Error.

Update Query Definition

Updates the properties of an existing query.

Inputs

Input

Type

Detail

Notes

Query ID

TextField

The ID of the query to update

Name

TextField

The name of the query. Must be unique.

Description

TextField

The description of the query.

Primary Result ID

TextField

If specified, this is the ID of the result that you would like the results of the query to populate by default.

Query Text

TextField

The query definition as would be defined in Wdata in the Advanced Query Mode. The syntax of the query follows the Presto SQL syntax.

Temporary

BooleanField

If set to true, the query generated will only be temporarily available and will not show up in the queries tab of your Wdata workspace.

Parameters

GroupField

Define the parameters required to run this query.

Outputs

Output

Output Type

Notes

Query

Json

Exit Codes

Code

Type

Detail

0

Success

Wdata API is up and running.

1

Error

Error.

Update Sheet Metadata

Updates a sheets metadata.

Inputs

Input

Type

Detail

Notes

Spreadsheet ID

TextField

A unique identifier for a spreadsheet

Sheet ID/Name

TextField

The ID of the sheet to update.

Name

TextField

The name of the sheet (Must be unique)

Sheet Index

NumberField

The index of the new sheet in the list of sheets. (Defaults to adding as the top sheet)

Parent Sheet Id

TextField

The ID of the parent sheet you would like this sheet to be created under. Leave blank to add to the root spreadsheet.

Outputs

None

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Error.

Update Spreadsheet Metadata

Updates a spreadsheet's metadata

Inputs

Input

Type

Detail

Notes

Spreadsheet ID

TextField

A unique identifier for a spreadsheet

Name

TextField

The name of the sheet (Must be unique)

Outputs

None

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Error.

Update Table

Updates an existing table with the provided information. Due to the nature of our datastore, columns can only ever be added. A column is considered new if no existing column can be found with an identical name. This equality check is case insensitive. No columns are ever deleted or modified by this endpoint. Any new columns will appear after other user-defined columns but before any meta columns (columns that start with _).

Inputs

Input

Type

Detail

Notes

Table ID

TextField

The ID of the table to update.

Name

TextField

The name of the table. Must be unique.

Description

TextField

The description of the table.

Type

DropdownField

The type of table you are creating. May be a 'lookup' table or a 'data' table.

Columns

GroupField

Define the columns for the table.

Outputs

Output

Output Type

Notes

Table

Json

Exit Codes

Code

Type

Detail

0

Success

Success.

1

Error

Error.

Write Sheet Data

Writes the data provided in the tabular data set to the region specified in the sheet

Inputs

Input

Type

Detail

Notes

Spreadsheet ID

TextField

A unique identifier for a spreadsheet

Sheet ID/Name

TextField

A unique identifier for a sheet within a spreadsheet

Data File

FileField

The CSV data containing the data to populate the sheet. The provided range data must not be larger than the specified region.

Delimiter

TextField

The delimiter of the CSV data provided

Region

TextField

A1 style representation of a cell or range. A range may be unbounded in any/all directions by leaving off the corresponding column or row.

Use Async

BooleanField

For large datasets you may need to load the data in an asynchronous fashion. In the future this will be the default.

Outputs

Output

Output Type

Notes

Rows Written

Integer

Cells Written

Integer

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Error.

Did this answer your question?