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
  16 h2. create
  17
  18 Create a new Workflow.
  19
  20 Arguments:
  21
  22 table(table table-bordered table-condensed).
  23 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  24 {background:#ccffcc}.|workflow|object|See "Workflow resource":{{site.baseurl}}/api/schema/Workflow.html|request body||
  25
  26 h2. delete
  27
  28 Delete an existing Workflow.
  29
  30 Arguments:
  31
  32 table(table table-bordered table-condensed).
  33 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  34 {background:#ccffcc}.|uuid|string|The UUID of the Workflow in question.|path||
  35
  36 h2. get
  37
  38 Get a Workflow's metadata by UUID.
  39
  40 Arguments:
  41
  42 table(table table-bordered table-condensed).
  43 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  44 {background:#ccffcc}.|uuid|string|The UUID of the Workflow in question.|path||
  45
  46 h2. list
  47
  48 List workflows.
  49
  50 Arguments:
  51
  52 table(table table-bordered table-condensed).
  53 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  54 |limit|integer (default 100)|Maximum number of workflows to return.|query||
  55 |order|string|Order in which to return matching workflows.|query||
  56 |filters|array|Conditions for filtering workflows.|query||
  57
  58 h2. update
  59
  60 Update attributes of an existing Workflow.
  61
  62 Arguments:
  63
  64 table(table table-bordered table-condensed).
  65 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  66 {background:#ccffcc}.|uuid|string|The UUID of the Workflow in question.|path||
  67 |workflow|object||query||