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

    Interface SearchResults

    The result of a JQL search.

    interface SearchResults {
        expand?: string;
        issues: AgileModels.Issue[];
        maxResults: number;
        names?: {};
        schema?: {};
        startAt: number;
        total: number;
        warningMessages?: string[];
    }
    Index

    Properties

    expand?: string

    Expand options that include additional search result details in the response.

    issues: AgileModels.Issue[]

    The list of issues found by the search.

    maxResults: number

    The maximum number of results that could be on the page.

    names?: {}

    The ID and name of each field in the search results.

    schema?: {}

    The schema describing the field types in the search results.

    startAt: number

    The index of the first item returned on the page.

    total: number

    The number of results on the page.

    warningMessages?: string[]

    Any warnings related to the JQL query.