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

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