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

Class IssuePropertyBulkUpdateApi

java.lang.Object

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

public class IssuePropertyBulkUpdateApi
extends Object

Constructor Summary

Constructors

Constructor and Description
IssuePropertyBulkUpdateApi(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.

Methods inherited from class java.lang.Object

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

Constructor Detail

IssuePropertyBulkUpdateApi

public IssuePropertyBulkUpdateApi(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. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required:

• Browse projects project permission for each project containing issues.
• If issue-level security is configured, issue-level security permission to view the issue.
• Edit issues project permission 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. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required:

• Browse projects project permission for each project containing issues.
• If issue-level security is configured, issue-level security permission to view the issue.
• Edit issues project permission 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