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.

NameMethodsDescription
AccessTokensGet
GetAsync
Gets a specific Access Token by ID
Find
FindAsync
Fetch all of your Access Tokens
Create
CreateAsync
Creates a new Access Token with your email and password
Not supported for teams with SSO enabled
CreateWithWebApprovalFlow
CreateWithWebApprovalFlowAsync
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
WaitForApprovalAsync
Waits for an Access Token created with CreateWithWebApprovalFlow
to be approved in the Catalytic Web App
GetApprovalUrlGets the URL that the user should be directed to to approve the
Access Token created with CreateWithWebApprovalFlow
OpenUrlA helper method for desktop apps to open the token approval URL
that works across Windows, OSX and Linux
Revoke
RevokeAsync
Revokes an Access Token so it can no longer be used
UsersGet
GetAsync
Gets a specific User by Id, Email or Username
Find
FindAsync
Search for Users by Name, or get all users.
WorkflowsGet
GetAsync
Gets a specific Workflow by Id
Find
FindAsync
Search for Workflow by Name or Owner
Export
ExportAsync
Export an existing Workflow
Import
ImportAsync
Import a Workflow
InstancesGet
GetAsync
Gets a specific Instance by Id
Find
FindAsync
Search for Instances by Name or Owner
Start
StartAsync
Start an Instance of a Workflow
Stop
StopAsync
Stop an Instance
GetStep
GetStepAsync
Get an Instance Step by ID
GetSteps
GetStepsAsync
Get all Steps of an Instance
FindSteps
FindStepsAsync
Find Steps across all Instances
CompleteStep
CompleteStepAsync
Complete a Step
FilesGet
GetAsync
Gets metadata of a File by Id
Find
FindAsync
Search for Files by Name, WorkflowId or InstanceId
Download
DownloadAsync
Downloads a File by Id
GetFileStream
GetFileStreamAsync
Gets a readable stream of a File by Id
Upload
UploadAsync
Uploads one or more new Files
DataTablesGet
GetAsync
Gets metadata of a Data Table by Id
Find
FindAsync
Search for Data Tables by Name
Download
DownloadAsync
Downloads a File by Id
GetFileStream
GetFileStreamAsync
Gets a readable stream of a Data Table by Id
Upload
UploadAsync
Uploads a new Data Table
Replace
ReplaceAsync
Replaces an existing Data Table

πŸ“˜

Sync and Async Methods

All client methods that do IO have both sync and async versions. Please be sure to use the methods that match the threading model of your application. For example, Winforms or ASP.net apps should in most cases use the async method versions.

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 ClientEntityDescription
AccessTokensAccessTokenAccess Tokens allow a developer to authenticate
SDK requests on behalf of a specific Catalytic User
UsersUserRepresents a user that can log into your Catalytic team
WorkflowsWorkflowA 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.
InstancesInstanceWhen 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.
InstanceStepEach step in a Workflow Instance represents a single action to be taken
in the course of running the instance
Field
Field<T>
Fields hold the data in your Workflows and can be used to configure which
steps your Workflow Instance takes and which are skipped.
FilesFileA File can be associated with a Field in a Workflow or an Instance, or with a cell in
a Data Table.