Jira.js - Jira Cloud API library
    Preparing search index...

    Interface GetProjectComponentsPaginated

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

    Properties

    componentSource? maxResults? orderBy? projectIdOrKey query? startAt?

    Properties

    componentSource?: string

    The source of the components to return. Can be jira (default), compass or auto. When auto is specified, the API will return connected Compass components if the project is opted into Compass, otherwise it will return Jira components. Defaults to jira.

    jira
    maxResults?: number

    The maximum number of items to return per page.

    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: string | number

    The project ID or project key (case sensitive).

    query?: string

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

    startAt?: number

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

    Settings

    Member Visibility

    On This Page

    Properties