![]() |
Page History
Excerpt | ||
---|---|---|
| ||
dm_add_bookmark |
Note |
---|
This page is a work in progress. |
This command allows the user to add a new bookmark. It also allows the system administrator or group administrator to add bookmarks for other users.
Code Block |
---|
dm_add_bookmark <bookmark_name> <description.json> [REST-response] |
The following table describes each parameter:
...
Include Page | ||||
---|---|---|---|---|
|
In your local system, create a JSON file that specifies the path within DME for the bookmark. For general usage information about the dm_add_bookmark command, refer to Adding a Bookmark via the CLU. As an administrator, you can specify additional parameters (userId and permission) in the JSON file:
Code Block { "path" :
The name of the JSON file containing the data parameters for the command, as follows:
...
"/Path/To/Bookmark",
...
"
...
userId" :
...
"user ID or group name",
...
"permission": "The permission to set for the path
...
Important note: The fields 'userId' and 'permission' are available only for system administrators and group administrators to set bookmark and permission for other users. If no permission is specified, then the existing permission is left as is.
, in ALL CAPS" }
The system accepts the following capitalized values for the permission field:
- OWN
- WRITE
- READ
Run the dm_add_bookmark command as described in Adding a Bookmark via the CLU. The system responds as follows:
- If your JSON file specifies a bookmark path for an existing DME user, but does not specify a permission level for that user, then the system leaves the existing permission level as it is.
- If your JSON file specifies an NIH user account that does not exist as a DME user yet, and specifies a permission level for that user, the system creates that user in DME with the specified permission level.
- The system creates the user in the DOC with which you are affiliated, and does not set a base path.
- Ask the specified user or group of users to log out of DME and log in again.
For example, consider the following command:
Panel | |||||
---|---|---|---|---|---|
| |||||
|
With the following code in the specified my-bookmark.json file, the command gives the doejohn9 user Write access to the PI_Lab1 collection, creates a bookmark named MyCollection for that user, and associates the bookmark with the PI_Lab1 collection:
Code Block |
---|
{
"path" : "/Example_Archive/PI_Lab1",
"userId" : "doejohn9",
"permission": "WRITE"
} |
...