traits

Note:

This is a legacy API. This endpoint is deprecated, disabled by default in new installations, and is slated to be removed entirely in a future major release of Arvados. The recommended way to store metadata is with ‘properties’ field on collections and projects.

API endpoint base: https://pirca.arvadosapi.com/arvados/v1/traits

Object type: q1cn2

Example UUID: zzzzz-q1cn2-0123456789abcde

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:

Attribute Type Description Example
name string
properties hash

Methods

See Common resource methods for more information about create, delete, get, list, and update.

Required arguments are displayed in green.

create

Create a new Trait.

Arguments:

Argument Type Description Location Example
trait object query

delete

Delete an existing Trait.

Arguments:

Argument Type Description Location Example
uuid string The UUID of the Trait in question. path

get

Gets a Trait’s metadata by UUID.

Arguments:

Argument Type Description Location Example
uuid string The UUID of the Trait in question. path

list

List traits.

See common resource list method.

update

Update attributes of an existing Trait.

Arguments:

Argument Type Description Location Example
uuid string The UUID of the Trait in question. path
trait object query

Previous: specimens

The content of this documentation is licensed under the Creative Commons Attribution-Share Alike 3.0 United States licence.
Code samples in this documentation are licensed under the Apache License, Version 2.0.