text: ---
  layout: default
  navsection: api
  navmenu: API Methods
  title: "traits"
  
  ...
  {% comment %}
  Copyright (C) The Arvados Authors. All rights reserved.
  
  SPDX-License-Identifier: CC-BY-SA-3.0
  {% endcomment %}
  
  p=. *Deprecated, likely to be removed in a future version.  The recommended way to store metadata is "collection properties":collections.html*
  
  API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/traits@
  
  Object type: @q1cn2@
  
  Example UUID: @zzzzz-q1cn2-0123456789abcde@
  
  h2. Resource
  
  A metadata record that may be used to represent a genotype or phenotype trait.
  
  Each Trait has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
  
  table(table table-bordered table-condensed).
  |_. Attribute|_. Type|_. Description|_. Example|
  |name|string|||
  |properties|hash|||
  
  h2. Methods
  
  See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
  
  Required arguments are displayed in %{background:#ccffcc}green%.
  
  h3. create
  
  Create a new Trait.
  
  Arguments:
  
  table(table table-bordered table-condensed).
  |_. Argument |_. Type |_. Description |_. Location |_. Example |
  |trait|object||query||
  
  h3. delete
  
  Delete an existing Trait.
  
  Arguments:
  
  table(table table-bordered table-condensed).
  |_. Argument |_. Type |_. Description |_. Location |_. Example |
  {background:#ccffcc}.|uuid|string|The UUID of the Trait in question.|path||
  
  h3. get
  
  Gets a Trait's metadata by UUID.
  
  Arguments:
  
  table(table table-bordered table-condensed).
  |_. Argument |_. Type |_. Description |_. Location |_. Example |
  {background:#ccffcc}.|uuid|string|The UUID of the Trait in question.|path||
  
  h3. list
  
  List traits.
  
  See "common resource list method.":{{site.baseurl}}/api/methods.html#index
  
  h3. update
  
  Update attributes of an existing Trait.
  
  Arguments:
  
  table(table table-bordered table-condensed).
  |_. Argument |_. Type |_. Description |_. Location |_. Example |
  {background:#ccffcc}.|uuid|string|The UUID of the Trait in question.|path||
  |trait|object||query||
  