Class: Search

Search

Search Resource for searches.

Properties:
Name Type Description
connector IConnector

the jira connector instance

Source:

Methods

Searches for issues using JQL.

Sorting the jql parameter is a full JQL expression, and includes an ORDER BY clause.

The fields param (which can be specified multiple times) gives a comma-separated list of fields to include in the response. This can be used to retrieve a subset of fields. A particular field can be excluded by prefixing it with a minus.

By default, only navigable (navigable) fields are returned in this search resource. Note: the default is different in the get-issue resource -- the default there all fields (all).

all - include all fields navigable - include just navigable fields summary,comment - include just the summary and comments -description - include navigable fields except the description (the default is navigable for search) all,-comment - include everything except comments

GET vs POST: If the JQL query is too large to be encoded as a query param you should instead POST to this resource.

Expanding Issues in the Search Result: It is possible to expand the issues returned by directly specifying the expansion on the expand parameter passed in to this resources.

For instance, to expand the "changelog" for all the issues on the search result, it is neccesary to specify "changelog" as one of the values to expand. a JQL query stringthe index of the first issue to return (0-based)the maximum number of issues to return (defaults to 50). The maximum allowable value is dictated by the JIRA property 'jira.search.views.default.max'. If you specify a value that is higher than this number, your search results will be truncated.Default: truewhether to validate the JQL querythe list of fields to return for each issue. By default, all navigable fields are returned.A comma-separated list of the parameters to expand.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
jql string

jql a JQL query string

startAt string

startAt the index of the first issue to return (0-based)

maxResults string

maxResults the maximum number of issues to return (defaults to 50). The maximum allowable value is dictated by the JIRA property 'jira.search.views.default.max'. If you specify a value that is higher than this number, your search results will be truncated.

validateQuery string

validateQuery Default: truewhether to validate the JQL query

fields string

fields the list of fields to return for each issue. By default, all navigable fields are returned.

expand string

expand A comma-separated list of the parameters to expand.

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

searchUsingSearchRequest(options, callbackopt) → {Promise.<any>}

Performs a search using JQL.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
jql string

jql

startAt string

startAt

maxResults string

maxResults

fields string

fields

validateQuery string

validateQuery

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>