doc/api/methods/workflows.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "workflows"
   6
   7 ...
   8
   9 See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html
  10
  11 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/workflows@
  12
  13 UUID type: @7fd4e@
  14
  15 Required arguments are displayed in %{background:#ccffcc}green%.
  16
  17 h2. Resource
  18
  19 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.
  20
  21 Each Workflow offers the following optional attributes, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html:
  22
  23 table(table table-bordered table-condensed).
  24 |_. Attribute|_. Type|_. Description|_. Example|
  25 |name|string|If not specified, will be set to any "name" from the "definition" attribute.||
  26 |description|string|If not specified, will be set to any "description" from the "definition" attribute.||
  27 |definition|string|A "Common Workflow Language" document.|Visit "Common Workflow Language":http://www.commonwl.org/ for details.|
  28
  29 h2. Methods
  30
  31 h3. create
  32
  33 Create a new Workflow.
  34
  35 Arguments:
  36
  37 table(table table-bordered table-condensed).
  38 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  39 {background:#ccffcc}.|workflow|object|See "Workflow resource":{{site.baseurl}}/api/schema/Workflow.html|request body||
  40
  41 h3. delete
  42
  43 Delete an existing Workflow.
  44
  45 Arguments:
  46
  47 table(table table-bordered table-condensed).
  48 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  49 {background:#ccffcc}.|uuid|string|The UUID of the Workflow in question.|path||
  50
  51 h3. get
  52
  53 Get a Workflow's metadata by UUID.
  54
  55 Arguments:
  56
  57 table(table table-bordered table-condensed).
  58 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  59 {background:#ccffcc}.|uuid|string|The UUID of the Workflow in question.|path||
  60
  61 h3. list
  62
  63 List workflows.
  64
  65 Arguments:
  66
  67 table(table table-bordered table-condensed).
  68 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  69 |limit|integer (default 100)|Maximum number of workflows to return.|query||
  70 |order|string|Order in which to return matching workflows.|query||
  71 |filters|array|Conditions for filtering workflows.|query||
  72
  73 h3. update
  74
  75 Update attributes of an existing Workflow.
  76
  77 Arguments:
  78
  79 table(table table-bordered table-condensed).
  80 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  81 {background:#ccffcc}.|uuid|string|The UUID of the Workflow in question.|path||
  82 |workflow|object||query||