Developer
Get Support
Sign in
Developer
Get Support
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Get support
Sign in
Developer
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Get support
Sign in
  • Approval
  • Customer
  • Customer Request
  • Customer Transition
  • Jira Service Management Application
  • Organization
  • Organization Service Desk
  • Portals
  • Queue
  • Queue Settings
  • Request Attachment
  • Request Type
  • Request Type Permissions
  • Service Desk
  • Service Desk Customer
  • application-properties
  • applicationrole
  • attachment
  • avatar
  • cluster
  • comment
  • component
  • configuration
  • customFieldOption
  • customFields
  • dashboard
  • email-templates
  • field
  • filter
  • group
  • groups
  • groupuserpicker
  • index
  • index-snapshot
  • issue
  • issueLink
  • issueLinkType
  • issuesecurityschemes
  • issuetype
  • issuetypescheme
  • jql
  • licenseValidator
  • monitoring
  • mypermissions
  • mypreferences
  • myself
  • notificationscheme
  • password
  • permissions
  • permissionscheme
  • priority
  • priorityschemes
  • project
  • projectCategory
  • projects
  • projectvalidate
  • reindex
  • resolution
  • role
  • screens
  • search
  • searchLimits
  • securitylevel
  • serverInfo
  • session
  • settings
  • status
  • statuscategory
  • terminology
  • universal_avatar
  • upgrade
  • user
  • version
  • websudo
  • workflow
  • workflowscheme
  • worklog
  • Assets - AQL
  • Assets - Analytics
  • Assets - Archived Objects
  • Assets - Attachments
  • Assets - Comments
  • Assets - Icons
  • Assets - Index Configuration
  • Assets - Object
  • Assets - Object Archive
  • Assets - Object Attribute
  • Assets - Object Connected Tickets
  • Assets - Object Restore
  • Assets - Object Schema
  • Assets - Object Type
  • Assets - Object Type Attribute
  • Assets - Progress
  • Assets - QR Code
  • Assets - Status Types
Server
Jira Service Management / Reference / REST API

version

Postman Collection
OpenAPI
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.

Forge and OAuth2 apps cannot access this REST resource.

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'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 { "archived": false, "description": "An excellent version", "expand": "10000", "id": "10000", "moveUnfixedIssuesTo": "http://localhost:8090/jira/rest/api/2/version/10000/move", "name": "New Version 1", "overdue": true, "project": "PXA", "projectId": 10000, "releaseDate": "<string>", "releaseDateSet": false, "released": true, "self": "http://localhost:8090/jira/rest/api/2/version/10000", "startDate": "<string>", "startDateSet": false, "userReleaseDate": "2012-09-15T21:11:01.834+0000", "userStartDate": "2012-08-15T21:11:01.834+0000" }
POST

Create new version

Creates a version.

Forge and OAuth2 apps cannot access this REST resource.

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 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 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' \ --data '{ "archived": false, "description": "An excellent version", "expand": "10000", "id": "10000", "moveUnfixedIssuesTo": "http://localhost:8090/jira/rest/api/2/version/10000/move", "name": "New Version 1", "overdue": true, "project": "PXA", "projectId": 10000, "releaseDate": "<string>", "releaseDateSet": false, "released": true, "self": "http://localhost:8090/jira/rest/api/2/version/10000", "startDate": "<string>", "startDateSet": false, "userReleaseDate": "2012-09-15T21:11:01.834+0000", "userStartDate": "2012-08-15T21:11:01.834+0000" }'
201Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 { "archived": false, "description": "An excellent version", "expand": "10000", "id": "10000", "moveUnfixedIssuesTo": "http://localhost:8090/jira/rest/api/2/version/10000/move", "name": "New Version 1", "overdue": true, "project": "PXA", "projectId": 10000, "releaseDate": "<string>", "releaseDateSet": false, "released": true, "self": "http://localhost:8090/jira/rest/api/2/version/10000", "startDate": "<string>", "startDateSet": false, "userReleaseDate": "2012-09-15T21:11:01.834+0000", "userStartDate": "2012-08-15T21:11:01.834+0000" }
GET

Returns the remote version links for a given global ID.

Forge and OAuth2 apps cannot access this REST resource.

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'
200Response
1 2 3 4 5 6 7 8 9 { "links": [ { "link": "{\"rel\":\"issue\",\"url\":\"http://www.example.com/jira/rest/api/2/issue/10000\"}", "name": "Issue 10000", "self": "http://www.example.com/jira/rest/api/2/issue/10000" } ] }
GET

Get version details

Returns a version.

Forge and OAuth2 apps cannot access this REST resource.

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'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 { "archived": false, "description": "An excellent version", "expand": "10000", "id": "10000", "moveUnfixedIssuesTo": "http://localhost:8090/jira/rest/api/2/version/10000/move", "name": "New Version 1", "overdue": true, "project": "PXA", "projectId": 10000, "releaseDate": "<string>", "releaseDateSet": false, "released": true, "self": "http://localhost:8090/jira/rest/api/2/version/10000", "startDate": "<string>", "startDateSet": false, "userReleaseDate": "2012-09-15T21:11:01.834+0000", "userStartDate": "2012-08-15T21:11:01.834+0000" }
PUT

Update version details

Updates a version.

Forge and OAuth2 apps cannot access this REST resource.

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 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 curl --request PUT \ --url 'http://{baseurl}/rest/api/2/version/{id}' \ --user 'email@example.com:<api_token>' \ --header 'Content-Type: application/json' \ --data '{ "archived": false, "description": "An excellent version", "expand": "10000", "id": "10000", "moveUnfixedIssuesTo": "http://localhost:8090/jira/rest/api/2/version/10000/move", "name": "New Version 1", "overdue": true, "project": "PXA", "projectId": 10000, "releaseDate": "<string>", "releaseDateSet": false, "released": true, "self": "http://localhost:8090/jira/rest/api/2/version/10000", "startDate": "<string>", "startDateSet": false, "userReleaseDate": "2012-09-15T21:11:01.834+0000", "userStartDate": "2012-08-15T21:11:01.834+0000" }'
PUT

Merge versions

Merge versions

Forge and OAuth2 apps cannot access this REST resource.

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

Forge and OAuth2 apps cannot access this REST resource.

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 6 7 8 9 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' \ --data '{ "after": "http://localhost:8090/jira/rest/api/2/version/10000", "position": "Earlier" }'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 { "archived": false, "description": "An excellent version", "expand": "10000", "id": "10000", "moveUnfixedIssuesTo": "http://localhost:8090/jira/rest/api/2/version/10000/move", "name": "New Version 1", "overdue": true, "project": "PXA", "projectId": 10000, "releaseDate": "<string>", "releaseDateSet": false, "released": true, "self": "http://localhost:8090/jira/rest/api/2/version/10000", "startDate": "<string>", "startDateSet": false, "userReleaseDate": "2012-09-15T21:11:01.834+0000", "userStartDate": "2012-08-15T21:11:01.834+0000" }
GET

Get version related issues count

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

Forge and OAuth2 apps cannot access this REST resource.

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'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 { "customFieldNames": [ { "customFieldId": 10000, "fieldName": "Field1", "issueCountWithVersionInCustomField": 2 } ], "issueCountWithCustomFieldsShowingVersion": 54, "issuesAffectedCount": 101, "issuesFixedCount": 23, "self": "http://www.example.com/jira/rest/api/2/version/10000" }
POST

Delete version and replace values

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

Forge and OAuth2 apps cannot access this REST resource.

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 5 6 7 8 9 10 11 12 13 14 curl --request POST \ --url 'http://{baseurl}/rest/api/2/version/{id}/removeAndSwap' \ --user 'email@example.com:<api_token>' \ --header 'Content-Type: application/json' \ --data '{ "customFieldReplacementList": [ { "customFieldId": 2002, "moveTo": 10003 } ], "moveAffectedIssuesTo": 10002, "moveFixIssuesTo": 10001 }'
GET

Get version unresolved issues count

Returns the number of unresolved issues for the given version

Forge and OAuth2 apps cannot access this REST resource.

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'
200Response
1 2 3 4 { "issuesUnresolvedCount": 23, "self": "http://www.example.com/jira/rest/api/2/version/10000" }
GET

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

Forge and OAuth2 apps cannot access this REST resource.

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'
200Response
1 2 3 4 5 6 7 8 9 { "links": [ { "link": "{\"rel\":\"issue\",\"url\":\"http://www.example.com/jira/rest/api/2/issue/10000\"}", "name": "Issue 10000", "self": "http://www.example.com/jira/rest/api/2/issue/10000" } ] }
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.

Forge and OAuth2 apps cannot access this REST resource.

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 5 6 7 8 9 curl --request POST \ --url 'http://{baseurl}/rest/api/2/version/{versionId}/remotelink' \ --user 'email@example.com:<api_token>' \ --header 'Content-Type: application/json' \ --data '{ "link": "{\"rel\":\"issue\",\"url\":\"http://www.example.com/jira/rest/api/2/issue/10000\"}", "name": "Issue 10000", "self": "http://www.example.com/jira/rest/api/2/issue/10000" }'
DEL

Delete all remote version links for a given version ID.

Forge and OAuth2 apps cannot access this REST resource.

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.

Forge and OAuth2 apps cannot access this REST resource.

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'
200Response
1 2 3 4 5 { "link": "{\"rel\":\"issue\",\"url\":\"http://www.example.com/jira/rest/api/2/issue/10000\"}", "name": "Issue 10000", "self": "http://www.example.com/jira/rest/api/2/issue/10000" }
POST

Create or update remote version link with global ID

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

Forge and OAuth2 apps cannot access this REST resource.

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 5 6 7 8 9 curl --request POST \ --url 'http://{baseurl}/rest/api/2/version/{versionId}/remotelink/{globalId}' \ --user 'email@example.com:<api_token>' \ --header 'Content-Type: application/json' \ --data '{ "link": "{\"rel\":\"issue\",\"url\":\"http://www.example.com/jira/rest/api/2/issue/10000\"}", "name": "Issue 10000", "self": "http://www.example.com/jira/rest/api/2/issue/10000" }'
DEL

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

Forge and OAuth2 apps cannot access this REST resource.

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: