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