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