Keyboard Shortcuts Manager (REST)

The Keyboard Shortcuts Manager service supports retrieving all keyboard shortcuts available in a workspace, or a specific subset of them, such as those assigned to the system, choices, or fields. It also provides information about the actions that these shortcuts trigger.

As a sample use case, you might want to implement custom keyboard shortcuts in layouts, such as the review interface. You could use this service to retrieve the information required to attach the appropriate shortcut to a specific field or choice, or for global use at the system level. Users could then navigate with the custom keyboard shortcuts through fields and choices or trigger global actions with them.

You can also use the Keyboard Shortcuts Manager service through .NET. For more information, see Keyboard Shortcuts Manager (.NET).

This page contains the following information:

Client code sample

You can use the following .NET code as a sample client for retrieving keyboard shortcuts.

URLs

The URLs for REST endpoints contain path parameters that you need to set before making a call:

  • Set {versionNumber} to the version of the API, using the format lowercase v and the version number, such as v1.
  • Set other path parameters in the URLs to the Artifact ID of a given entity, such as {workspaceID} to the Artifact ID of a workspace.
  • Note: To indicate the admin-level context, set the {Workspace ID} path parameter to -1.

Retrieve keyboard shortcut

To retrieve the keyboard shortcuts for a workspace, use these guidelines:

  • Don't use the admin level context, specified by -1, as the target workspace.
  • Ensure that the user has permissions to view documents in the workspace.
  • Ensure that the user has permissions to view any fields associate with keyboard shortcuts. This requirement includes fields used for choices.

Send a GET request to a URL with the following format:

<host>/Relativity.Rest/API/relativity-review/{versionNumber}/workspaces/{workspaceID}/keyboard-shortcuts?includeSystemShortcuts=<true|false>&includeChoiceShortcuts=<true|false>&includeFieldShortcuts=<true|false>

Set the following optional query string parameters in any order delimited by ampersands:

  • includeSystemShortcuts - a Boolean value indicating whether to retrieve System shortcuts. The default value is true.
  • includeChoiceShortcuts - a Boolean value indicating whether to retrieve Choice shortcuts. The default value is true.
  • includeFieldShortcuts - a Boolean value indicating whether to retrieve Field shortcuts. The default value is true.

The body of the request is empty.

Additional Resources

DevHelp Community GitHub Release Notes NuGet

Share knowledge with the Relativity developer community.

Access tools and resources to build an application.

Review the most recent product release notes.

Create .NET Apps faster with NuGet.