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

Class VersionApi

java.lang.Object

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

public class VersionApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<Version>	createVersion(Version version, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Create version Creates a project version.
io.reactivex.Single<Object>	deleteAndReplaceVersion(String id, DeleteAndReplaceVersionBean deleteAndReplaceVersionBean, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete and replace version Deletes a project version.
io.reactivex.Completable	deleteVersion(String id, Optional<String> moveFixIssuesTo, Optional<String> moveAffectedIssuesTo, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Deprecated.
io.reactivex.Single<Version>	getVersion(String id, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get version Returns a project version.
io.reactivex.Single<VersionIssueCounts>	getVersionRelatedIssues(String id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get version's related issues count Returns the following counts for a version: Number of issues where the fixVersion is set to the version.
io.reactivex.Single<VersionUnresolvedIssuesCount>	getVersionUnresolvedIssues(String id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get version's unresolved issues count Returns counts of the issues and unresolved issues for the project version.
io.reactivex.Single<Object>	mergeVersions(String id, String moveIssuesTo, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Merge versions Merges two project versions.
io.reactivex.Single<Version>	moveVersion(String id, VersionMoveBean versionMoveBean, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Move version Modifies the version's sequence within the project, which affects the display order of the versions in Jira.
io.reactivex.Single<Version>	updateVersion(String id, Version version, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Update version Updates a project version.

Methods inherited from class java.lang.Object

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

Constructor Detail

VersionApi

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

Method Detail

createVersion

public io.reactivex.Single<Version> createVersion(Version version,
                                                  Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Create version

Creates a project version.

This operation can be accessed anonymously.

Permissions required: Administer Jira global permission or Administer Projects project permission for the project the version is added to.

Parameters:

version - (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<Version>

deleteAndReplaceVersion

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

Delete and replace version

Deletes a project version.

Alternative versions can be provided to update issues that use the deleted version in fixVersion, affectedVersion, or any version picker custom fields. If alternatives are not provided, occurrences of fixVersion, affectedVersion, and any version picker custom field, that contain the deleted version, are cleared. Any replacement version must be in the same project as the version being deleted and cannot be the version being deleted.

This operation can be accessed anonymously.

Permissions required: Administer Jira global permission or Administer Projects project permission for the project that contains the version.

Parameters:

id -

The ID of the version.

(required)

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

deleteVersion

@Deprecated
public io.reactivex.Completable deleteVersion(String id,
                                                           Optional<String> moveFixIssuesTo,
                                                           Optional<String> moveAffectedIssuesTo,
                                                           Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Deprecated.

Delete version

Deletes a project version.

Deprecated, use Delete and replace version that supports swapping version values in custom fields, in addition to the swapping for fixVersion and affectedVersion provided in this resource.

Alternative versions can be provided to update issues that use the deleted version in fixVersion or affectedVersion. If alternatives are not provided, occurrences of fixVersion and affectedVersion that contain the deleted version are cleared.

This operation can be accessed anonymously.

Permissions required: Administer Jira global permission or Administer Projects project permission for the project that contains the version.

Parameters:

id -

The ID of the version.

(required)

moveFixIssuesTo -

The ID of the version to update fixVersion to when the field contains the deleted version. The replacement version must be in the same project as the version being deleted and cannot be the version being deleted.

(optional)

moveAffectedIssuesTo -

The ID of the version to update affectedVersion to when the field contains the deleted version. The replacement version must be in the same project as the version being deleted and cannot be the version being deleted.

(optional)

restRequestEnhancer -

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

Returns:

Completable

getVersion

public io.reactivex.Single<Version> getVersion(String id,
                                               Optional<String> expand,
                                               Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get version

Returns a project version.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission for the project containing the version.

Parameters:

id -

The ID of the version.

(required)

expand -

Use expand to include additional information about version in the response. This parameter accepts multiple values separated by a comma:

• operations Returns the list of operations available for this version.
• issuesstatus Returns the count of issues in this version for each of the status categories to do, in progress, done, and unmapped. The unmapped property represents the number of issues with a status other than to do, in progress, and done.

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

getVersionRelatedIssues

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

Get version's related issues count

Returns the following counts for a version:

• Number of issues where the fixVersion is set to the version.
• Number of issues where the affectedVersion is set to the version.
• Number of issues where a version custom field is set to the version.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission for the project that contains the version.

Parameters:

id -

The ID of the version.

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

getVersionUnresolvedIssues

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

Get version's unresolved issues count

Returns counts of the issues and unresolved issues for the project version.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission for the project that contains the version.

Parameters:

id -

The ID of the version.

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

mergeVersions

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

Merge versions

Merges two project versions. The merge is completed by deleting the version specified in id and replacing any occurrences of its ID in fixVersion with the version ID specified in moveIssuesTo.

Consider using Delete and replace version instead. This resource supports swapping version values in fixVersion, affectedVersion, and custom fields.

This operation can be accessed anonymously.

Permissions required: Administer Jira global permission or Administer Projects project permission for the project that contains the version.

Parameters:

id -

The ID of the version to delete.

(required)

moveIssuesTo -

The ID of the version to merge into.

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

moveVersion

public io.reactivex.Single<Version> moveVersion(String id,
                                                VersionMoveBean versionMoveBean,
                                                Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Move version

Modifies the version's sequence within the project, which affects the display order of the versions in Jira.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission for the project that contains the version.

Parameters:

id -

The ID of the version to be moved.

(required)

versionMoveBean - (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<Version>

updateVersion

public io.reactivex.Single<Version> updateVersion(String id,
                                                  Version version,
                                                  Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Update version

Updates a project version.

This operation can be accessed anonymously.

Permissions required: Administer Jira global permission or Administer Projects project permission for the project that contains the version.

Parameters:

id -

The ID of the version.

(required)

version - (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<Version>