Linking all generated doc pages to index. (refs #1608)
[arvados.git] / doc / api / Link.textile
1 ---
2 layout: default
3 navsection: api
4 title: "Resource: Link"
5 navorder: 101
6 ---
7
8 h1. Link
9
10 A **Link** represents...
11
12 h2. Methods
13
14 See "REST methods for working with Arvados resources":methods.html
15
16 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/link@
17
18 h2. Creation
19
20 h3. Prerequisites
21
22 Prerequisites for creating a Link.
23
24 h3. Side effects
25
26 Side effects of creating a Link.
27
28 h2. Resources
29
30 Each Link has, in addition to the usual "attributes of Arvados resources":resources.html:
31
32 table(table table-bordered table-condensed).
33 |*Property name*|*Value*|*Description*|*Example*|
34 |id|integer|||
35 |uuid|string|||
36 |owner_uuid|string|||
37 |created_at|datetime|||
38 |modified_by_client_uuid|string|||
39 |modified_by_user_uuid|string|||
40 |modified_at|datetime|||
41 |tail_uuid|string|||
42 |tail_kind|string|||
43 |link_class|string|||
44 |name|string|||
45 |head_uuid|string|||
46 |properties|Hash|||
47 |updated_at|datetime|||
48 |head_kind|string|||