-
Bug
-
Resolution: Timed out
-
Low
-
2
-
Minor
-
0
-
Problem
According to the official REST documentation at https://docs.atlassian.com/jira/REST/latest, the API available for transition property retrieval is as follow:
Which leads to reader to believe the API should be called as:
https://<instance url>/rest/api/2/workflow/api/2/transitions
https://<instance url>/rest/api/2/workflow/api/2/transitions/{id}/properties?includeReservedKeys={boolean}&workflowName={workflowname}&workflowMode={live or draft}
The above is incorrect
When clicking though the details on the resource, there's a mismatch on the url of the resource as it is described as
/rest/api/2/workflow/{id}/properties
This will lead the reader to believe that the resource should be called as:
https://<instance url>/rest/api/2/workflow/{id}/properties?includeReservedKeys&key&workflowName&workflowMode
The above is also incorrect
Using any of the URLs above will result in a 404 response as they are not correct.
Solution
The correct URL for this resource is at:
/rest/api/2/workflow/transitions/{id}/properties
where id is the transition id.
You can then call the resource in the following way:
https://<instance url>/rest/api/2/workflow/transitions/{id}/properties?workflowName=<name-of-the-workflow>
You can also specify the other parameters mentioned in the docs for all the HTTP methods.
The docs need to be fixed such that the URL is correct and consistent.
[JRACLOUD-79019] Incorrect REST API documentation to query transition properties
Hi all,
I have adjusted the description to accurately describe the current documentation problem. I have also added the information on how to actually call this resource from client code.
Hope that helps.
Regards,
Oswaldo Hernández.
JIRA Bugmaster.
[Atlassian].
Hi everyone,
Thank you for previously raising this bug and bringing it to our attention.
Within our company roadmap and work capacity, we try to address or review each bug request but admit that not each one will be resolved. To continue the culture of being honest and open, we are closing this bug to focus on our upcoming roadmap for all Jira users.
As we continue to roll out features we do look at requests made by our users and if you feel like this bug is still impacting your team please let us know.
Thank you again for providing valuable feedback to our team!
Jira Cloud team