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 p=. *Deprecated, likely to be removed in a future version.  The recommended way to store metadata is "collection properties":collections.html*
  15
  16 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/traits@
  17
  18 Object type: @q1cn2@
  19
  20 Example UUID: @zzzzz-q1cn2-0123456789abcde@
  21
  22 h2. Resource
  23
  24 A metadata record that may be used to represent a genotype or phenotype trait.
  25
  26 Each Trait has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
  27
  28 table(table table-bordered table-condensed).
  29 |_. Attribute|_. Type|_. Description|_. Example|
  30 |name|string|||
  31 |properties|hash|||
  32
  33 h2. Methods
  34
  35 See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
  36
  37 Required arguments are displayed in %{background:#ccffcc}green%.
  38
  39 h3. create
  40
  41 Create a new Trait.
  42
  43 Arguments:
  44
  45 table(table table-bordered table-condensed).
  46 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  47 |trait|object||query||
  48
  49 h3. delete
  50
  51 Delete an existing Trait.
  52
  53 Arguments:
  54
  55 table(table table-bordered table-condensed).
  56 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  57 {background:#ccffcc}.|uuid|string|The UUID of the Trait in question.|path||
  58
  59 h3. get
  60
  61 Gets a Trait's metadata by UUID.
  62
  63 Arguments:
  64
  65 table(table table-bordered table-condensed).
  66 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  67 {background:#ccffcc}.|uuid|string|The UUID of the Trait in question.|path||
  68
  69 h3. list
  70
  71 List traits.
  72
  73 See "common resource list method.":{{site.baseurl}}/api/methods.html#index
  74
  75 h3. update
  76
  77 Update attributes of an existing Trait.
  78
  79 Arguments:
  80
  81 table(table table-bordered table-condensed).
  82 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  83 {background:#ccffcc}.|uuid|string|The UUID of the Trait in question.|path||
  84 |trait|object||query||