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

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "workflows"
   6 ...
   7 {% comment %}
   8 Copyright (C) The Arvados Authors. All rights reserved.
   9
  10 SPDX-License-Identifier: CC-BY-SA-3.0
  11 {% endcomment %}
  12
  13 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/workflows@
  14
  15 Object type: @7fd4e@
  16
  17 Example UUID: @zzzzz-7fd4e-0123456789abcde@
  18
  19 h2. Resource
  20
  21 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.
  22
  23 Each Workflow offers the following optional attributes, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
  24
  25 table(table table-bordered table-condensed).
  26 |_. Attribute|_. Type|_. Description|_. Example|
  27 |name|string|If not specified, will be set to any "name" from the "definition" attribute.||
  28 |description|string|If not specified, will be set to any "description" from the "definition" attribute.||
  29 |definition|string|A "Common Workflow Language" document.|Visit "Common Workflow Language":http://www.commonwl.org/ for details.|
  30
  31 h2. Methods
  32
  33 See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
  34
  35 Required arguments are displayed in %{background:#ccffcc}green%.
  36
  37 h3. create
  38
  39 Create a new Workflow.
  40
  41 Arguments:
  42
  43 table(table table-bordered table-condensed).
  44 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  45 {background:#ccffcc}.|workflow|object|Workflow resource|request body||
  46
  47 h3. delete
  48
  49 Delete an existing Workflow.
  50
  51 Arguments:
  52
  53 table(table table-bordered table-condensed).
  54 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  55 {background:#ccffcc}.|uuid|string|The UUID of the Workflow in question.|path||
  56
  57 h3. get
  58
  59 Get a Workflow's metadata by UUID.
  60
  61 Arguments:
  62
  63 table(table table-bordered table-condensed).
  64 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  65 {background:#ccffcc}.|uuid|string|The UUID of the Workflow in question.|path||
  66
  67 h3. list
  68
  69 List workflows.
  70
  71 See "common resource list method.":{{site.baseurl}}/api/methods.html#index
  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||