Class ShortcutsRestController

java.lang.Object
com.aquima.web.rest.v1.controller.RestControllerBase
com.aquima.web.rest.v1.controller.ShortcutsRestController

@RestController @RestApiContext @RequestMapping(value="/shortcuts", produces="application/json") public class ShortcutsRestController extends RestControllerBase
Provides information about shortcuts.
Since:
9.6
Author:
Radu Batori, Voicu Moldovan
  • Field Details Link icon

  • Constructor Details Link icon

    • ShortcutsRestController Link icon

      @Autowired public ShortcutsRestController(com.blueriq.component.api.shortcut.IShortcutManager shortcutManager)
  • Method Details Link icon

    • getShortcuts Link icon

      @RequestMapping(method=GET) @ResponseStatus(OK) @ResponseBody public PagedShortcuts getShortcuts(@RequestParam(required=false) Integer page, @RequestParam(required=false) Integer pageSize, @RequestParam(value="sort",required=false) String sortParameter)
      Returns a paged view of all available shortcuts
      Parameters:
      page - The page number. Not required.
      pageSize - The items per page. Not required.
      sortParameter - The properties to sort on. Comma separated. Not required.
      Returns:
      The list of shortcuts.
    • getShortcut Link icon

      @RequestMapping(value="/{name}", method=GET) @ResponseStatus(OK) @ResponseBody public Shortcut getShortcut(@PathVariable("name") String name)
      Returns a shortcut by name.
      Parameters:
      name - The name of the shortcut
      Returns:
      The shortcut resource