workflows

API endpoint base: https://qr1hi.arvadosapi.com/arvados/v1/workflows

Object type: 7fd4e

Example UUID: zzzzz-7fd4e-0123456789abcde

Resource

Stores a Common Workflow Language (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 Common resource fields:

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 for details.

Methods

See Common resource methods for more information about create, delete, get, list, and update.

Required arguments are displayed in green.

create

Create a new Workflow.

Arguments:

Argument Type Description Location Example
workflow object Workflow resource request body

delete

Delete an existing Workflow.

Arguments:

Argument Type Description Location Example
uuid string The UUID of the Workflow in question. path

get

Get a Workflow’s metadata by UUID.

Arguments:

Argument Type Description Location Example
uuid string The UUID of the Workflow in question. path

list

List workflows.

See common resource list method.

update

Update attributes of an existing Workflow.

Arguments:

Argument Type Description Location Example
uuid string The UUID of the Workflow in question. path
workflow object query

Previous: containers Next: Crunch scripts

The content of this documentation is licensed under the Creative Commons Attribution-Share Alike 3.0 United States licence.
Code samples in this documentation are licensed under the Apache License, Version 2.0.