org.everit.atlassian.restclient.jiracloud.v2.api

Class FieldSearchApi

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v2.api.FieldSearchApi

public class FieldSearchApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<PageBeanField>	getFieldsPaginated(Optional<Long> startAt, Optional<Integer> maxResults, Optional<Boolean> isCustom, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get fields paginated Returns a paginated list of fields for Classic Jira projects.

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldSearchApi

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

Method Detail

getFieldsPaginated

public io.reactivex.Single<PageBeanField> getFieldsPaginated(Optional<Long> startAt,
                                                             Optional<Integer> maxResults,
                                                             Optional<Boolean> isCustom,
                                                             Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get fields paginated

Returns a paginated list of fields for Classic Jira projects. Only custom fields can be queried, isCustom must be set to true.

Permissions required: Administer Jira global permission.

Parameters:

startAt -

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

(optional, default to 0l)

maxResults -

The maximum number of items to return per page.

(optional, default to 50)

isCustom -

Should endpoint return Custom Fields (true), System Fields (false), or both (unset)

(optional)

restRequestEnhancer -

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

Returns:

Single<PageBeanField>