Interface DashboardApi

All Superinterfaces:
ApiService

@Path("/api/v1/dashboards") @Produces("application/json") @Consumes("application/json") public interface DashboardApi extends ApiService
Operations on dashboards.
  • Method Details

    • serviceName

      default String serviceName()
      Specified by:
      serviceName in interface ApiService
    • searchDashboards

      @GET List<DashboardSearchResult> searchDashboards(@QueryParam("title") String title, @QueryParam("folderId") String folderId, @QueryParam("partialMatch") Boolean partialMatch, @QueryParam("page") Long page, @QueryParam("resultsPerPage") Long resultsPerPage)
      Searches dashboards by title. Spaces at the start and end of the search text are ignored, and uppercase and lowercase letters are treated as the same. Without folderId, global dashboards and the dashboards of all folders are searched. With folderId, only dashboards directly in that folder are searched; global dashboards and subfolders are not included. By default, only dashboards whose title is the same as the search text are returned. With partialMatch=true, dashboards whose title contains the search text are returned.

      Results include all dashboards visible to the current user (both view-only and editable). Administrators see all dashboards, with no other permission checks. Other users see a dashboard when they:

      • are the owner of the dashboard, or
      • have the dashboard#view permission.
      For folder dashboards, other users must also have the folder#view permission on the folder, or the global all#audit permission. This also applies to the owner of the dashboard.

      The canEdit property indicates whether the user can modify the dashboard: it is true if the user is an administrator, is the owner of the dashboard, or has dashboard#edit permission; otherwise, false (view-only). Only dashboards with canEdit = true can be modified (for example, to save a tile).

      The Home dashboard and release dashboards are never returned. Dashboards are ordered by the created date, oldest first, and are returned one page at a time. A page holds at most resultsPerPage dashboards (100 by default, which is also the maximum). When a page holds fewer dashboards than resultsPerPage, it is the last page.

      Parameters:
      title - the text to search for in dashboard titles; required and must not be blank
      folderId - optional folder ID (for example Applications/Folder123) to search in; if the folder does not exist or the user cannot view it, an empty list is returned
      partialMatch - optional; when true, returns dashboards whose title contains the search text. Defaults to false
      page - optional; the zero-based page of results to return. Defaults to 0
      resultsPerPage - optional; the number of results per page, from 1 to 100. Defaults to 100
      Returns:
      the matching dashboards of the requested page, without their tiles, or an empty list when nothing matches or the page is past the last one. When title is missing or blank, page is negative, or resultsPerPage is not between 1 and 100, an HTTP 400 (Bad Request) response is returned instead