The GetVersion API doesn't have the capability to search by the version name. We use the Version Sync for Jira plugin across a large number of engineering projects which can contribute to a release. Once the version has been released, we update the version to released and then archived to ensure future engineering work cannot be tagged with that version. A single release can be deployed across a number of different environments. When a version is released to the first environment, the version is now considered released and the version is marked as released and archived.
Our Change Management system is aware of the release versions but is not part of the Version Sync process. Versions need to be available in the Change Management system because deployments to certain environments may occur a week or two after the first environment has been deployed.
Has anyone found a way to discover the ID of a release object using the release name via an API call?
@Richard A_ Michaels Have you tried using the Get project versions paginated REST API?
This endpoint allows you to pass the version name via the query parameter, which searches across both the version name and description, returning only the matching results.
It endpoint also allows you to search for versions using the status parameter taking in released, unreleased, and archived values.
@Akash Singh Can you give me an example where this has been done?
Name is not listed on the API as a query parameter
You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.
@Richard A_ Michaels You need to pass the name in the query parameter as shown in example below
GET /rest/api/3/project/{projectIdOrKey}/version?query=myVersionName&status=archived
You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.
You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.
Hi @Richard A_ Michaels ,
Jira Cloud does not provide an API to search versions by name. Versions are project-scoped, so the same release name can exist in multiple projects with different IDs, and the REST API requires you to already know the project (or enumerate all projects and scan their versions).
If the goal is discovering the version ID(s) when you only know the version name, Versions Usage for Jira one of the apps released by our team, helps in practice:
You can search by version name
The report shows version name, project, and version ID
Released and archived versions are included
The data can be exported to CSV, which makes it easy to feed version IDs into external systems like Change Management
This is especially useful in Version Sync setups where the same release exists across many projects and you need to identify all corresponding version IDs after the version has already been released and archived.
It doesn’t replace the Jira REST API, but it removes the manual effort of resolving version name → project → version ID, which Jira does not expose directly.
Regards,
Petru
You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.
Hello @Richard A_ Michaels
I'm Bartek, from Orbiscend OU - ARGON app provider
If you are open for third party apps, maybe you can find solution with our ARGON app.
With advance JQL search function like ex. fieldValue, Regex.
field operator fieldValue("subquery", "field_name")
issue in regex("subquery", "field", "pattern")
Hope you will find suitable solution.
Have a good day
Bartek
You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.
You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.