X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/7e52fd153f2d16f94061ef1eabfe653d4a83852a..ae92d144610446849eb568247a44f02ae985c281:/doc/api/methods/workflows.html.textile.liquid diff --git a/doc/api/methods/workflows.html.textile.liquid b/doc/api/methods/workflows.html.textile.liquid index bde0ee41a4..77ed6f3597 100644 --- a/doc/api/methods/workflows.html.textile.liquid +++ b/doc/api/methods/workflows.html.textile.liquid @@ -3,22 +3,24 @@ layout: default navsection: api navmenu: API Methods title: "workflows" - ... +{% comment %} +Copyright (C) The Arvados Authors. All rights reserved. -See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html +SPDX-License-Identifier: CC-BY-SA-3.0 +{% endcomment %} API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/workflows@ -UUID type: @7fd4e@ +Object type: @7fd4e@ -Required arguments are displayed in %{background:#ccffcc}green%. +Example UUID: @zzzzz-7fd4e-0123456789abcde@ h2. Resource 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. -Each Workflow offers the following optional attributes, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html: +Each Workflow offers the following optional attributes, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html: table(table table-bordered table-condensed). |_. Attribute|_. Type|_. Description|_. Example| @@ -28,6 +30,12 @@ table(table table-bordered table-condensed). h2. Methods +See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@. + +Required arguments are displayed in %{background:#ccffcc}green%. + +Supports federated @create@, @delete@, @get@, @list@, and @update@. + h3. create Create a new Workflow. @@ -36,7 +44,7 @@ Arguments: table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | -{background:#ccffcc}.|workflow|object|See "Workflow resource":{{site.baseurl}}/api/schema/Workflow.html|request body|| +{background:#ccffcc}.|workflow|object|Workflow resource|request body|| h3. delete @@ -62,13 +70,7 @@ h3. list List workflows. -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -|limit|integer (default 100)|Maximum number of workflows to return.|query|| -|order|string|Order in which to return matching workflows.|query|| -|filters|array|Conditions for filtering workflows.|query|| +See "common resource list method.":{{site.baseurl}}/api/methods.html#index h3. update