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 Supports federated @create@, @delete@, @get@, @list@, and @update@.
  38
  39 h3. create
  40
  41 Create a new Workflow.
  42
  43 Arguments:
  44
  45 table(table table-bordered table-condensed).
  46 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  47 {background:#ccffcc}.|workflow|object|Workflow resource|request body||
  48
  49 h3. delete
  50
  51 Delete an existing Workflow.
  52
  53 Arguments:
  54
  55 table(table table-bordered table-condensed).
  56 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  57 {background:#ccffcc}.|uuid|string|The UUID of the Workflow in question.|path||
  58
  59 h3. get
  60
  61 Get a Workflow's metadata by UUID.
  62
  63 Arguments:
  64
  65 table(table table-bordered table-condensed).
  66 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  67 {background:#ccffcc}.|uuid|string|The UUID of the Workflow in question.|path||
  68
  69 h3. list
  70
  71 List workflows.
  72
  73 See "common resource list method.":{{site.baseurl}}/api/methods.html#index
  74
  75 h3. update
  76
  77 Update attributes of an existing Workflow.
  78
  79 Arguments:
  80
  81 table(table table-bordered table-condensed).
  82 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  83 {background:#ccffcc}.|uuid|string|The UUID of the Workflow in question.|path||
  84 |workflow|object||query||