Help Desk

Submit a ticket My Tickets
Welcome
Login

OneCloud Command Reference

A connector for integrating with the OneCloud Rest API

Connections

OneCloud

Connector to the OneCloud Rest API

Inputs

Input Type Detail Notes
Base URL TextField The Base URL. Unless otherwise instructed, set the value to https://api.onecloud.io

Commands

Execute Chain

Executes a chain and waits for it to complete

Inputs

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

Outputs

Output Output Type Notes
Chain Run File

Exit Codes

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

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.

Outputs

Output Output Type Notes
Chain Runs File
Number of Chain Runs Integer

Exit Codes

Code Type Detail
0 Success Success
1 Error General failure
2 Error Authentication failed

Get Authorizations Activity

Retrieves all authorizations activity for a tenant

Inputs

Input Type Detail Notes
Maximum Results NumberField The maximum number of results to retrieve. Use 0 to retrieve all items.

Outputs

Output Output Type Notes
Authorizations Activities File
Number of Activities Integer

Exit Codes

Code Type Detail
0 Success Success
1 Error General failure
2 Error Authentication failed

Get Chain

Retrieves properties for a Chain in a Environment

Inputs

Input Type Detail Notes
Environment ID TextField The ID of the Environment
Chain ID TextField The ID of the Chain

Outputs

Output Output Type Notes
Chain File

Exit Codes

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

Inputs

Input Type Detail Notes
Environment ID TextField The ID of the Environment
Chain ID TextField The ID of the Chain

Outputs

Output Output Type Notes
Commands File

Exit Codes

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

Inputs

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.

Outputs

Output Output Type Notes
Chain Runs File
Number of Chain Runs Integer

Exit Codes

Code Type Detail
0 Success Success
1 Error General failure
2 Error Authentication failed

Get Chain Run

Get the details of a Chain Run

Inputs

Input Type Detail Notes
Chain Run ID TextField The ID of the Chain Run

Outputs

Output Output Type Notes
Chain Run File

Exit Codes

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

Inputs

Input Type Detail Notes
Chain Run ID TextField The ID of the Chain Run

Outputs

Output Output Type Notes
Chain Run File

Exit Codes

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

Inputs

Input Type Detail Notes
Environment ID TextField The ID of the Environment

Outputs

Output Output Type Notes
Chains File
Number of Chains Integer

Exit Codes

Code Type Detail
0 Success Success
1 Error General failure
2 Error Authentication failed

Get Environment

Retrieves properties for an Environment in a Workspace

Inputs

Input Type Detail Notes
Workspace ID TextField The ID of the Workspace
Environment ID TextField The ID of the Environment

Outputs

Output Output Type Notes
Environment File

Exit Codes

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

Inputs

Input Type Detail Notes
Workspace ID TextField The ID of the Workspace

Outputs

Output Output Type Notes
Environments File
Number of Environments Integer

Exit Codes

Code Type Detail
0 Success Success
1 Error General failure
2 Error Authentication failed

Get Login Activity

Retrieves all login activity for a tenant

Inputs

Input Type Detail Notes
Maximum Results NumberField The maximum number of results to retrieve. Use 0 to retrieve all items.

Outputs

Output Output Type Notes
Login Activities File
Number of Activities Integer

Exit Codes

Code Type Detail
0 Success Success
1 Error General failure
2 Error Authentication failed

Get Permissions

Retrieves all permissions for a tenant

Inputs

Input Type Detail Notes
Maximum Results NumberField The maximum number of results to retrieve. Use 0 to retrieve all items.

Outputs

Output Output Type Notes
Permissions File
Number of Permissions Integer

Exit Codes

Code Type Detail
0 Success Success
1 Error General failure
2 Error Authentication failed

Get User

Retrieves properties for a User

Inputs

Input Type Detail Notes
User ID TextField The ID of the User

Outputs

Output Output Type Notes
User File

Exit Codes

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

Inputs

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.

Outputs

Output Output Type Notes
Permissions File
Number of Permissions Integer

Exit Codes

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

Inputs

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.

Outputs

Output Output Type Notes
UserGroups File
Number of UserGroups Integer

Exit Codes

Code Type Detail
0 Success Success
1 Error General failure
2 Error Authentication failed

Get UserGroup

Retrieves properties for a UserGroup

Inputs

Input Type Detail Notes
Group Id TextField The ID of the Group

Outputs

Output Output Type Notes
UserGroup File

Exit Codes

Code Type Detail
0 Success Success
1 Error General failure
2 Error Authentication failed

Get UserGroups

Retrieves all UserGroups for a tenant

Inputs

Input Type Detail Notes
Maximum Results NumberField The maximum number of results to retrieve. Use 0 to retrieve all items.

Outputs

Output Output Type Notes
UserGroups File
Number of UserGroups Integer

Exit Codes

Code Type Detail
0 Success Success
1 Error General failure
2 Error Authentication failed

Get Users

Retrieves all users for a tenant

Inputs

Input Type Detail Notes
Maximum Results NumberField The maximum number of results to retrieve. Use 0 to retrieve all items.

Outputs

Output Output Type Notes
Users File
Number of Users Integer

Exit Codes

Code Type Detail
0 Success Success
1 Error General failure
2 Error Authentication failed

Get Workspace

Retrieves a Workspace and it's properties

Inputs

Input Type Detail Notes
Workspace ID TextField The ID of the Workspace

Outputs

Output Output Type Notes
Workspace File

Exit Codes

Code Type Detail
0 Success Success
1 Error General failure
2 Error Authentication failed

Get Workspaces

Retrieves all Workspaces and their properties

Inputs

None

Outputs

Output Output Type Notes
Workspaces File
Number of Workspaces Integer

Exit Codes

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

Inputs

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.

Outputs

Output Output Type Notes
Chain Runs File
Number of Chain Runs Integer

Exit Codes

Code Type Detail
0 Success Success
1 Error General failure
2 Error Authentication failed

Stop Chain

Stops a currently running Chain

Inputs

Input Type Detail Notes
Chain Run ID TextField The ID of the Chain Run

Outputs

Output Output Type Notes
Chain Run File

Exit Codes

Code Type Detail
0 Success Success
1 Error General failure
2 Error Authentication failed
B
Brian is the author of this solution article.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.