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

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "pipeline_instances"
   6
   7 ...
   8 {% comment %}
   9 Copyright (C) The Arvados Authors. All rights reserved.
  10
  11 SPDX-License-Identifier: CC-BY-SA-3.0
  12 {% endcomment %}
  13
  14 p=. *Legacy.  This endpoint is read-only and disabled by default in new installations.*
  15
  16 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/pipeline_instances@
  17
  18 Object type: @d1hrv@
  19
  20 Example UUID: @zzzzz-d1hrv-0123456789abcde@
  21
  22 h2. Resource
  23
  24 Deprecated.  A pipeline instance is a collection of jobs managed by @aravdos-run-pipeline-instance@.
  25
  26 Each PipelineInstance has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
  27
  28 table(table table-bordered table-condensed).
  29 |_. Attribute|_. Type|_. Description|_. Example|
  30 |pipeline_template_uuid|string|The "pipeline template":pipeline_templates.html that this instance was created from.||
  31 |name|string|||
  32 |components|hash|||
  33 |success|boolean|||
  34 |active|boolean|||
  35 |properties|Hash|||
  36
  37 h2. Methods
  38
  39 See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
  40
  41 Required arguments are displayed in %{background:#ccffcc}green%.
  42
  43 h3. create
  44
  45 Create a new PipelineInstance.
  46
  47 Arguments:
  48
  49 table(table table-bordered table-condensed).
  50 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  51 |pipeline_instance|object||query||
  52
  53 h3. delete
  54
  55 Delete an existing PipelineInstance.
  56
  57 Arguments:
  58
  59 table(table table-bordered table-condensed).
  60 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  61 {background:#ccffcc}.|uuid|string|The UUID of the PipelineInstance in question.|path||
  62
  63 h3. get
  64
  65 Gets a PipelineInstance's metadata by UUID.
  66
  67 Arguments:
  68
  69 table(table table-bordered table-condensed).
  70 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  71 {background:#ccffcc}.|uuid|string|The UUID of the PipelineInstance in question.|path||
  72
  73 h3. list
  74
  75 List pipeline_instances.
  76
  77 See "common resource list method.":{{site.baseurl}}/api/methods.html#index
  78
  79 h3. update
  80
  81 Update attributes of an existing PipelineInstance.
  82
  83 Arguments:
  84
  85 table(table table-bordered table-condensed).
  86 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  87 {background:#ccffcc}.|uuid|string|The UUID of the PipelineInstance in question.|path||
  88 |pipeline_instance|object||query||