RestAPI for getting workflow step details

Hello,
I am looking for a rest for getting a workflow step properties like these:



Is there any way I can get these programmatically ?
More specifically I am interested in the approval.active property.
I need a way to get the workflows for a project, check their statuses and check this approval.active prop of any status.
I got through the rests for workflows but noone returns the actual steps properties.
Please advice if there is any way to get these, if not directly from a single rest.

Hello @AAleksandrov

You’ve read the documentation correctly. There currently are no API endpoints for managing workflow steps or their properties.

Currently you can only manage transition properties.

That’s unfortunate… I need a way to get through the workflows of a project, check their statuses and see if any status has attached approval step.
Currently I found that it is only available to get if a status has approval step only when a ticket is set to that status, by JQL search with approval=pending(). But this doesn`t work for my needs cause I need to know if such step exist before it is assigned on a ticket.
If anyone has an idea how can i do that, please advice.

Found a way => /rest/api/3/workflow/search?expand=statuses.properties .
Just saw that there’s an option to expand properties. :slight_smile:

1 Like

Nice! I hadn’t thought of that.

It’s also where you encounter some strangeness of the workflow terminology used in the GUI versus the API.

For that workflow search endpoint, you can provide expand parameters called statuses or statuses.properties, but what is actually returned is a set of workflow steps and their properties, not any statuses linked to those steps or any properties of those statuses.

IMHO, those parameters really should be called steps and steps.properties

PS. If you solve your own problem, it’s OK to mark your own answer as the solution.

1 Like

Just want to add that I would recommend using the experimental API’s as they provide the full details of the workflow.

1 Like

Good catch. One point is that the status that is returned is the Linked Status not the step though which is why status.id won’t get you to the ViewWorkflowStep page. :confused: so it is named correctly status.

I like your idea to have a steps and steps.properties which actually returned the steps and included information about the linked status. I just wasted an hour trying to figure this out.