Class ProjectVersions

Index

Constructors

constructor

Methods

Constructors

constructor

new ProjectVersions(client: Client): Version2.ProjectVersions
Parameters
- client: Client
Returns Version2.ProjectVersions
- Defined in src/version2/projectVersions.ts:8

Methods

createRelatedWork

createRelatedWork<T = Version2Models.VersionRelatedWork>(
parameters: Version2Parameters.CreateRelatedWork,
callback: Callback<T>,
): Promise<void>
Creates a related work for the given version. You can only create a generic link type of related works via this API. relatedWorkId will be auto-generated UUID, that does not need to be provided.

This operation can be accessed anonymously.

Permissions required: Resolve issues: and Edit issues Managing project permissions for the project that contains the version.
Type Parameters
- T = Version2Models.VersionRelatedWork
Parameters
- parameters: Version2Parameters.CreateRelatedWork
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/projectVersions.ts:401
createRelatedWork<T = Version2Models.VersionRelatedWork>(
parameters: Version2Parameters.CreateRelatedWork,
callback?: undefined,
): Promise<T>
Creates a related work for the given version. You can only create a generic link type of related works via this API. relatedWorkId will be auto-generated UUID, that does not need to be provided.

This operation can be accessed anonymously.

Permissions required: Resolve issues: and Edit issues Managing project permissions for the project that contains the version.
Type Parameters
- T = Version2Models.VersionRelatedWork
Parameters
- parameters: Version2Parameters.CreateRelatedWork
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version2/projectVersions.ts:416

createVersion

createVersion<T = Version2Models.Version>(
parameters: Version2Parameters.CreateVersion,
callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = Version2Models.Version
Parameters
- parameters: Version2Parameters.CreateVersion
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/projectVersions.ts:114
createVersion<T = Version2Models.Version>(
parameters: Version2Parameters.CreateVersion,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = Version2Models.Version
Parameters
- parameters: Version2Parameters.CreateVersion
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version2/projectVersions.ts:124

deleteAndReplaceVersion

deleteAndReplaceVersion<T = void>(
parameters: Version2Parameters.DeleteAndReplaceVersion,
callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = void
Parameters
- parameters: Version2Parameters.DeleteAndReplaceVersion
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/projectVersions.ts:503
deleteAndReplaceVersion<T = void>(
parameters: Version2Parameters.DeleteAndReplaceVersion,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = void
Parameters
- parameters: Version2Parameters.DeleteAndReplaceVersion
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version2/projectVersions.ts:522

deleteRelatedWork

deleteRelatedWork<T = void>(
parameters: Version2Parameters.DeleteRelatedWork,
callback: Callback<T>,
): Promise<void>
Deletes the given related work for the given version.

This operation can be accessed anonymously.

Permissions required: Resolve issues: and Edit issues Managing project permissions for the project that contains the version.
Type Parameters
- T = void
Parameters
- parameters: Version2Parameters.DeleteRelatedWork
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/projectVersions.ts:588
deleteRelatedWork<T = void>(
parameters: Version2Parameters.DeleteRelatedWork,
callback?: undefined,
): Promise<T>
Deletes the given related work for the given version.

This operation can be accessed anonymously.

Permissions required: Resolve issues: and Edit issues Managing project permissions for the project that contains the version.
Type Parameters
- T = void
Parameters
- parameters: Version2Parameters.DeleteRelatedWork
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version2/projectVersions.ts:599

getProjectVersions

getProjectVersions<T = Version2Models.Version[]>(
parameters: string | Version2Parameters.GetProjectVersions,
callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = Version2Models.Version[]
Parameters
- parameters: string | Version2Parameters.GetProjectVersions
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/projectVersions.ts:70
getProjectVersions<T = Version2Models.Version[]>(
parameters: string | Version2Parameters.GetProjectVersions,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = Version2Models.Version[]
Parameters
- parameters: string | Version2Parameters.GetProjectVersions
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version2/projectVersions.ts:84

getProjectVersionsPaginated

getProjectVersionsPaginated<T = Version2Models.PageVersion>(
parameters: string | Version2Parameters.GetProjectVersionsPaginated,
callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = Version2Models.PageVersion
Parameters
- parameters: string | Version2Parameters.GetProjectVersionsPaginated
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/projectVersions.ts:20
getProjectVersionsPaginated<T = Version2Models.PageVersion>(
parameters: string | Version2Parameters.GetProjectVersionsPaginated,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = Version2Models.PageVersion
Parameters
- parameters: string | Version2Parameters.GetProjectVersionsPaginated
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version2/projectVersions.ts:34

getRelatedWork

getRelatedWork<T = Version2Models.VersionRelatedWork[]>(
parameters: Version2Parameters.GetRelatedWork,
callback: Callback<T>,
): Promise<void>
Returns related work items for the given version id.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission for the project containing the version.
Type Parameters
- T = Version2Models.VersionRelatedWork[]
Parameters
- parameters: Version2Parameters.GetRelatedWork
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/projectVersions.ts:362
getRelatedWork<T = Version2Models.VersionRelatedWork[]>(
parameters: Version2Parameters.GetRelatedWork,
callback?: undefined,
): Promise<T>
Returns related work items for the given version id.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission for the project containing the version.
Type Parameters
- T = Version2Models.VersionRelatedWork[]
Parameters
- parameters: Version2Parameters.GetRelatedWork
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version2/projectVersions.ts:374

getVersion

getVersion<T = Version2Models.Version>(
parameters: string | Version2Parameters.GetVersion,
callback: Callback<T>,
): Promise<void>
Returns a project version.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission for the project containing the version.
Type Parameters
- T = Version2Models.Version
Parameters
- parameters: string | Version2Parameters.GetVersion
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/projectVersions.ts:165
getVersion<T = Version2Models.Version>(
parameters: string | Version2Parameters.GetVersion,
callback?: undefined,
): Promise<T>
Returns a project version.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission for the project containing the version.
Type Parameters
- T = Version2Models.Version
Parameters
- parameters: string | Version2Parameters.GetVersion
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version2/projectVersions.ts:177

getVersionRelatedIssues

getVersionRelatedIssues<T = Version2Models.VersionIssueCounts>(
parameters: string | Version2Parameters.GetVersionRelatedIssues,
callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = Version2Models.VersionIssueCounts
Parameters
- parameters: string | Version2Parameters.GetVersionRelatedIssues
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/projectVersions.ts:320
getVersionRelatedIssues<T = Version2Models.VersionIssueCounts>(
parameters: string | Version2Parameters.GetVersionRelatedIssues,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = Version2Models.VersionIssueCounts
Parameters
- parameters: string | Version2Parameters.GetVersionRelatedIssues
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version2/projectVersions.ts:336

getVersionUnresolvedIssues

getVersionUnresolvedIssues<T = Version2Models.VersionUnresolvedIssuesCount>(
parameters: string | Version2Parameters.GetVersionUnresolvedIssues,
callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = Version2Models.VersionUnresolvedIssuesCount
Parameters
- parameters: string | Version2Parameters.GetVersionUnresolvedIssues
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/projectVersions.ts:548
getVersionUnresolvedIssues<T = Version2Models.VersionUnresolvedIssuesCount>(
parameters: string | Version2Parameters.GetVersionUnresolvedIssues,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = Version2Models.VersionUnresolvedIssuesCount
Parameters
- parameters: string | Version2Parameters.GetVersionUnresolvedIssues
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version2/projectVersions.ts:560

mergeVersions

mergeVersions<T = void>(
parameters: Version2Parameters.MergeVersions,
callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = void
Parameters
- parameters: Version2Parameters.MergeVersions
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/projectVersions.ts:253
mergeVersions<T = void>(
parameters: Version2Parameters.MergeVersions,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = void
Parameters
- parameters: Version2Parameters.MergeVersions
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version2/projectVersions.ts:267

moveVersion

moveVersion<T = Version2Models.Version>(
parameters: Version2Parameters.MoveVersion,
callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = Version2Models.Version
Parameters
- parameters: Version2Parameters.MoveVersion
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/projectVersions.ts:285
moveVersion<T = Version2Models.Version>(
parameters: Version2Parameters.MoveVersion,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = Version2Models.Version
Parameters
- parameters: Version2Parameters.MoveVersion
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version2/projectVersions.ts:294

updateRelatedWork

updateRelatedWork<T = Version2Models.VersionRelatedWork>(
parameters: Version2Parameters.UpdateRelatedWork,
callback: Callback<T>,
): Promise<void>
Updates the given related work. You can only update generic link related works via Rest APIs. Any archived version related works can't be edited.

This operation can be accessed anonymously.

Permissions required: Resolve issues: and Edit issues Managing project permissions for the project that contains the version.
Type Parameters
- T = Version2Models.VersionRelatedWork
Parameters
- parameters: Version2Parameters.UpdateRelatedWork
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/projectVersions.ts:450
updateRelatedWork<T = Version2Models.VersionRelatedWork>(
parameters: Version2Parameters.UpdateRelatedWork,
callback?: undefined,
): Promise<T>
Updates the given related work. You can only update generic link related works via Rest APIs. Any archived version related works can't be edited.

This operation can be accessed anonymously.

Permissions required: Resolve issues: and Edit issues Managing project permissions for the project that contains the version.
Type Parameters
- T = Version2Models.VersionRelatedWork
Parameters
- parameters: Version2Parameters.UpdateRelatedWork
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version2/projectVersions.ts:465

updateVersion

updateVersion<T = Version2Models.Version>(
parameters: Version2Parameters.UpdateVersion,
callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = Version2Models.Version
Parameters
- parameters: Version2Parameters.UpdateVersion
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/projectVersions.ts:204
updateVersion<T = Version2Models.Version>(
parameters: Version2Parameters.UpdateVersion,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = Version2Models.Version
Parameters
- parameters: Version2Parameters.UpdateVersion
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version2/projectVersions.ts:214

Class ProjectVersions

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version2.ProjectVersions

Methods

createRelatedWork

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

createVersion

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

deleteAndReplaceVersion

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

deleteRelatedWork

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getProjectVersions

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getProjectVersionsPaginated

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getRelatedWork

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getVersion

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getVersionRelatedIssues

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getVersionUnresolvedIssues

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

mergeVersions