X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/7e52fd153f2d16f94061ef1eabfe653d4a83852a..5b554bbe0b9104e8a34b87d5570cbf87f0308bce:/doc/api/methods/pipeline_instances.html.textile.liquid diff --git a/doc/api/methods/pipeline_instances.html.textile.liquid b/doc/api/methods/pipeline_instances.html.textile.liquid index 33f927f01a..55baee9b5a 100644 --- a/doc/api/methods/pipeline_instances.html.textile.liquid +++ b/doc/api/methods/pipeline_instances.html.textile.liquid @@ -5,24 +5,29 @@ navmenu: API Methods title: "pipeline_instances" ... +{% 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 %} + +p=. *Legacy. This endpoint is read-only and disabled by default in new installations.* API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/pipeline_instances@ -UUID type: @d1hrv@ +Object type: @d1hrv@ -Required arguments are displayed in %{background:#ccffcc}green%. +Example UUID: @zzzzz-d1hrv-0123456789abcde@ h2. Resource -Deprecated. A pipeline instance is a collection of jobs managed by @aravdos-run-pipeline-instance@. +Deprecated. A pipeline instance is a collection of jobs managed by @arvados-run-pipeline-instance@. -Each PipelineInstance has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html: +Each PipelineInstance has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html: table(table table-bordered table-condensed). |_. Attribute|_. Type|_. Description|_. Example| -|pipeline_template_uuid|string||| +|pipeline_template_uuid|string|The "pipeline template":pipeline_templates.html that this instance was created from.|| |name|string||| |components|hash||| |success|boolean||| @@ -31,6 +36,10 @@ 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%. + h3. create Create a new PipelineInstance. @@ -65,13 +74,7 @@ h3. list List pipeline_instances. -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -|limit|integer (default 100)|Maximum number of pipeline_instances to return.|query|| -|order|string|Order in which to return matching pipeline_instances.|query|| -|filters|array|Conditions for filtering pipeline_instances.|query|| +See "common resource list method.":{{site.baseurl}}/api/methods.html#index h3. update