---
layout: default
navsection: api
navmenu: API Methods
title: "workflows"

...

See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html

API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/workflows@

UUID type: @7fd4e@

Required arguments are displayed in %{background:#ccffcc}green%.

h2. Resource

Stores a "Common Workflow Language":http://commonwl.org (CWL) computational workflow that can be searched for, browsed and executed (submitted to Crunch) from the workbench.

Each Workflow offers the following optional attributes, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html:

table(table table-bordered table-condensed).
|_. Attribute|_. Type|_. Description|_. Example|
|name|string|If not specified, will be set to any "name" from the "definition" attribute.||
|description|string|If not specified, will be set to any "description" from the "definition" attribute.||
|definition|string|A "Common Workflow Language" document.|Visit "Common Workflow Language":http://www.commonwl.org/ for details.|

h2. Methods

h3. create

Create a new Workflow.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|workflow|object|See "Workflow resource":{{site.baseurl}}/api/schema/Workflow.html|request body||

h3. delete

Delete an existing Workflow.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|uuid|string|The UUID of the Workflow in question.|path||

h3. get

Get a Workflow's metadata by UUID.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|uuid|string|The UUID of the Workflow in question.|path||

h3. list

List workflows.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
|limit|integer (default 100)|Maximum number of workflows to return.|query||
|order|string|Order in which to return matching workflows.|query||
|filters|array|Conditions for filtering workflows.|query||

h3. update

Update attributes of an existing Workflow.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|uuid|string|The UUID of the Workflow in question.|path||
|workflow|object||query||