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

Class IssuePropertiesApi

java.lang.Object

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

public class IssuePropertiesApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Completable	bulkDeleteIssueProperty(String propertyKey, IssueFilterForBulkPropertyDelete issueFilterForBulkPropertyDelete, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Bulk delete issue property Deletes a property value from multiple issues.
io.reactivex.Completable	bulkSetIssueProperty(String propertyKey, BulkIssuePropertyUpdateRequest bulkIssuePropertyUpdateRequest, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Bulk set issue property Sets a property value on multiple issues.
io.reactivex.Completable	bulkSetIssuesProperties(IssueEntityProperties issueEntityProperties, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Bulk set issues properties Sets the values of entity properties on issues.
io.reactivex.Completable	deleteIssueProperty(String issueIdOrKey, String propertyKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete issue property Deletes an issue's property.
io.reactivex.Single<EntityProperty>	getIssueProperty(String issueIdOrKey, String propertyKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get issue property Returns the key and value of an issue's property.
io.reactivex.Single<PropertyKeys>	getIssuePropertyKeys(String issueIdOrKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get issue property keys Returns the URLs and keys of an issue's properties.
io.reactivex.Single<Object>	setIssueProperty(String issueIdOrKey, String propertyKey, Object body, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Set issue property Sets the value of an issue's property.

Methods inherited from class java.lang.Object

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

Constructor Detail

IssuePropertiesApi

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

Method Detail

bulkDeleteIssueProperty

public io.reactivex.Completable bulkDeleteIssueProperty(String propertyKey,
                                                        IssueFilterForBulkPropertyDelete issueFilterForBulkPropertyDelete,
                                                        Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Bulk delete issue property Deletes a property value from multiple issues. The issues to be updated can be specified by filter criteria. The criteria the filter used to identify eligible issues are: * `entityIds` Only issues from this list are eligible. * `currentValue` Only issues with the property set to this value are eligible. If both criteria is specified, they are joined with the logical *AND*: only issues that satisfy both criteria are considered eligible. If no filter criteria are specified, all the issues visible to the user and where the user has the EDIT\\_ISSUES permission for the issue are considered eligible. This operation is: * transactional, either the property is deleted from all eligible issues or, when errors occur, no properties are deleted. * [asynchronous](#async). Follow the `location` link in the response to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates. **[Permissions](#permissions) required:** * *Browse projects* [ project permission](https://confluence.atlassian.com/x/yodKLg) for each project containing issues. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. * *Edit issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for each issue.

Parameters:

propertyKey - The key of the property. (required)

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

bulkSetIssueProperty

public io.reactivex.Completable bulkSetIssueProperty(String propertyKey,
                                                     BulkIssuePropertyUpdateRequest bulkIssuePropertyUpdateRequest,
                                                     Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Bulk set issue property Sets a property value on multiple issues. The issues to be updated can be specified by a filter. The filter identifies issues eligible for update using these criteria: * `entityIds` Only issues from this list are eligible. * `currentValue` Only issues with the property set to this value are eligible. * `hasProperty`: * If *true*, only issues with the property are eligible. * If *false*, only issues without the property are eligible. If more than one criteria is specified, they are joined with the logical *AND*: only issues that satisfy all criteria are eligible. If an invalid combination of criteria is provided, an error is returned. For example, specifying a `currentValue` and `hasProperty` as *false* would not match any issues (because without the property the property cannot have a value). The filter is optional. Without the filter all the issues visible to the user and where the user has the EDIT\\_ISSUES permission for the issue are considered eligible. This operation is: * transactional, either all eligible issues are updated or, when errors occur, none are updated. * [asynchronous](#async). Follow the `location` link in the response to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for each project containing issues. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. * *Edit issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for each issue.

Parameters:

propertyKey - The key of the property. The maximum length is 255 characters. (required)

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

bulkSetIssuesProperties

public io.reactivex.Completable bulkSetIssuesProperties(IssueEntityProperties issueEntityProperties,
                                                        Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Bulk set issues properties Sets the values of entity properties on issues. It can set up to 10 entity properties on up to 10,000 issues. The value of the request body must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON. The maximum length of single issue property value is 32768 characters. This operation can be accessed anonymously. This operation is: * transactional, either all properties are updated in all eligible issues or, when errors occur, no properties are updated. * [asynchronous](#async). Follow the `location` link in the response to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates. **[Permissions](#permissions) required:** * *Browse projects* and *Edit issues* [project permissions](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.

Parameters:

issueEntityProperties - Issue properties to be set or updated with values. (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

deleteIssueProperty

public io.reactivex.Completable deleteIssueProperty(String issueIdOrKey,
                                                    String propertyKey,
                                                    Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete issue property Deletes an issue's property. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* and *Edit issues* [project permissions](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.

Parameters:

issueIdOrKey - The key or ID of the issue. (required)

propertyKey - The key of the property. (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

getIssueProperty

public io.reactivex.Single<EntityProperty> getIssueProperty(String issueIdOrKey,
                                                            String propertyKey,
                                                            Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get issue property Returns the key and value of an issue's property. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.

Parameters:

issueIdOrKey - The key or ID of the issue. (required)

propertyKey - The key of the property. (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<EntityProperty>

getIssuePropertyKeys

public io.reactivex.Single<PropertyKeys> getIssuePropertyKeys(String issueIdOrKey,
                                                              Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get issue property keys Returns the URLs and keys of an issue's properties. This operation can be accessed anonymously. **[Permissions](#permissions) required:** Property details are only returned where the user has: * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.

Parameters:

issueIdOrKey - The key or ID of the issue. (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<PropertyKeys>

setIssueProperty

public io.reactivex.Single<Object> setIssueProperty(String issueIdOrKey,
                                                    String propertyKey,
                                                    Object body,
                                                    Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Set issue property Sets the value of an issue's property. Use this resource to store custom data against an issue. The value of the request body must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* and *Edit issues* [project permissions](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.

Parameters:

issueIdOrKey - The ID or key of the issue. (required)

propertyKey - The key of the issue property. The maximum length is 255 characters. (required)

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