Interface SearchResults

The result of a JQL search.

interface SearchResults {
    expand?: string;
    issues?: IssueBean[];
    maxResults?: number;
    names?: {
        [key: string]: string;
    };
    schema?: {
        [key: string]: JsonTypeBean;
    };
    startAt?: number;
    total?: number;
    warningMessages?: string[];
}

Properties

expand? issues? maxResults? names? schema? startAt? total? warningMessages?

Properties

Optionalexpand

expand?: string

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

Optionalissues

issues?: IssueBean[]

The list of issues found by the search.

OptionalmaxResults

maxResults?: number

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

Optionalnames

names?: {
    [key: string]: string;
}

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

Optionalschema

schema?: {
    [key: string]: JsonTypeBean;
}

The schema describing the field types in the search results.

Type declaration

OptionalstartAt

startAt?: number

The index of the first item returned on the page.

Optionaltotal

total?: number

The number of results on the page.

OptionalwarningMessages

warningMessages?: string[]

Any warnings related to the JQL query.

Settings

Member Visibility

On This Page

Properties