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

Class IssueFieldsApi

java.lang.Object

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

public class IssueFieldsApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<FieldDetails>	createCustomField(CustomFieldDefinitionJsonBean customFieldDefinitionJsonBean, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Create custom field Creates a custom field.
io.reactivex.Completable	deleteCustomField(String id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete custom field Deletes a custom field.
io.reactivex.Single<PageBeanContext>	getContextsForFieldDeprecated(String fieldId, Optional<Long> startAt, Optional<Integer> maxResults, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Deprecated.
io.reactivex.Single<List<FieldDetails>>	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
io.reactivex.Single<PageBeanField>	getFieldsPaginated(Optional<Long> startAt, Optional<Integer> maxResults, Optional<List<String>> type, Optional<List<String>> id, Optional<String> query, Optional<String> orderBy, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get fields paginated Returns a [paginated](#pagination) list of fields for Classic Jira projects.
io.reactivex.Single<PageBeanField>	getTrashedFieldsPaginated(Optional<Long> startAt, Optional<Integer> maxResults, Optional<List<String>> id, Optional<String> query, Optional<String> expand, Optional<String> orderBy, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get fields in trash paginated Returns a [paginated](#pagination) list of fields in the trash.
io.reactivex.Single<Object>	restoreCustomField(String id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Restore custom field from trash Restores a custom field from trash.
io.reactivex.Single<Object>	trashCustomField(String id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Move custom field to trash Moves a custom field to trash.
io.reactivex.Single<Object>	updateCustomField(String fieldId, UpdateCustomFieldDetails updateCustomFieldDetails, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Update custom field Updates a custom field.

Methods inherited from class java.lang.Object

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

Constructor Detail

IssueFieldsApi

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

Method Detail

createCustomField

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

Create custom field Creates a custom field. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

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<FieldDetails>

deleteCustomField

public io.reactivex.Completable deleteCustomField(String id,
                                                  Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete custom field Deletes a custom field. The custom field is deleted whether it is in the trash or not. See [Edit or delete a custom field](https://confluence.atlassian.com/x/Z44fOw) for more information on trashing and deleting custom fields. This operation is [asynchronous](#async). Follow the `location` link in the response to determine the status of the task and use [Get task](#api-rest-api-2-task-taskId-get) to obtain subsequent updates. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

id - The ID of a custom field. (required)

restRequestEnhancer -

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

Returns:

Completable

getContextsForFieldDeprecated

@Deprecated
public io.reactivex.Single<PageBeanContext> getContextsForFieldDeprecated(String fieldId,
                                                                                       Optional<Long> startAt,
                                                                                       Optional<Integer> maxResults,
                                                                                       Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Deprecated.

Get contexts for a field Returns a [paginated](#pagination) list of the contexts a field is used in. Deprecated, use [ Get custom field contexts](#api-rest-api-2-field-fieldId-context-get). **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

fieldId - The ID of the field to return contexts for. (required)

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 20)

restRequestEnhancer -

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

Returns:

Single<PageBeanContext>

getFields

public io.reactivex.Single<List<FieldDetails>> 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](https://confluence.atlassian.com/x/yodKLg) for.) This operation can be accessed anonymously. **[Permissions](#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<FieldDetails>>

getFieldsPaginated

public io.reactivex.Single<PageBeanField> getFieldsPaginated(Optional<Long> startAt,
                                                             Optional<Integer> maxResults,
                                                             Optional<List<String>> type,
                                                             Optional<List<String>> id,
                                                             Optional<String> query,
                                                             Optional<String> orderBy,
                                                             Optional<String> expand,
                                                             Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get fields paginated Returns a [paginated](#pagination) list of fields for Classic Jira projects. The list can include: * all fields * specific fields, by defining `id` * fields that contain a string in the field name or description, by defining `query` * specific fields that contain a string in the field name or description, by defining `id` and `query` Only custom fields can be queried, `type` must be set to `custom`. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

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)

type - The type of fields to search. (optional, default to new ArrayList<>())

id - The IDs of the custom fields to return or, where `query` is specified, filter. (optional, default to new ArrayList<>())

query - String used to perform a case-insensitive partial match with field names or descriptions. (optional)

orderBy - [Order](#ordering) the results by a field: * `contextsCount` sorts by the number of contexts related to a field * `lastUsed` sorts by the date when the value of the field last changed * `name` sorts by the field name * `screensCount` sorts by the number of screens related to a field (optional)

expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * `key` returns the key for each field * `lastUsed` returns the date when the value of the field last changed * `screensCount` returns the number of screens related to a field * `contextsCount` returns the number of contexts related to a field * `isLocked` returns information about whether the field is [locked](https://confluence.atlassian.com/x/ZSN7Og) * `searcherKey` returns the searcher key for each custom field (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>

getTrashedFieldsPaginated

public io.reactivex.Single<PageBeanField> getTrashedFieldsPaginated(Optional<Long> startAt,
                                                                    Optional<Integer> maxResults,
                                                                    Optional<List<String>> id,
                                                                    Optional<String> query,
                                                                    Optional<String> expand,
                                                                    Optional<String> orderBy,
                                                                    Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get fields in trash paginated Returns a [paginated](#pagination) list of fields in the trash. The list may be restricted to fields whose field name or description partially match a string. Only custom fields can be queried, `type` must be set to `custom`. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

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)

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

query - String used to perform a case-insensitive partial match with field names or descriptions. (optional)

expand - (optional)

orderBy - [Order](#ordering) the results by a field: * `name` sorts by the field name * `trashDate` sorts by the date the field was moved to the trash * `plannedDeletionDate` sorts by the planned deletion date (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>

restoreCustomField

public io.reactivex.Single<Object> restoreCustomField(String id,
                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Restore custom field from trash Restores a custom field from trash. See [Edit or delete a custom field](https://confluence.atlassian.com/x/Z44fOw) for more information on trashing and deleting custom fields. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

id - The ID of a custom field. (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<Object>

trashCustomField

public io.reactivex.Single<Object> trashCustomField(String id,
                                                    Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Move custom field to trash Moves a custom field to trash. See [Edit or delete a custom field](https://confluence.atlassian.com/x/Z44fOw) for more information on trashing and deleting custom fields. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

id - The ID of a custom field. (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<Object>

updateCustomField

public io.reactivex.Single<Object> updateCustomField(String fieldId,
                                                     UpdateCustomFieldDetails updateCustomFieldDetails,
                                                     Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Update custom field Updates a custom field. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

fieldId - The ID of the custom field. (required)

updateCustomFieldDetails - The custom field update details. (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<Object>