org.everit.atlassian.restclient.jiracloud.v3.api

Class SearchApi

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v3.api.SearchApi

public class SearchApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SearchApi(org.everit.http.restclient.RestClient restClient)

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<SearchResults>	searchForIssuesUsingJql_0(SearchRequestBean searchRequestBean, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Search for issues using JQL (POST) Searches for issues using JQL.
io.reactivex.Single<SearchResults>	searchForIssuesUsingJql(Optional<String> jql, Optional<Integer> startAt, Optional<Integer> maxResults, Optional<String> validateQuery, Optional<List<String>> fields, Optional<String> expand, Optional<List<String>> properties, Optional<Boolean> fieldsByKeys, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Search for issues using JQL (GET) Searches for issues using JQL.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchApi

public SearchApi(org.everit.http.restclient.RestClient restClient)

Method Detail

searchForIssuesUsingJql

public io.reactivex.Single<SearchResults> searchForIssuesUsingJql(Optional<String> jql,
                                                                  Optional<Integer> startAt,
                                                                  Optional<Integer> maxResults,
                                                                  Optional<String> validateQuery,
                                                                  Optional<List<String>> fields,
                                                                  Optional<String> expand,
                                                                  Optional<List<String>> properties,
                                                                  Optional<Boolean> fieldsByKeys,
                                                                  Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Search for issues using JQL (GET)

Searches for issues using JQL.

If the JQL query expression is too large to be encoded as a query parameter, use the POST version of this resource.

This operation can be accessed anonymously.

Permissions required: Issues are included in the response where the user has:

• Browse projects project permission for the project containing the issue.
• If issue-level security is configured, issue-level security permission to view the issue.

Parameters:

jql -

The JQL that defines the search. Note:

• If no JQL expression is provided, all issues are returned.
• username and userkey cannot be used as search terms due to privacy reasons. Use accountId instead.
• If a user has hidden their email address in their user profile, partial matches of the email address will not find the user. An exact match is required.

(optional)

startAt -

The index of the first item to return in a page of results (page offset).

(optional, default to 0)

maxResults -

The maximum number of items to return per page. To manage page size, Jira may return fewer items per page where a large number of fields are requested. The greatest number of items returned per page is achieved when requesting id or key only.

(optional, default to 50)

validateQuery -

Determines how to validate the JQL query and treat the validation results. Supported values are:

• strict Returns a 400 response code if any errors are found, along with a list of all errors (and warnings).
• warn Returns all errors as warnings.
• none No validation is performed.
• true Deprecated A legacy synonym for strict.
• false Deprecated A legacy synonym for warn.

Note: If the JQL is not correctly formed a 400 response code is returned, regardless of the validateQuery value.

(optional, default to strict)

fields -

A comma-separated list of fields to return for each issue, use it to retrieve a subset of fields. Allowed values:

• *all Returns all fields.
• *navigable Returns navigable fields.
• Any issue field, prefixed with a minus to exclude.

Examples:

• summary,comment Returns only the summary and comments fields.
• -description Returns all navigable (default) fields except description.
• *all,-comment Returns all fields except comments.

This parameter may be specified multiple times. For example, fields=field1,field2&fields=field3.

Note: All navigable fields are returned by default. This differs from GET issue where the default is all fields.

(optional, default to new ArrayList<>())

expand -

Use expand to include additional information about issues in the response. This parameter accepts multiple values separated by a comma:

• renderedFields Returns field values rendered in HTML format.
• names Returns the display name of each field.
• schema Returns the schema describing a field type.
• transitions Returns all possible transitions for the issue.
• operations Returns all possible operations for the issue.
• editmeta Returns information about how each field can be edited.
• changelog Returns a list of recent updates to an issue, sorted by date, starting from the most recent.
• versionedRepresentations Instead of fields, returns versionedRepresentations a JSON array containing each version of a field's value, with the highest numbered item representing the most recent version.

(optional)

properties -

A comma-separated list of issue property keys for issue properties to include in the results. This parameter may be specified multiple times. For example, properties=prop1,prop2&properties=prop3. A maximum of 5 issue property keys can be specified.

(optional, default to new ArrayList<>())

fieldsByKeys -

Reference fields by their key (rather than ID).

(optional, default to false)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<SearchResults>

searchForIssuesUsingJql_0

public io.reactivex.Single<SearchResults> searchForIssuesUsingJql_0(SearchRequestBean searchRequestBean,
                                                                    Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Search for issues using JQL (POST)

Searches for issues using JQL.

There is a GET version of this resource that can be used for smaller JQL query expressions.

This operation can be accessed anonymously.

Permissions required: Issues are included in the response where the user has:

• Browse projects project permission for the project containing the issue.
• If issue-level security is configured, issue-level security permission to view the issue.

Parameters:

searchRequestBean -

A JSON object containing the search request.

(required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<SearchResults>