Interface SearchPostParams

Body for POST /rest/api/latest/search.

interface SearchPostParams {
    expand?: string[];
    fields?: string[];
    jql?: string;
    maxResults?: number;
    startAt?: number;
    validateQuery?: boolean;
}

Properties

expand? fields? jql? maxResults? startAt? validateQuery?

Properties

Optionalexpand

expand?: string[]

Fields to expand (e.g. ['changelog', 'names'])

Optionalfields

fields?: string[]

Issue fields to include in the response

Optionaljql

jql?: string

JQL query string

OptionalmaxResults

maxResults?: number

Maximum number of results to return. Use 0 for count-only searches.

OptionalstartAt

startAt?: number

Index of the first result (0-based)

OptionalvalidateQuery

validateQuery?: boolean

Whether Jira should validate the JQL query.

Settings

Member Visibility

On This Page

Properties