The commands in this article are used with the Workiva Chains connector. To find your chain IDs, view this article on finding IDs in Workiva.
Connector to the Workiva Rest API
Input | Type | Detail |
Base URL | TextField | The Base URL. Unless otherwise instructed, set the value to https://h.app.wdesk.com/s/wdata/oc/api/ |
Execute Chain
Executes a chain and waits for it to complete.
Equivalent API call: https://developers.workiva.com/chains-v1/chains-startchain/
Note: Although this command can be used when a dynamic chain ID is required, we recommend using a Run Chain event in most cases. The Run Chain event is more closely tied to the chain being executed and provides a simpler user experience.
Inputs
Input | Type | Detail |
Environment ID | TextField | The ID of the environment. |
Chain ID | TextField | The ID of the chain. |
Runtime Variables | GroupField | The values for the runtime variables used in the chain. |
Poll Interval | NumberField | Optional: The amount of time (in seconds) to wait before checking if the chain has completed. This defaults to five seconds, and it should only be adjusted if you expect your chain to run for a long time. |
Outputs
Output | Output Type |
Chain Run | File |
Exit codes
Exit Code | Type | Detail |
0 | Success | Success |
1 | Error | General failure |
2 | Error | Authentication failed |
Find Chain Runs by Input Value
Retrieves all chain runs that contain the text provided.
Equivalent API call: https://developers.workiva.com/chains-v1/chains-chaininputssearch/
Inputs
Input | Type | Detail |
Environment ID | TextField | The ID of the Environment you're searching. |
Search Text | TextField | The input value to search for. |
Maximum Results | NumberField | The maximum number of results to retrieve. Use 0 to retrieve all items. |
Outputs
Output | Output Type |
Chain Runs | File |
Number of Chain Runs | Integer |
Exit Codes
Exit Code | Type | Detail |
0 | Success | Success |
1 | Error | General failure |
2 | Error | Authentication failed |
Get Chain
Retrieves properties for a chain.
Equivalent API call: https://developers.workiva.com/chains-v1/chains-getchain/
Inputs
Input | Type | Detail |
Environment ID | TextField | The ID of the target environment. |
Chain ID | TextField | The ID of the chain. |
Outputs
Output | Output Type |
Chain | File |
Exit codes
Exit Code | Type | Detail |
0 | Success | Success |
1 | Error | General failure |
2 | Error | Authentication failed |
Get Chain Commands
Retrieves properties for all commands in a chain.
Equivalent API call: https://developers.workiva.com/chains-v1/chains-getcommands/
Inputs
Input | Type | Detail |
Environment ID | TextField | The ID of the target environment. |
Chain ID | TextField | The ID of the chain. |
Outputs
Output | Output Type |
Commands | File |
Exit codes
Exit Code | Type | Detail |
0 | Success | Success |
1 | Error | General failure |
2 | Error | Authentication failed |
Get Chain History
Retrieves the historical chain runs for a chain.
Equivalent API call: https://developers.workiva.com/chains-v1/chains-chainrunhistory/
Inputs
Input | Type | Detail |
Environment ID | TextField | The ID of the target environment. |
Chain ID | TextField | The ID of the chain. |
Maximum Results | NumberField | The maximum number of results to retrieve. Use 0 to retrieve all items. |
Start Date | TextField | Filters chain runs that happened after the specified start date. This value can use ISO8601 format or a Unix timestamp. |
End Date | TextField | Filters Chain runs that happened before the specified end date. This value can use ISO8601 format or a Unix timestamp. |
Outputs
Output | Output Type |
Chain Runs | File |
Number of Chain Runs | Integer |
Exit codes
Exit Code | Type | Detail |
0 | Success | Success |
1 | Error | General failure |
2 | Error | Authentication failed |
Get Chain Run
Get the details of a chain run.
Equivalent API call: https://developers.workiva.com/chains-v1/chains-getchainrun/
Inputs
Input | Type | Detail |
Chain Run ID | TextField | The ID of the chain run. |
Outputs
Output | Output Type |
Chain Run | File |
Exit codes
Exit Code | Type | Detail |
0 | Success | Success |
1 | Error | General failure |
2 | Error | Authentication failed |
Get Chain Run With Nodes
Get the details of a chain run including the node details.
Equivalent API call: https://developers.workiva.com/chains-v1/chains-getchainrunnodes/
Inputs
Input | Type | Detail |
Chain Run ID | TextField | The ID of the chain run. |
Outputs
Output | Output Type |
Chain Run | File |
Exit codes
Exit Code | Type | Detail |
0 | Success | Success |
1 | Error | General failure |
2 | Error | Authentication failed |
Get Chains
Retrieves all chains and their properties in a specific environment.
Equivalent API call: https://developers.workiva.com/chains-v1/chains-getchains/
Inputs
Input | Type | Detail |
Environment ID | TextField | The ID of the target environment. |
Outputs
Output | Output Type |
Chains | File |
Number of Chains | Integer |
Exit codes
Exit Code | Type | Detail |
0 | Success | Success |
1 | Error | General failure |
2 | Error | Authentication failed |
Get Environment
Retrieves properties for a specific environment.
Equivalent API call: https://developers.workiva.com/chains-v1/chains-getenvironment/
Inputs
Input | Type | Detail |
Workspace ID | TextField | The ID of the workspace where the environment lives. |
Environment ID | TextField | The ID of the target environment. |
Outputs
Output | Output Type |
Environment | File |
Exit codes
Exit Code | Type | Detail |
0 | Success | Success |
1 | Error | General failure |
2 | Error | Authentication failed |
Get Environments
Retrieves a list of Environments in a workspace.
Equivalent API call: https://developers.workiva.com/chains-v1/chains-getenvironments/
Inputs
Input | Type | Detail |
Workspace ID | TextField | The ID of the workspace containing the environments. |
Outputs
Output | Output Type |
Environments | File |
Number of Environments | Integer |
Exit codes
Exit Code | Type | Detail |
0 | Success | Success |
1 | Error | General failure |
2 | Error | Authentication failed |
Get Workspace
Retrieves a workspace and its properties.
Equivalent API call: https://developers.workiva.com/chains-v1/chains-getworkspace/
Inputs
Input | Type | Detail |
Workspace ID | TextField | The ID of the workspace. |
Outputs
Output | Output Type |
Workspace | File |
Exit codes
Exit Code | Type | Detail |
0 | Success | Success |
1 | Error | General failure |
2 | Error | Authentication failed |
Get Workspaces
Retrieves a list of all workspaces for a company.
Equivalent API call: https://developers.workiva.com/chains-v1/chains-getworkspaces/
Inputs
None
Outputs
Output | Output Type |
Workspaces | File |
Number of Workspaces | Integer |
Exit codes
Exit Code | Type | Detail |
0 | Success | Success |
1 | Error | General failure |
2 | Error | Authentication failed |
Publish Mapping Group
Publishes a mapping group, as specified by the Mapping Group GUID.
Equivalent API call: https://developers.workiva.com/chains-v1/chains-publish/
Inputs
Input | Type | Detail |
Mapping Group GUID | TextField | The GUID of the mapping group. |
Outputs
None
Exit codes
Exit Code | Type | Detail |
0 | Success | Success |
1 | Error | General failure |
2 | Error | Authentication failed |
Search Chain Runs
Searches for chain runs that match the given filters.
Equivalent API call: https://developers.workiva.com/chains-v1/chains-chainfiltersearch/
Note: The environment_id parameter is not required for superusers or org admins.
Inputs
Input | Type | Detail |
Filters | GroupField | The filters to apply to the search. |
Maximum Results | NumberField | The maximum number of results to retrieve. Use 0 to retrieve all items. |
Outputs
Output | Output Type |
Chain Runs | File |
Number of Chain Runs | Integer |
Exit codes
Exit Code | Type | Detail |
0 | Success | Success |
1 | Error | General failure |
2 | Error | Authentication failed |
Stop Chain
Stops a currently running Chain.
Equivalent API call: https://developers.workiva.com/chains-v1/chains-stopchain/
Inputs
Input | Type | Detail |
Chain Run ID | TextField | The ID of the chain run to stop. |
Outputs
Output | Output Type |
Chain Run | File |
Exit codes
Exit Code | Type | Detail |
0 | Success | Success |
1 | Error | General failure |
2 | Error | Authentication failed |
Upload Mapping Rules
Uploads a mapping group ruleset, as specified by the mapping group GUID.
Equivalent API call: https://developers.workiva.com/chains-v1/chains-updaterules/
Inputs
Input | Type | Detail |
Mapping Group GUID | TextField | The GUID of the mapping group. |
Upload Mode | DropdownField | The upload mode. When mode=published, the currently published version is updated and re-published. When mode=draft, only the draft is updated. When mode=both, both the published version and the draft are updated. |
Mapping Rule File | FileField | The file containing the mapping rules to upload. |
Outputs
Output | Output Type |
Upload Errors | File |
Upload Result | File |
Number of Rules Uploaded | Integer |
Number of Errors | Integer |
Exit codes
Exit Code | Type | Detail |
0 | Success | Success |
1 | Error | General failure |
2 | Error | Authentication failed |