This page is a work in progress.
A bookmark allows you to quickly access a collection or data file of interest. If your user account has the Read permission level on any collection or data file in DME, you can create a bookmark on that collection or data file. This command also allows the system administrator or group administrator to add bookmarks for other users.
dm_add_bookmark <bookmark_name> <description.json> [REST-response]
The following table describes each parameter:
| Parameter | Description |
|---|---|
| <bookmark_name> | The name that will be displayed on the UI for the bookmark. |
| <description.json> | The name of the JSON file containing additional data parameters for the command, as follows: {
"path" : "/Path/To/Bookmark",
"group" : "A bookmark group name",
"userId" : "NIH user ID",
"permission": "The permission to set for the path"
}
The parameters 'userId' and 'permission' are available only for system administrators and group administrators to set a bookmark and permission for other users. If you do not specify a permission, then the system leaves the existing permission as it is. |
| [REST-response] | (TBD) |
For instructions on performing similar tasks in the GUI, refer to the following pages:
- Managing Permissions via the GUI
- Creating a Bookmark via the GUI
- Using a Bookmark via the GUI
- Deleting a Bookmark via the GUI
(TBD: Links in these GUI pages, and in the Getting Started with DME CLU page, pointing to this CLU page.)
