Wiki

Clone wiki

versionmanager / REST API

Version Manager for JIRA REST API

To create the corresponding URL for your JIRA instance please follow the following URL pattern, where {key} is project key. Use GET method to load.

#!text
http://{YOUR_JIRA_HOME_URL}/rest/versionmanager/1.0/versionmanager/{key}

An example would be the following.

#!text
http://localhost:2990/jira/rest/versionmanager/1.0/versionmanager/FCTA

Getting versions

To get all versions available for a custom field for a project use the following URL pattern incl. project key. Use GET method to load.

#!text
http://localhost:2990/jira/rest/versionmanager/1.0/versionmanager/FCTA

This returns a JSON or XML with list of versions.

#!json
[
 {"name":"0.5","id":10200,"status":"Released","description":"Core functionality without UI design"},
 {"name":"1.0","id":10300,"status":"Released","description":"First public release"}
]

Adding versions

You can add a new version to an existing project using project key. Use POST method to load.

#!text
http://localhost:2990/jira/rest/versionmanager/1.0/versionmanager/FCTA

In the POST parameter when loading the URL add a JSON object representing the new option value.

#!json
{"name":"1.1","status":"Released","description":"New customer UI to set delivery date"}

As response you get a JSON object of the newly added option value now including its id.

#!json
{"name":"1.1","id":10400,"status":"Released","description":"New customer UI to set delivery date"}
A more complex JSON object including start and release date see below. Please notice that you have to use JavaScript date format dd/MMM/yy

#!json
{"name":"Christmas","id":10200,"description":"Customer present with new features","startdate":"01/Dec/17","releasedate":"24/Dec/17","status":"Released"}

Releasing versions

To set an existing version to released use the following URL pattern using project key and version id. Please use PUT method.

#!text
http://localhost:2990/jira/rest/versionmanager/1.0/versionmanager/FCTA/10400

In the PUT parameter when loading the URL add a JSON object with version id and released attribute.

#!json
{"id":10400,"status":"Released"}

Updating versions

To update a existing version use the following URL pattern using project key and version id. Please use PUT method.

#!text
http://localhost:2990/jira/rest/versionmanager/1.0/versionmanager/FCTA/10400

In the PUT parameter when loading the URL add a JSON object representing the updated version.

#!json
{"name":"1.1","id":10400,"status":"Released","description":"New customer UI to set due date"}

Updated