NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Revised to omit statements about administrators, after creating a separate page about bookmarks for admins.

...

Include Page
shared info - bookmark intro
shared info - bookmark intro
This command also allows the system administrator or group administrator to add a bookmark for another user. The administrator can also set permissions for that user at the same time.

Code Block
dm_add_bookmark <bookmark_name> <description.json> [REST-response]

...

ParameterDescription
<bookmark_name>The name that the system displays on the UI for the bookmark.
<description.json>

The name of the JSON file containing additional data parameters for the command, as follows:

Code Block
{
 "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]

Include Page
shared info - REST-response parameter
shared info - REST-response parameter

...