Merge branch 'master' into 2257-inequality-conditions
[arvados.git] / doc / api / schema / PipelineInstance.html.textile.liquid
1 ---
2 layout: default
3 navsection: api
4 navmenu: Schema
5 title: PipelineInstance
6
7 ...
8
9
10
11 A **PipelineInstance** represents...
12
13 h2. Methods
14
15 See "REST methods for working with Arvados resources":/api/methods.html
16
17 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/pipeline_instances@
18
19 h2. Creation
20
21 h3. Prerequisites
22
23 Prerequisites for creating a PipelineInstance.
24
25 h3. Side effects
26
27 Side effects of creating a PipelineInstance.
28
29 h2. Resources
30
31 Each PipelineInstance has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
32
33 table(table table-bordered table-condensed).
34 |_. Attribute|_. Type|_. Description|_. Example|
35 |pipeline_template_uuid|string|||
36 |name|string|||
37 |components|Hash|||
38 |success|boolean|||
39 |active|boolean|||
40 |updated_at|datetime|||
41 |properties|Hash|||