Interface GetProjectComponentsPaginated

interface GetProjectComponentsPaginated {
    maxResults?: number;
    orderBy?: string;
    projectIdOrKey: string;
    query?: string;
    startAt?: number;
}

Properties

maxResults? orderBy? projectIdOrKey query? startAt?

Properties

Optional maxResults

maxResults?: number

The maximum number of items to return per page.

Optional orderBy

orderBy?: 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.

projectIdOrKey

projectIdOrKey: string

The project ID or project key (case sensitive).

Optional query

query?: string

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

Optional startAt

startAt?: number

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

Settings

Member Visibility

Theme

On This Page

maxResultsorderByprojectIdOrKeyquerystartAt