Interface DashboardApi
- All Superinterfaces:
ApiService
-
Field Summary
Fields inherited from interface com.xebialabs.xlrelease.api.ApiService
DEFAULT_RESULTS_PER_PAGE, DEFAULT_RESULTS_PER_PAGE_STRING, DEPTH, ORDER_BY, PAGE, PAGE_IS_OFFSET, RESULTS_PER_PAGE, ROLE_IDS_DATA -
Method Summary
-
Method Details
-
serviceName
- Specified by:
serviceNamein interfaceApiService
-
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. WithoutfolderId, global dashboards and the dashboards of all folders are searched. WithfolderId, 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. WithpartialMatch=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#viewpermission.
folder#viewpermission on the folder, or the globalall#auditpermission. This also applies to the owner of the dashboard.The
canEditproperty indicates whether the user can modify the dashboard: it istrueif the user is an administrator, is the owner of the dashboard, or hasdashboard#editpermission; otherwise,false(view-only). Only dashboards withcanEdit = truecan 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
resultsPerPagedashboards (100 by default, which is also the maximum). When a page holds fewer dashboards thanresultsPerPage, it is the last page.- Parameters:
title- the text to search for in dashboard titles; required and must not be blankfolderId- optional folder ID (for exampleApplications/Folder123) to search in; if the folder does not exist or the user cannot view it, an empty list is returnedpartialMatch- optional; whentrue, returns dashboards whose title contains the search text. Defaults tofalsepage- optional; the zero-based page of results to return. Defaults to 0resultsPerPage- 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
titleis missing or blank,pageis negative, orresultsPerPageis not between 1 and 100, an HTTP 400 (Bad Request) response is returned instead
-