Links

Synapse links are shortcuts to other data in Synapse. You can use links to create bookmarks for any file, table, view, folder, or project, rather than duplicating them in multiple folders. Links receive their own synIDs that are unique from the original linked item.

Creating a Link via the Synapse UI

Navigate to the file, table, folder or project that you wish to link. Click the Tools menu and select Save Link.

In the pop-up window, select a destination folder or project. This location is where the link will appear once you create it. Click Create Link to save.

Once you’ve created a link, the final result will appear in your selected destination. To remove the link, click the red link icon.

Creating a Link Programatically

Python

import synapseclient
syn = synapseclient.login()

# Add a local file to an existing project (syn12345) on Synapse
# targetId is the synapse id of the file, table, etc that you want to link
# targetVersion is optional, if no version is defined, the link will always point to the newest version
# parent is the folder or project where you want to link to exist
linkEnt = synapseclient.Link(targetId="syn12345", targetVersion=1, parent="syn2345")
linkEnt = syn.store(linkEnt)

R

library(synapser)
synLogin()

# Add a local file to an existing project (syn12345) on Synapse
# targetId is the synapse id of the file, table, etc that you want to link
# targetVersion is optional, if no version is defined, the link will always point to the newest version
# parent is the folder or project where you want to link to exist
linkEnt <- Link(targetId="syn12345", targetVersion=1, parent="syn2345")
linkEnt <- synStore(linkEnt)