Skip to main content
The Deno 2 Release Candidate is here
Learn more
Module

x/jira/src/version3/parameters/getDashboardsPaginated.ts>GetDashboardsPaginated

A JavaScript/TypeScript wrapper for the JIRA Cloud, Service Desk and Agile REST API
MrRefactoring/jira.js
Latest
interface GetDashboardsPaginated
import { type GetDashboardsPaginated } from "https://deno.land/x/jira@v3.0.2/src/version3/parameters/getDashboardsPaginated.ts";

Properties

optional
dashboardName: string

String used to perform a case-insensitive partial match with name.

optional
accountId: string

User account ID used to return dashboards with the matching owner.accountId. This parameter cannot be used with the owner parameter.

optional
groupname: string

As a group's name can change, use of groupId is recommended. Group name used to return dashboards that are shared with a group that matches sharePermissions.group.name. This parameter cannot be used with the groupId parameter.

optional
groupId: string

Group ID used to return dashboards that are shared with a group that matches sharePermissions.group.groupId. This parameter cannot be used with the groupname parameter.

optional
projectId: number

Project ID used to returns dashboards that are shared with a project that matches sharePermissions.project.id.

optional
orderBy:
| "description"
| "-description"
| "+description"
| "favorite_count"
| "-favorite_count"
| "+favorite_count"
| "id"
| "-id"
| "+id"
| "is_favorite"
| "-is_favorite"
| "+is_favorite"
| "name"
| "-name"
| "+name"
| "owner"
| "-owner"
| "+owner"
| string

Order the results by a field:

  • description Sorts by dashboard description. Note that this sort works independently of whether the expand to display the description field is in use.
  • favourite_count Sorts by dashboard popularity.
  • id Sorts by dashboard ID.
  • is_favourite Sorts by whether the dashboard is marked as a favorite.
  • name Sorts by dashboard name.
  • owner Sorts by dashboard owner name.
optional
startAt: number

The index of the first item to return in a page of results (page offset).

optional
maxResults: number

The maximum number of items to return per page.

optional
status:
| "active"
| "archived"
| "deleted"
| string

The status to filter by. It may be active, archived or deleted.

optional
expand:
| "description"
| "owner"
| "viewUrl"
| "favourite"
| "favouritedCount"
| "sharePermissions"
| "editPermissions"
| "isWritable"
| (
| "description"
| "owner"
| "viewUrl"
| "favourite"
| "favouritedCount"
| "sharePermissions"
| "editPermissions"
| "isWritable"
)[]
| string
| string[]

Use expand to include additional information about dashboard in the response. This parameter accepts a comma-separated list. Expand options include:

  • description Returns the description of the dashboard.
  • owner Returns the owner of the dashboard.
  • viewUrl Returns the URL that is used to view the dashboard.
  • favourite Returns isFavourite, an indicator of whether the user has set the dashboard as a favorite.
  • favouritedCount Returns popularity, a count of how many users have set this dashboard as a favorite.
  • sharePermissions Returns details of the share permissions defined for the dashboard.
  • editPermissions Returns details of the edit permissions defined for the dashboard.
  • isWritable Returns whether the current user has permission to edit the dashboard.