com.atlassian.jira.rest.v2.issue

Class VersionResource

java.lang.Object

com.atlassian.jira.rest.v2.issue.VersionResource

public class VersionResource
extends Object

Since:

4.2

Constructor Summary

Constructors

Constructor and Description

VersionResource(VersionService versionService, ProjectService projectService, JiraAuthenticationContext authContext, I18nHelper i18n, RemoteVersionLinkResource remoteVersionLinkResource, VersionBeanFactory versionBeanFactory, VersionIssueCountsBeanFactory versionIssueCountsBeanFactory, VersionUnresolvedIssueCountsBeanFactory versionUnresolvedIssueCountsBeanFactory, DateFieldFormat dateFieldFormat, com.atlassian.event.api.EventPublisher eventPublisher)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createOrUpdateRemoteVersionLink(String versionId, String json) Create a remote version link via POST.
javax.ws.rs.core.Response	createOrUpdateRemoteVersionLink(String versionId, String globalId, String json) Create a remote version link via POST using the provided global ID.
javax.ws.rs.core.Response	createVersion(VersionBean bean) Create a version via POST.
javax.ws.rs.core.Response	delete(String id, DeleteAndReplaceVersionBean parameters) Delete a project version.
javax.ws.rs.core.Response	delete(String id, String moveFixIssuesTo, String moveAffectedIssuesTo) Deprecated. use delete(String, DeleteAndReplaceVersionBean) that supports swapping version in custom fields. Since v7.0.6
javax.ws.rs.core.Response	deleteRemoteVersionLink(String versionId, String globalId) Delete a specific remote version link with the given version ID and global ID.
javax.ws.rs.core.Response	deleteRemoteVersionLinksByVersionId(String versionId) Delete all remote version links for a given version ID.
javax.ws.rs.core.Response	getRemoteVersionLink(String versionId, String globalId) A REST sub-resource representing a remote version link
javax.ws.rs.core.Response	getRemoteVersionLinks(String globalId) Returns the remote version links for a given global ID.
javax.ws.rs.core.Response	getRemoteVersionLinksByVersionId(String versionId) Returns the remote version links associated with the given version ID.
javax.ws.rs.core.Response	getVersion(String id, String expand) Returns a project version.
javax.ws.rs.core.Response	getVersionRelatedIssues(String id) Returns a bean containing the number of fixed in and affected issues for the given version.
javax.ws.rs.core.Response	getVersionUnresolvedIssues(String id) Returns the number of unresolved issues for the given version
javax.ws.rs.core.Response	merge(String id, String moveIssuesTo) Merge versions
javax.ws.rs.core.Response	moveVersion(String id, VersionMoveBean bean) Modify a version's sequence within a project.
javax.ws.rs.core.Response	updateVersion(String id, VersionBean bean) Modify a version via PUT.

Methods inherited from class java.lang.Object

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

Constructor Detail

VersionResource

public VersionResource(VersionService versionService,
                       ProjectService projectService,
                       JiraAuthenticationContext authContext,
                       I18nHelper i18n,
                       RemoteVersionLinkResource remoteVersionLinkResource,
                       VersionBeanFactory versionBeanFactory,
                       VersionIssueCountsBeanFactory versionIssueCountsBeanFactory,
                       VersionUnresolvedIssueCountsBeanFactory versionUnresolvedIssueCountsBeanFactory,
                       DateFieldFormat dateFieldFormat,
                       com.atlassian.event.api.EventPublisher eventPublisher)

Method Detail

getVersion

public javax.ws.rs.core.Response getVersion(String id,
                                            String expand)

Returns a project version.

Parameters:

id - a String containing the version id

Returns:

a project version

updateVersion

public javax.ws.rs.core.Response updateVersion(String id,
                                               VersionBean bean)

Modify a version via PUT. Any fields present in the PUT will override existing values. As a convenience, if a field is not present, it is silently ignored.

createVersion

public javax.ws.rs.core.Response createVersion(VersionBean bean)

Create a version via POST.

delete

public javax.ws.rs.core.Response delete(String id,
                                        String moveFixIssuesTo,
                                        String moveAffectedIssuesTo)

Deprecated. use delete(String, DeleteAndReplaceVersionBean) that supports swapping version in custom fields. Since v7.0.6

Delete a project version.

Parameters:

id - The version to delete

moveFixIssuesTo - The version to set fixVersion to on issues where the deleted version is the fix version, If null then the fixVersion is removed.

moveAffectedIssuesTo - The version to set affectedVersion to on issues where the deleted version is the affected version, If null then the affectedVersion is removed.

Returns:

An empty or error response.

delete

public javax.ws.rs.core.Response delete(String id,
                                        DeleteAndReplaceVersionBean parameters)

Delete a project version.

Parameters:

id - The version to delete

parameters - specifies what version should replace given version in fields.

Returns:

An empty or error response.

merge

public javax.ws.rs.core.Response merge(String id,
                                       String moveIssuesTo)

Merge versions

Parameters:

id - The version that will be merged to version moveIssuesTo and removed

moveIssuesTo - The version to set fixVersion to on issues where the deleted version is the fix version, If null then the fixVersion is removed.

Returns:

An empty or error response.

getVersionRelatedIssues

public javax.ws.rs.core.Response getVersionRelatedIssues(String id)

Returns a bean containing the number of fixed in and affected issues for the given version.

Parameters:

id - a String containing the version id

Returns:

an issue counts bean

getVersionUnresolvedIssues

public javax.ws.rs.core.Response getVersionUnresolvedIssues(String id)

Returns the number of unresolved issues for the given version

Parameters:

id - a String containing the version id

Returns:

an unresolved issue count bean

moveVersion

public javax.ws.rs.core.Response moveVersion(String id,
                                             VersionMoveBean bean)

Modify a version's sequence within a project.

The move version bean has 2 alternative field value pairs:

position

An absolute position, which may have a value of 'First', 'Last', 'Earlier' or 'Later'

after

A version to place this version after. The value should be the self link of another version

Parameters:

id - a String containing the version id

bean - a MoveVersionBean that describes the move to be performed.

Returns:

a project version

getRemoteVersionLinks

public javax.ws.rs.core.Response getRemoteVersionLinks(String globalId)

Returns the remote version links for a given global ID.

Parameters:

globalId - the global ID of the remote resource that is linked to the versions

Returns:

a remote version link

getRemoteVersionLinksByVersionId

public javax.ws.rs.core.Response getRemoteVersionLinksByVersionId(String versionId)

Returns the remote version links associated with the given version ID.

Parameters:

versionId - a String containing the version ID

Returns:

the remote links for that project version

getRemoteVersionLink

public javax.ws.rs.core.Response getRemoteVersionLink(String versionId,
                                                      String globalId)

A REST sub-resource representing a remote version link

Parameters:

versionId - a String containing the version id

globalId - The id of the remote issue link to be returned. If null (not provided) all remote links for the issue are returned.

Remote version links follow the same general rules that Issue Links do, except that they are permitted to use any arbitrary well-formed JSON data format with no restrictions imposed. It is recommended, but not required, that they follow the same format used for Remote Issue Links, as described at https://developer.atlassian.com/display/JIRADEV/Fields+in+Remote+Issue+Links.

Returns:

if no globalId is specified, a Response containing a RemoteEntityLinksJsonBeans is returned. Otherwise, a Response containing a RemoteEntityLinkJsonBean with the given globalId is returned.

createOrUpdateRemoteVersionLink

public javax.ws.rs.core.Response createOrUpdateRemoteVersionLink(String versionId,
                                                                 String json)

Create a remote version link via POST. The link's global ID will be taken from the JSON payload if provided; otherwise, it will be generated.

createOrUpdateRemoteVersionLink

public javax.ws.rs.core.Response createOrUpdateRemoteVersionLink(String versionId,
                                                                 String globalId,
                                                                 String json)

Create a remote version link via POST using the provided global ID.

deleteRemoteVersionLinksByVersionId

public javax.ws.rs.core.Response deleteRemoteVersionLinksByVersionId(String versionId)

Delete all remote version links for a given version ID.

Parameters:

versionId - The version for which to delete ALL existing remote version links

Returns:

An empty or error response.

deleteRemoteVersionLink

public javax.ws.rs.core.Response deleteRemoteVersionLink(String versionId,
                                                         String globalId)

Delete a specific remote version link with the given version ID and global ID.

Parameters:

versionId - The version ID of the remote link

globalId - The global ID of the remote link

Returns:

An empty or error response.