Reorganizing API documentation to support new navbar (refs #1651).
[arvados.git] / doc / api / Link.textile
1 ---
2 layout: default
3 navsection: api
4 navmenu: Schema
5 title: "Resource: Link"
6 navorder: 101
7 ---
8
9 h1. Link
10
11 A **Link** represents...
12
13 h2. Methods
14
15 See "REST methods for working with Arvados resources":methods.html
16
17 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/link@
18
19 h2. Creation
20
21 h3. Prerequisites
22
23 Prerequisites for creating a Link.
24
25 h3. Side effects
26
27 Side effects of creating a Link.
28
29 h2. Resources
30
31 Each Link has, in addition to the usual "attributes of Arvados resources":resources.html:
32
33 table(table table-bordered table-condensed).
34 |*Attribute*|*Type*|*Description*|*Example*|
35 |tail_uuid|string|||
36 |tail_kind|string|||
37 |link_class|string|||
38 |name|string|||
39 |head_uuid|string|||
40 |properties|Hash|||
41 |updated_at|datetime|||
42 |head_kind|string|||