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

x/jira/src/version3/parameters/getProjectComponentsPaginated.ts>GetProjectComponentsPaginated

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

Properties

projectIdOrKey: string

The project ID or project key (case sensitive).

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
orderBy:
| "description"
| "-description"
| "+description"
| "issueCount"
| "-issueCount"
| "+issueCount"
| "lead"
| "-lead"
| "+lead"
| "name"
| "-name"
| "+name"
| string

Order the results by a field:

  • description Sorts by the component description.
  • issueCount Sorts by the count of issues associated with the component.
  • lead Sorts by the user key of the component's project lead.
  • name Sorts by component name.
optional
query: string

Filter the results using a literal string. Components with a matching name or description are returned (case insensitive).