Confluence Retirement

In an effort to consolidate USGS hosted Wikis, myUSGS’ Confluence service is scheduled for retirement on January 27th, 2023. The official USGS Wiki and collaboration space is now SharePoint. Please migrate existing spaces and content to the SharePoint platform and remove it from Confluence at your earliest convenience. If you need any additional information or have any concerns about this change, please contact myusgs@usgs.gov. Thank you for your prompt attention to this matter.
Skip to end of metadata
Go to start of metadata

Shortcuts can be made from one item to another, establishing a symbolic parent/child relationship between items. This process is used to create the concept of virtual collections in ScienceBase as well as other cases where a hierarchical relationship is desired without actually moving an item from one place to another. The API controllers for these operations are addLink to create shortcuts and unlink to remove them. In both cases, the following parameters are required.

  • itemId - the ScienceBase ID of the item that will be (or is already) linked to a new parent item
  • destId - the ScienceBase ID of the symbolic parent item

Example: https://www.sciencebase.gov/catalog/items/addLink?itemId=505bb264e4b08c986b32578f&destId=5192a7fce4b00ddd76a724a8

In this example, the item with ID, 505bb264e4b08c986b32578f, will be linked to the item with ID, 5192a7fce4b00ddd76a724a8.

To remove the link, you would simply replace the /addLink? controller with the /unlink? controller.

Note: There is currently no bulk change method for linking and unlinking items via the API. Items must be linked or unlinked individually.

  • No labels