Server
Jira Data Center / Reference / REST API

version

Postman Collection
Operations
GET/api/2/versionPOST/api/2/versionGET/api/2/version/remotelinkGET/api/2/version/{id}PUT/api/2/version/{id}PUT/api/2/version/{id}/mergeto/{moveIssuesTo}POST/api/2/version/{id}/moveGET/api/2/version/{id}/relatedIssueCountsPOST/api/2/version/{id}/removeAndSwapGET/api/2/version/{id}/unresolvedIssueCountGET/api/2/version/{versionId}/remotelinkPOST/api/2/version/{versionId}/remotelinkDEL/api/2/version/{versionId}/remotelinkGET/api/2/version/{versionId}/remotelink/{globalId}POST/api/2/version/{versionId}/remotelink/{globalId}DEL/api/2/version/{versionId}/remotelink/{globalId}
GET

Get paginated versionsExperimental

Retrieve paginated collection of versions matching given query optionally filtered by given project IDs.

Request

Query parameters

maxResults

integer

query

string

projectIds

array<integer>

startAt

integer

Responses

Returned if the versions are successfully retrieved.

application/json

VersionBean
GET/api/2/version
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/version' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
POST

Create new version

Creates a version.

Request

Request bodyapplication/json

JSON containing parameters to create the version with

archived

boolean

description

string

expand

string

id

string

moveUnfixedIssuesTo

string

name

string

overdue

boolean

project

string

projectId

integer

releaseDate

string

Responses

Returned if the version is successfully created.

application/json

VersionBean
POST/api/2/version
1 2 3 4 5 curl --request POST \ --url 'http://{baseurl}/rest/api/2/version' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json'
GET

Returns the remote version links for a given global ID.

globalId

string

Returned if the remote version links are successfully retrieved.

application/json

RemoteEntityLinksJsonBean
GET/api/2/version/remotelink
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/version/remotelink' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
GET

Get version details

Returns a version.

Request

Path parameters

id

string

Required

Query parameters

expand

string

Responses

Returned if the version was found.

application/json

VersionBean
GET/api/2/version/{id}
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/version/{id}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
PUT

Update version details

Updates a version.

Request

Path parameters

id

string

Required

Request bodyapplication/json

JSON containing parameters to update the version with

archived

boolean

description

string

expand

string

id

string

moveUnfixedIssuesTo

string

name

string

overdue

boolean

project

string

projectId

integer

releaseDate

string

Responses

Returned if the version is successfully updated.

PUT/api/2/version/{id}
1 2 3 4 curl --request PUT \ --url 'http://{baseurl}/rest/api/2/version/{id}' \ --user 'email@example.com:<api_token>' \ --header 'Content-Type: application/json'
PUT

Merge versions

Merge versions

Request

Path parameters

moveIssuesTo

string

Required
id

string

Required

Responses

Returned if the version is successfully deleted.

PUT/api/2/version/{id}/mergeto/{moveIssuesTo}
1 2 3 curl --request PUT \ --url 'http://{baseurl}/rest/api/2/version/{id}/mergeto/{moveIssuesTo}' \ --user 'email@example.com:<api_token>'
POST

Modify version's sequence

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

Request

Path parameters

id

string

Required

Request bodyapplication/json

JSON containing parameters to move the version with

after

string

position

string

Responses

Returned if the version is successfully moved.

application/json

VersionBean
POST/api/2/version/{id}/move
1 2 3 4 5 curl --request POST \ --url 'http://{baseurl}/rest/api/2/version/{id}/move' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json'
GET

Get version related issues count

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

Request

Path parameters

id

string

Required

Responses

Returned if the version exists and the currently authenticated user has permission to view it.

application/json

VersionIssueCountsBean
GET/api/2/version/{id}/relatedIssueCounts
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/version/{id}/relatedIssueCounts' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
POST

Delete version and replace values

Delete a project version, removed values will be replaced with ones specified by the parameters.

Request

Path parameters

id

string

Required

Request bodyapplication/json

JSON containing parameters to replace the deleted version with

customFieldReplacementList

array<CustomFieldReplacement>

moveAffectedIssuesTo

integer

moveFixIssuesTo

integer

Responses

Returned if the version is successfully deleted.

POST/api/2/version/{id}/removeAndSwap
1 2 3 4 curl --request POST \ --url 'http://{baseurl}/rest/api/2/version/{id}/removeAndSwap' \ --user 'email@example.com:<api_token>' \ --header 'Content-Type: application/json'
GET

Get version unresolved issues count

Returns the number of unresolved issues for the given version

Request

Path parameters

id

string

Required

Responses

Returned if the version exists and the currently authenticated user has permission to view it.

application/json

VersionUnresolvedIssueCountsBean
GET/api/2/version/{id}/unresolvedIssueCount
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/version/{id}/unresolvedIssueCount' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
GET

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

versionId

string

Required

Returned if the version exists and the currently authenticated user has permission to view it.

application/json

RemoteEntityLinksJsonBean
GET/api/2/version/{versionId}/remotelink
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/version/{versionId}/remotelink' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
POST

Create or update remote version link without global ID

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.

Request

Path parameters

versionId

string

Required

Request bodyapplication/json

JSON containing parameters to create the remote version link with

link

string

name

string

self

string

Responses

Returned if the remote version link is created or updated successfully.

POST/api/2/version/{versionId}/remotelink
1 2 3 4 curl --request POST \ --url 'http://{baseurl}/rest/api/2/version/{versionId}/remotelink' \ --user 'email@example.com:<api_token>' \ --header 'Content-Type: application/json'
DEL

Delete all remote version links for a given version ID.

versionId

string

Required

Returned if the remote version links are successfully deleted.

DEL/api/2/version/{versionId}/remotelink
1 2 3 curl --request DELETE \ --url 'http://{baseurl}/rest/api/2/version/{versionId}/remotelink' \ --user 'email@example.com:<api_token>'
GET

Returns the remote version link associated with the given version ID and global ID.

versionId

string

Required
globalId

string

Required

Returned if the version exists and the currently authenticated user has permission to view it.

application/json

RemoteEntityLinkJsonBean
GET/api/2/version/{versionId}/remotelink/{globalId}
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/version/{versionId}/remotelink/{globalId}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
POST

Create or update remote version link with global ID

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

Request

Path parameters

versionId

string

Required
globalId

string

Required

Request bodyapplication/json

JSON containing parameters to create the remote version link with

link

string

name

string

self

string

Responses

Returned if the remote version link is created or updated successfully.

POST/api/2/version/{versionId}/remotelink/{globalId}
1 2 3 4 curl --request POST \ --url 'http://{baseurl}/rest/api/2/version/{versionId}/remotelink/{globalId}' \ --user 'email@example.com:<api_token>' \ --header 'Content-Type: application/json'
DEL

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

versionId

string

Required
globalId

string

Required

Returned if the remote version link is successfully deleted.

DEL/api/2/version/{versionId}/remotelink/{globalId}
1 2 3 curl --request DELETE \ --url 'http://{baseurl}/rest/api/2/version/{versionId}/remotelink/{globalId}' \ --user 'email@example.com:<api_token>'

Rate this page: