Keyboard Shortcuts Manager (REST)

The response contains the following fields:

• KeyboardShortcutID - a number used as the identifier for the keyboard shortcut.
• Type - a string indicating the type of keyboard shortcut, such as system, choice, or field.
  Copy

  1
  2
  3
  4
  5
  { 
     "System", 
    "Choice", 
     "Field"
  }

• ArtifactID - a number representing the Artifact ID of a field or choice associated with the keyboard shortcut. This property is only returned when the type is "Choice" or "Field".
• Action - a string indicating an action taken when a keyboard shortcut is triggered. The following types of action are available:
  • ToggleChoice - an action of this type is returned for Choice type keyboard shortcuts.
  • SelectField - an action of this type is returned for Field type keyboard shortcuts.
  • Other actions - include those for System type keyboard shortcuts.

  The following strings are used in the Action field:

  Copy

  1
  2
  3
  4
  5
  6
  7
  8
  9
  10
  11
  12
  13
  14
  {
      "NavigateLastDocument",
      "NavigateFirstDocument",
      "NavigatePreviousDocument",
      "NavigateNextDocument",
      "DocumentProfileSave",
      "DocumentProfileCancel",
      "DocumentProfileSaveAndNext",
      "DocumentProfileEdit",
      "CSAPCopy",
      "ToggleChoice",
      "SelectField",
      "ViewerSwitchModeExtractedText"
  }

• KeysCombination - indicates whether additional keys are used as part of the shortcut. The following properties are available:
  • Shift - a Boolean value indicating whether the Shift key is used in the key combination.
  • Ctrl - a Boolean value indicating whether the Control key is used in the key combination.
  • Alt - a Boolean value indicating whether the Alt key is used in the key combination.
  • Key - a number indicating a key used in a specific keyboard shortcut combination.

    The list contains number and key combinations.

    Copy

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    {
        13, // Return
        32, // Space
        33, // Page Up
        34, // Page Down
        35, // End
        36, // Home
        37, // Left Arrow
        38  // Up Arrow
        39, // Right Arrow
        40, // Down Arrow
        48, // 0
        49, // 1
        50, // 2
        51, // 3
        52, // 4
        53, // 5
        54, // 6
        55, // 7
        56, // 8
        57, // 9
        65, // A
        66, // B
        67, // C
        68, // D
        69, // E
        70, // F
        71, // G
        72, // H
        73, // I
        74, // J
        75, // K
        76, // L
        77, // M
        78, // N
        79, // O
        80, // P
        81, // Q
        82, // R
        83, // S
        84, // T
        85, // U
        86, // V
        87, // W
        88, // X
        89, // Y
        90  // Z
    }