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
   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/pipeline_instances@
  12
  13 UUID type: @d1hrv@
  14
  15 Required arguments are displayed in %{background:#ccffcc}green%.
  16
  17 h2. Resource
  18
  19 Each PipelineInstance has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html:
  20
  21 table(table table-bordered table-condensed).
  22 |_. Attribute|_. Type|_. Description|_. Example|
  23 |pipeline_template_uuid|string|||
  24 |name|string|||
  25 |components|hash|||
  26 |success|boolean|||
  27 |active|boolean|||
  28 |properties|Hash|||
  29
  30 h2. Methods
  31
  32 h3. create
  33
  34 Create a new PipelineInstance.
  35
  36 Arguments:
  37
  38 table(table table-bordered table-condensed).
  39 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  40 |pipeline_instance|object||query||
  41
  42 h3. delete
  43
  44 Delete an existing PipelineInstance.
  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 PipelineInstance in question.|path||
  51
  52 h3. get
  53
  54 Gets a PipelineInstance'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 PipelineInstance in question.|path||
  61
  62 h3. list
  63
  64 List pipeline_instances.
  65
  66 Arguments:
  67
  68 table(table table-bordered table-condensed).
  69 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  70 |limit|integer (default 100)|Maximum number of pipeline_instances to return.|query||
  71 |order|string|Order in which to return matching pipeline_instances.|query||
  72 |filters|array|Conditions for filtering pipeline_instances.|query||
  73
  74 h3. update
  75
  76 Update attributes of an existing PipelineInstance.
  77
  78 Arguments:
  79
  80 table(table table-bordered table-condensed).
  81 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  82 {background:#ccffcc}.|uuid|string|The UUID of the PipelineInstance in question.|path||
  83 |pipeline_instance|object||query||