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