Look for repo_name in VM link
[arvados.git] / doc / api / methods / links.html.textile.liquid
1 ---
2 layout: default
3 navsection: api
4 navmenu: API Methods
5 title: "links"
6
7 ...
8
9
10
11 Required arguments are displayed in %{background:#ccffcc}green%.
12
13
14 h2. create
15
16 Create a new Link.
17
18 Arguments:
19
20 table(table table-bordered table-condensed).
21 |_. Argument |_. Type |_. Description |_. Location |_. Example |
22 |link|object||query||
23
24 h2. delete
25
26 Delete an existing Link.
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 Link in question.|path||
33
34 h2. destroy
35
36 destroy links
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 Link'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 Link in question.|path||
53
54 h2. index
55
56 index links
57
58 Arguments:
59
60 table(table table-bordered table-condensed).
61 |_. Argument |_. Type |_. Description |_. Location |_. Example |
62 {background:#ccffcc}.|tail_uuid|string||path||
63 |order|string||query||
64 |where|object||query||
65
66 h2. list
67
68 List links.
69
70 Arguments:
71
72 table(table table-bordered table-condensed).
73 |_. Argument |_. Type |_. Description |_. Location |_. Example |
74 |limit|integer (default 100)|Maximum number of links to return.|query||
75 |order|string|Order in which to return matching links.|query||
76 |pageToken|string|Page token.|query||
77 |q|string|Query string for searching links.|query||
78 |where|object|Conditions for filtering links.|query||
79
80 h2. render_not_found
81
82 render_not_found links
83
84 Arguments:
85
86 table(table table-bordered table-condensed).
87 |_. Argument |_. Type |_. Description |_. Location |_. Example |
88 {background:#ccffcc}.|a|string||path||
89
90 h2. show
91
92 show links
93
94 Arguments:
95
96 table(table table-bordered table-condensed).
97 |_. Argument |_. Type |_. Description |_. Location |_. Example |
98 {background:#ccffcc}.|uuid|string||path||
99
100 h2. update
101
102 Update attributes of an existing Link.
103
104 Arguments:
105
106 table(table table-bordered table-condensed).
107 |_. Argument |_. Type |_. Description |_. Location |_. Example |
108 {background:#ccffcc}.|uuid|string|The UUID of the Link in question.|path||
109 |link|object||query||