Jira Align API - How to retrieve list of Work Items canceled via API
Summary
It is possible to retrieve a list of work items canceled/deleted on Jira Align by using the API.
More details of Jira Align API can be found here → API 2.0 GET usage and filters
Environment
Jira Align
Solution
There is a structure on Jira Align API for work items that relate to the variables "isCanceled" and "isRecycled," which obligates us to combine both variables in the filter of the API, written like below:
?expanded=true&$filter= IsCanceled eq 1&isRecycled=true
So, in the example below, if it wants to get a list of Stories canceled via API call, then it would use the following API endpoint:
https://XXXXXXXXXX.jiraalign.com/rest/align/api/2/stories?expanded=true&$filter= IsCanceled eq 1&isRecycled=true
... and it would receive the list of all stories that were canceled or went to the recycle bin.
This approach can also retrieve the list of canceled features or canceled Epics.
It is worth mentioning that it is needed to paginate the API calls when the results are greater than 100 items. For that, we can use the commands "top" and "skip", like the example below:
&$top=100&$skip=10