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

Class FieldApi

java.lang.Object

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

public class FieldApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<FieldDeprecated>	createCustomField(CustomFieldDefinitionJsonBean customFieldDefinitionJsonBean, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Create custom field Creates a custom field.
io.reactivex.Single<List<FieldDeprecated>>	getFields(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get fields Returns system and custom issue fields according to the following rules: Fields that cannot be added to the issue navigator are always returned.

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldApi

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

Method Detail

createCustomField

public io.reactivex.Single<FieldDeprecated> createCustomField(CustomFieldDefinitionJsonBean customFieldDefinitionJsonBean,
                                                              Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Create custom field

Creates a custom field.

Permissions required: Administer Jira global permission.

Parameters:

customFieldDefinitionJsonBean -

Definition of the custom field to be created

(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<FieldDeprecated>

getFields

public io.reactivex.Single<List<FieldDeprecated>> getFields(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get fields

Returns system and custom issue fields according to the following rules:

• Fields that cannot be added to the issue navigator are always returned.
• Fields that cannot be placed on an issue screen are always returned.
• Fields that depend on global Jira settings are only returned if the setting is enabled. That is, timetracking fields, subtasks, votes, and watches.
• For all other fields, this operation only returns the fields that the user has permission to view (that is, the field is used in at least one project that the user has Browse Projects project permission for.)

This operation can be accessed anonymously.

Permissions required: None.

Parameters:

restRequestEnhancer -

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

Returns:

Single<List<FieldDeprecated>>