Skip to content

REST API

Chris Churas edited this page Jan 27, 2015 · 16 revisions

REST API

The CRBS Workflow Service REST API provides methods to create workflows, jobs, and workspace files as well as obtain a list of those objects.

Workflows represent Kepler workflows which are basically programs that perform some action. To run a Workflow one creates a Job.

Call Example URL
Create a Workflow /rest/workflows
Get a Workflow /rest/workflows/1234
Get a list of Workflows /rest/workflows

A run of a Workflow.

Call Example URL
Creates a Job /rest/jobs
Update a Job /rest/jobs/12345?status=Error
Get a Job /rest/jobs/1234
Get a list of Jobs /rest/jobs

Represents a file or directory of data on the system. These can be created directly or are output from a Job

Call Example URL
Get a list of Workspace Files /rest/workspacefiles
/rest/workspacefiles?synced=true&owner=bob
Get a Workspace File /rest/workspacefiles/1234
Create WorkspaceFile /rest/workspacefile
Update WorkspaceFile /rest/workspacefiles/1234?size=2222

CRBS Workflow Service uses Basic HTTP Authentication over SSL for authentication. Please click here for more information.