Interface JiraSearchResponse

Response body from GET /rest/api/latest/search or POST /rest/api/latest/search.

interface JiraSearchResponse {
    expand?: string;
    issues: JiraIssue[];
    maxResults: number;
    maxResultWindow?: number;
    names?: Record<string, string>;
    startAt: number;
    total: number;
    warningMessages?: string[];
}

Properties

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

Properties

Optionalexpand

expand?: string

URL used to perform the search

issues

issues: JiraIssue[]

Issues in this page

maxResults

maxResults: number

Maximum number of results requested

OptionalmaxResultWindow

maxResultWindow?: number

Search result window limit exposed by Jira Data Center.

Optionalnames

names?: Record<string, string>

Field name → display name mapping (when expand=names)

startAt

startAt: number

Index of the first result

total

total: number

Total number of issues matching the query

OptionalwarningMessages

warningMessages?: string[]

Warning messages from the JQL validator

Settings

Member Visibility

On This Page

Properties