Merge branch 'master' of git.clinicalfuture.com:arvados
[arvados.git] / 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 h1. traits
10
11 Required arguments are displayed in %{background:#ccffcc}green%.
12
13
14 h2. create
15
16 Create a new Trait.
17
18 Arguments:
19
20 table(table table-bordered table-condensed).
21 |_. Argument |_. Type |_. Description |_. Location |_. Example |
22 |trait|object||query||
23
24 h2. delete
25
26 Delete an existing Trait.
27
28 Arguments:
29
30 table(table table-bordered table-condensed).
31 |_. Argument |_. Type |_. Description |_. Location |_. Example |
32 {background:#ccffcc}.|uuid|string|The UUID of the Trait in question.|path||
33
34 h2. destroy
35
36 destroy traits
37
38 Arguments:
39
40 table(table table-bordered table-condensed).
41 |_. Argument |_. Type |_. Description |_. Location |_. Example |
42 {background:#ccffcc}.|uuid|string||path||
43
44 h2. get
45
46 Gets a Trait's metadata by UUID.
47
48 Arguments:
49
50 table(table table-bordered table-condensed).
51 |_. Argument |_. Type |_. Description |_. Location |_. Example |
52 {background:#ccffcc}.|uuid|string|The UUID of the Trait in question.|path||
53
54 h2. index
55
56 index traits
57
58 Arguments:
59
60 table(table table-bordered table-condensed).
61 |_. Argument |_. Type |_. Description |_. Location |_. Example |
62 |order|string||query||
63 |where|object||query||
64
65 h2. list
66
67 List traits.
68
69 Arguments:
70
71 table(table table-bordered table-condensed).
72 |_. Argument |_. Type |_. Description |_. Location |_. Example |
73 |limit|integer (default 100)|Maximum number of traits to return.|query||
74 |order|string|Order in which to return matching traits.|query||
75 |pageToken|string|Page token.|query||
76 |q|string|Query string for searching traits.|query||
77 |where|object|Conditions for filtering traits.|query||
78
79 h2. show
80
81 show traits
82
83 Arguments:
84
85 table(table table-bordered table-condensed).
86 |_. Argument |_. Type |_. Description |_. Location |_. Example |
87 {background:#ccffcc}.|uuid|string||path||
88
89 h2. update
90
91 Update attributes of an existing Trait.
92
93 Arguments:
94
95 table(table table-bordered table-condensed).
96 |_. Argument |_. Type |_. Description |_. Location |_. Example |
97 {background:#ccffcc}.|uuid|string|The UUID of the Trait in question.|path||
98 |trait|object||query||