getDashboardsPaginated method

Future<PageBeanDashboard> getDashboardsPaginated({
  1. String? dashboardName,
  2. String? accountId,
  3. String? owner,
  4. String? groupname,
  5. String? groupId,
  6. int? projectId,
  7. String? orderBy,
  8. int? startAt,
  9. int? maxResults,
  10. String? status,
  11. String? expand,
})

Returns a paginated list of dashboards. This operation is similar to Get dashboards except that the results can be refined to include dashboards that have specific attributes. For example, dashboards with a particular name. When multiple attributes are specified only filters matching all attributes are returned.

This operation can be accessed anonymously.

Permissions required: The following dashboards that match the query parameters are returned:

  • Dashboards owned by the user. Not returned for anonymous users.
  • Dashboards shared with a group that the user is a member of. Not returned for anonymous users.
  • Dashboards shared with a private project that the user can browse. Not returned for anonymous users.
  • Dashboards shared with a public project.
  • Dashboards shared with the public.

Implementation

Future<PageBeanDashboard> getDashboardsPaginated(
    {String? dashboardName,
    String? accountId,
    String? owner,
    String? groupname,
    String? groupId,
    int? projectId,
    String? orderBy,
    int? startAt,
    int? maxResults,
    String? status,
    String? expand}) async {
  return PageBeanDashboard.fromJson(await _client.send(
    'get',
    'rest/api/3/dashboard/search',
    queryParameters: {
      if (dashboardName != null) 'dashboardName': dashboardName,
      if (accountId != null) 'accountId': accountId,
      if (owner != null) 'owner': owner,
      if (groupname != null) 'groupname': groupname,
      if (groupId != null) 'groupId': groupId,
      if (projectId != null) 'projectId': '$projectId',
      if (orderBy != null) 'orderBy': orderBy,
      if (startAt != null) 'startAt': '$startAt',
      if (maxResults != null) 'maxResults': '$maxResults',
      if (status != null) 'status': status,
      if (expand != null) 'expand': expand,
    },
  ));
}