doc/api/methods/traits.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "traits"
   6
   7 ...
   8 {% comment %}
   9 Copyright (C) The Arvados Authors. All rights reserved.
  10
  11 SPDX-License-Identifier: CC-BY-SA-3.0
  12 {% endcomment %}
  13
  14 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/traits@
  15
  16 Object type: @q1cn2@
  17
  18 Example UUID: @zzzzz-q1cn2-0123456789abcde@
  19
  20 h2. Resource
  21
  22 A metadata record that may be used to represent a genotype or phenotype trait.
  23
  24 Each Trait has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
  25
  26 table(table table-bordered table-condensed).
  27 |_. Attribute|_. Type|_. Description|_. Example|
  28 |name|string|||
  29 |properties|hash|||
  30
  31 h2. Methods
  32
  33 See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
  34
  35 Required arguments are displayed in %{background:#ccffcc}green%.
  36
  37 h3. create
  38
  39 Create a new Trait.
  40
  41 Arguments:
  42
  43 table(table table-bordered table-condensed).
  44 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  45 |trait|object||query||
  46
  47 h3. delete
  48
  49 Delete an existing Trait.
  50
  51 Arguments:
  52
  53 table(table table-bordered table-condensed).
  54 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  55 {background:#ccffcc}.|uuid|string|The UUID of the Trait in question.|path||
  56
  57 h3. get
  58
  59 Gets a Trait's metadata by UUID.
  60
  61 Arguments:
  62
  63 table(table table-bordered table-condensed).
  64 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  65 {background:#ccffcc}.|uuid|string|The UUID of the Trait in question.|path||
  66
  67 h3. list
  68
  69 List traits.
  70
  71 See "common resource list method.":{{site.baseurl}}/api/methods.html#index
  72
  73 h3. update
  74
  75 Update attributes of an existing Trait.
  76
  77 Arguments:
  78
  79 table(table table-bordered table-condensed).
  80 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  81 {background:#ccffcc}.|uuid|string|The UUID of the Trait in question.|path||
  82 |trait|object||query||