Note: This is legacy documentation that should only be used by standalone OneCloud subscribers. While the information remains valid, it is not being actively updated.
A connector for integrating with the OneCloud Rest API. The commands in this article are used with the OneCloud BizApp.
Connections
Connector to the Workiva Rest API.
| Input | Type | Detail | Notes |
|---|---|---|---|
| Base URL | TextField | The Base URL. Unless otherwise instructed, set the value to: https://api.onecloud.io |
|
| Access Token | TextField | The Access Token generated in the API section of the Administration App. | |
| Refresh Token | TextField | The refresh token associated with the Access Token | |
| Client ID | TextField | The Client ID associated with the Access Token |
Execute Chain
Executes a chain and waits for it to complete.
| Input | Type | Detail | Notes |
| 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 5 seconds, and it should really only be adjusted if you expect your Chain to run for a long time |
| Output | Output Type | Notes |
| Chain Run | File |
| 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 in one of the Command inputs.
| Input | Type | Detail | Notes |
| Environment ID | TextField | The ID of the Environment | |
| 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. |
| Output | Output Type | Notes |
| Chain Runs | File | |
| Number of Chain Runs | Integer |
| Exit Code | Type | Detail |
| 0 | Success | Success |
| 1 | Error | General failure |
| 2 | Error | Authentication failed |
Get Authorizations Activity
Retrieves all authorizations activity for a tenant.
| Input | Type | Detail | Notes |
| Maximum Results | NumberField | The maximum number of results to retrieve. Use 0 to retrieve all items. |
| Output | Output Type | Notes |
| Authorizations Activities | File | |
| Number of Activities | Integer |
| Exit Code | Type | Detail |
| 0 | Success | Success |
| 1 | Error | General failure |
| 2 | Error | Authentication failed |
Get Chain
Retrieves properties for a Chain in an environment.
| Input | Type | Detail | Notes |
| Environment ID | TextField | The ID of the Environment | |
| Chain ID | TextField | The ID of the Chain |
| Output | Output Type | Notes |
| Chain | File |
| 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.
| Input | Type | Detail | Notes |
| Environment ID | TextField | The ID of the Environment | |
| Chain ID | TextField | The ID of the Chain |
| Output | Output Type | Notes |
| Commands | File |
| 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.
| Input | Type | Detail | Notes |
| Environment ID | TextField | The ID of the 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 (DateTime values from the OneCloud platform) or a Unix timestamp | |
| End Date | TextField | Filters Chain runs that happened before the specified end date. This value can use ISO8601 format (DateTime values from the OneCloud platform) or a Unix timestamp |
| Output | Output Type | Notes |
| Chain Runs | File | |
| Number of Chain Runs | Integer |
| 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.
| Input | Type | Detail | Notes |
| Chain Run ID | TextField | The ID of the Chain Run |
| Output | Output Type | Notes |
| Chain Run | File |
| 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.
| Input | Type | Detail | Notes |
| Chain Run ID | TextField | The ID of the Chain Run |
| Output | Output Type | Notes |
| Chain Run | File |
| Exit Code | Type | Detail |
| 0 | Success | Success |
| 1 | Error | General failure |
| 2 | Error | Authentication failed |
Get Chains
Retrieves all Chains in an Environment and their properties.
| Input | Type | Detail | Notes |
| Environment ID | TextField | The ID of the Environment |
| Output | Output Type | Notes |
| Chains | File | |
| Number of Chains | Integer |
| Exit Code | Type | Detail |
| 0 | Success | Success |
| 1 | Error | General failure |
| 2 | Error | Authentication failed |
Get Environment
Retrieves properties for an Environment in a Workspace.
| Input | Type | Detail | Notes |
| Workspace ID | TextField | The ID of the Workspace | |
| Environment ID | TextField | The ID of the Environment |
| Output | Output Type | Notes |
| Environment | File |
| Exit Code | Type | Detail |
| 0 | Success | Success |
| 1 | Error | General failure |
| 2 | Error | Authentication failed |
Get Environments
Retrieves all Environments in a Workspace and their properties.
| Input | Type | Detail | Notes |
| Workspace ID | TextField | The ID of the Workspace |
| Output | Output Type | Notes |
| Environments | File | |
| Number of Environments | Integer |
| Exit Code | Type | Detail |
| 0 | Success | Success |
| 1 | Error | General failure |
| 2 | Error | Authentication failed |
Get Login Activity
Retrieves all login activity for a tenant.
| Input | Type | Detail | Notes |
| Maximum Results | NumberField | The maximum number of results to retrieve. Use 0 to retrieve all items. |
| Output | Output Type | Notes |
| Login Activities | File | |
| Number of Activities | Integer |
| Code | Type | Detail |
| 0 | Success | Success |
| 1 | Error | General failure |
| 2 | Error | Authentication failed |
Get Permissions
Retrieves all permissions for a tenant.
| Input | Type | Detail | Notes |
| Maximum Results | NumberField | The maximum number of results to retrieve. Use 0 to retrieve all items. |
| Output | Output Type | Notes |
| Permissions | File | |
| Number of Permissions | Integer |
| Exit Code | Type | Detail |
| 0 | Success | Success |
| 1 | Error | General failure |
| 2 | Error | Authentication failed |
Get User
Retrieves properties for a User.
| Input | Type | Detail | Notes |
| User ID | TextField | The ID of the User |
| Output | Output Type | Notes |
| User | File |
| Exit Code | Type | Detail |
| 0 | Success | Success |
| 1 | Error | General failure |
| 2 | Error | Authentication failed |
Get User Group Permissions
Retrieves all permissions assigned to a User Group.
| Input | Type | Detail | Notes |
| Group Id | TextField | The ID of the Group | |
| Maximum Results | NumberField | The maximum number of results to retrieve. Use 0 to retrieve all items. |
| Output | Output Type | Notes |
| Permissions | File | |
| Number of Permissions | Integer |
| Exit Code | Type | Detail |
| 0 | Success | Success |
| 1 | Error | General failure |
| 2 | Error | Authentication failed |
Get User UserGroups
Retrieves all UserGroups a user is a member of.
| Input | Type | Detail | Notes |
| User Id | TextField | The ID of the User | |
| Maximum Results | NumberField | The maximum number of results to retrieve. Use 0 to retrieve all items. |
| Output | Output Type | Notes |
| UserGroups | File | |
| Number of UserGroups | Integer |
| Exit Code | Type | Detail |
| 0 | Success | Success |
| 1 | Error | General failure |
| 2 | Error | Authentication failed |
Get UserGroup
Retrieves properties for a UserGroup.
| Input | Type | Detail | Notes |
| Group Id | TextField | The ID of the Group |
| Output | Output Type | Notes |
| UserGroup | File |
| Exit Code | Type | Detail |
| 0 | Success | Success |
| 1 | Error | General failure |
| 2 | Error | Authentication failed |
Get UserGroups
Retrieves all UserGroups for a tenant.
| Input | Type | Detail | Notes |
| Maximum Results | NumberField | The maximum number of results to retrieve. Use 0 to retrieve all items. |
| Output | Output Type | Notes |
| UserGroups | File | |
| Number of UserGroups | Integer |
| Exit Code | Type | Detail |
| 0 | Success | Success |
| 1 | Error | General failure |
| 2 | Error | Authentication failed |
Get Users
Retrieves all users for a tenant.
| Input | Type | Detail | Notes |
| Maximum Results | NumberField | The maximum number of results to retrieve. Use 0 to retrieve all items. |
| Output | Output Type | Notes |
| Users | File | |
| Number of Users | Integer |
| Exit Code | Type | Detail |
| 0 | Success | Success |
| 1 | Error | General failure |
| 2 | Error | Authentication failed |
Get Workspace
Retrieves a Workspace and its properties.
| Input | Type | Detail | Notes |
| Workspace ID | TextField | The ID of the Workspace |
| Output | Output Type | Notes |
| Workspace | File |
| Exit Code | Type | Detail |
| 0 | Success | Success |
| 1 | Error | General failure |
| 2 | Error | Authentication failed |
Get Workspaces
Retrieves all Workspaces and their properties. Inputs None
| Output | Output Type | Notes |
| Workspaces | File | |
| Number of Workspaces | Integer |
| Exit Code | Type | Detail |
| 0 | Success | Success |
| 1 | Error | General failure |
| 2 | Error | Authentication failed |
Publish Mapping Group
Publishes a Mapping Group.
| Input | Type | Detail | Notes |
| Mapping Group GUID | TextField | The GUID of the Mapping Group |
Outputs None
| 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.
| Input | Type | Detail | Notes |
| 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. |
| Output | Output Type | Notes |
| Chain Runs | File | |
| Number of Chain Runs | Integer |
| Exit Code | Type | Detail |
| 0 | Success | Success |
| 1 | Error | General failure |
| 2 | Error | Authentication failed |
Stop Chain
Stops a currently running Chain.
| Input | Type | Detail | Notes |
| Chain Run ID | TextField | The ID of the Chain Run |
| Output | Output Type | Notes |
| Chain Run | File |
| Exit Code | Type | Detail |
| 0 | Success | Success |
| 1 | Error | General failure |
| 2 | Error | Authentication failed |
Upload Mapping Rules
Upload Mapping Rules.
| Input | Type | Detail | Notes |
| 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 |
| Output | Output Type | Notes |
| Upload Errors | File | |
| Upload Result | File | |
| Number of Rules Uploaded | Integer | |
| Number of Errors | Integer |
| Exit Code | Type | Detail |
| 0 | Success | Success |
| 1 | Error | General failure |
| 2 | Error | Authentication failed |