Structure and Overview
SDK Structure
Service Clients and Methods
The functionality of the Catalytic platform is grouped into into several service clients that are exposed as properties of the main SDK Client. The available service clients are summarized in the following tables. Click on the Service Client or method name to see more details in the reference documentation.
| Name | Methods | Description |
|---|---|---|
accessTokens | get | Gets a specific Access Token by ID |
find | Fetch all of your Access Tokens | |
create | Creates a new Access Token with your email and password Not supported for teams with SSO enabled | |
createWithWebApprovalFlow | Creates a new Access Token to be approved via the Account page in the Catalytic Web App Supported for all teams with or without SSO | |
waitForApproval | Waits for an Access Token created with createWithWebApprovalFlow to be approved in the Catalytic Web App | |
getApprovalUrl | Gets the URL that the user should be directed to to approve the Access Token created with createWithWebApprovalFlow | |
openUrl | A helper method for desktop apps to open the token approval URL that works across Windows, OSX and Linux | |
revoke | Revokes an Access Token so it can no longer be used | |
users | get | Gets a specific User by id, email or username |
find | Search for Users by name, or get all users. | |
workflows | get | Gets a specific Workflow by id |
find | Search for Workflow by name or owner | |
export | Export an existing Workflow | |
import | Import a Workflow | |
instances | get | Gets a specific Instance by id |
find | Search for Instances by name or owner | |
start | Start an Instance of a Workflow | |
stop | Stop an Instance | |
getInstanceStep | Get an Instance Step by ID | |
getInstanceSteps | Find Instance Steps | |
completeInstanceStep | Complete a Step | |
reassignInstanceStep | Reassign an Instance Step | |
files | get | Gets metadata of a File by id |
find | Search for Files by name, workflowId or instanceId | |
download | Downloads a File by id | |
getFileStream | Gets a readable stream of a File by id | |
upload | Uploads one or more new Files | |
dataTables | get | Gets metadata of a Data Table by id |
find | Search for Data Tables by name | |
download | Downloads a File by id | |
getFileStream | Gets a readable stream of a Data Table by id | |
upload | Uploads a new Data Table | |
replace | Replaces an existing Data Table |
Promises and Callbacks
All asynchronous client methods accept an optional callback as the final argument. If no callback is provided, a Promise will be returned.
Entities
Each Service Client provides operations over one or more Entity types. These Entities are documented in detail at the end of the Service Client section that manages them. The full set of Entities managed by the SDK is listed below for quick reference.
| Service Client | Entity | Description |
|---|---|---|
accessTokens | AccessToken | Access Tokens allow a developer to authenticate SDK requests on behalf of a specific Catalytic User |
users | User | Represents a user that can log into your Catalytic team |
workflows | Workflow | A Workflow is an automation you build on the Catalytic platform. It is a template of the process you want to run each time your Workflow is started. |
instances | Instance | When you start a Workflow, you create an Instance. That Instance contains data stored in fields and tracks the status of your automation workflow. Each Step in your Workflow becomes an Instance Step in your Instance. |
InstanceStep | Each step in a Workflow Instance represents a single action to be taken in the course of running the instance | |
Field | Fields hold the data in your Workflows and can be used to configure which steps your Workflow Instance takes and which are skipped. | |
files | File | A File can be associated with a Field in a Workflow or an Instance, or with a cell in a Data Table. |
Updated about 4 years ago