Module project_versions_api

Structs

CreateVersionParams

struct for passing parameters to the method create_version

DeleteAndReplaceVersionParams

struct for passing parameters to the method delete_and_replace_version

DeleteVersionParams

struct for passing parameters to the method delete_version

GetProjectVersionsPaginatedParams

struct for passing parameters to the method get_project_versions_paginated

GetProjectVersionsParams

struct for passing parameters to the method get_project_versions

GetVersionParams

struct for passing parameters to the method get_version

GetVersionRelatedIssuesParams

struct for passing parameters to the method get_version_related_issues

GetVersionUnresolvedIssuesParams

struct for passing parameters to the method get_version_unresolved_issues

MergeVersionsParams

struct for passing parameters to the method merge_versions

MoveVersionParams

struct for passing parameters to the method move_version

UpdateVersionParams

struct for passing parameters to the method update_version

Enums

CreateVersionError

struct for typed errors of method create_version

DeleteAndReplaceVersionError

struct for typed errors of method delete_and_replace_version

DeleteVersionError

struct for typed errors of method delete_version

GetProjectVersionsError

struct for typed errors of method get_project_versions

GetProjectVersionsPaginatedError

struct for typed errors of method get_project_versions_paginated

GetVersionError

struct for typed errors of method get_version

GetVersionRelatedIssuesError

struct for typed errors of method get_version_related_issues

GetVersionUnresolvedIssuesError

struct for typed errors of method get_version_unresolved_issues

MergeVersionsError

struct for typed errors of method merge_versions

MoveVersionError

struct for typed errors of method move_version

UpdateVersionError

struct for typed errors of method update_version

Functions

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.

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.

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.

get_project_versions

Returns all versions in a project. The response is not paginated. Use Get project versions paginated if you want to get the versions in a project with pagination. This operation can be accessed anonymously. Permissions required: Browse Projects project permission for the project.

get_project_versions_paginated

Returns a paginated list of all versions in a project. See the Get project versions resource if you want to get a full list of versions without pagination. This operation can be accessed anonymously. Permissions required: Browse Projects project permission for the project.

get_version

Returns a project version. This operation can be accessed anonymously. Permissions required: Browse projects project permission for the project containing the version.

get_version_related_issues

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.

get_version_unresolved_issues

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.

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.

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.

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.