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 |*Property name*|*Value*|*Description*|*Example*|
  34 |id|integer|||
  35 |uuid|string|||
  36 |owner_uuid|string|||
  37 |created_at|datetime|||
  38 |modified_by_client_uuid|string|||
  39 |modified_by_user_uuid|string|||
  40 |modified_at|datetime|||
  41 |pipeline_template_uuid|string|||
  42 |name|string|||
  43 |components|Hash|||
  44 |success|boolean|||
  45 |active|boolean|||
  46 |updated_at|datetime|||
  47 |properties|Hash|||