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

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