links

API endpoint base: https://qr1hi.arvadosapi.com/arvados/v1/links

Object type: o0j2j

Example UUID: zzzzz-o0j2j-0123456789abcde

Resource

Links are an extensible way to describe relationships between Arvados objects and metadata about individual objects.

Each link has, in addition to the Common resource fields:

Attribute Type Description
head_uuid string The object being described or acted on.
tail_uuid string The origin or actor in the description or action (may be null).
link_class string Type of link
name string Primary value of the link.
properties hash Additional information, expressed as a key→value hash. Key: string. Value: string, number, array, or hash. May be used in queries using subproperty filters

Link classes

Some classes are pre-defined by convention and have standard meanings attached to names.

permission

See permission links section of the permission model.

star

A star link is a shortcut to a project that is displayed in the user interface (Workbench) as “favorites”. Users can mark their own favorites (implemented by creating or deleting star links).

An admin can also create star links owned by the “All Users” group, these will be displayed to all users that have permission to read the project that has been favorited.

The schema for a star link is:

Field Value Description
owner_uuid user or group uuid Either the user that owns the favorite, or the “All Users” group for public favorites.
head_uuid project uuid The project being favorited
link_class string of value “star” Indicates this represents a link to a user favorite

Creating a favorite

owner_uuid is either an individual user, or the “All Users” group. The head_uuid is the project being favorited.

$ arv link create --link '{
    "owner_uuid": "zzzzz-j7d0g-fffffffffffffff",
    "head_uuid":  "zzzzz-j7d0g-theprojectuuid",
    "link_class": "star"}'

Deleting a favorite

$ arv link delete --uuid zzzzz-o0j2j-thestarlinkuuid

Listing favorites

To list all ‘star’ links that will be displayed for a user:

$ arv link list --filters '[
  ["link_class", "=", "star"],
  ["owner_uuid", "in", ["zzzzz-j7d0g-fffffffffffffff", "zzzzz-tpzed-currentuseruuid"]]]'

tag

A tag link describes an object using an unparsed plain text string. Tags can be used to annotate objects that are not directly editable by the user, like collections and objects shared as read-only.

tail_type→head_type name→head_uuid {properties}
→Collection tag namecollection uuid
→Job tag namejob uuid

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 Link.

Arguments:

Argument Type Description Location Example
link object query

delete

Delete an existing Link.

Arguments:

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

get

Gets a Link’s metadata by UUID.

Arguments:

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

list

List links.

See common resource list method.

update

Update attributes of an existing Link.

Arguments:

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

Previous: keep_services Next: logs

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.