Package com.atlassian.jira.rest.v2.admin

Class WorkflowsResource

java.lang.Object

com.atlassian.jira.rest.v2.admin.WorkflowsResource

@Path("workflow")
@Consumes("application/json")
@Produces("application/json")
public class WorkflowsResource
extends Object

REST resource for retrieving workflows.

Since:

v5.2

Constructor Summary

Constructors

Constructor	Description
WorkflowsResource(WorkflowManager workflowManager, DateTimeFormatter dateTimeFormatter, UserManager userManager, JiraAuthenticationContext jiraAuthenticationContext, PermissionManager permissionManager, WorkflowTransitionResource.Factory transitionFactory)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	getAllWorkflows(String workflowName)	Returns all workflows.
WorkflowTransitionResource	getWorkflowTransitions(String workflowName, String workflowMode)	Return a sub-resource to handle transitions.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WorkflowsResource

@Inject
public WorkflowsResource(WorkflowManager workflowManager,
 DateTimeFormatter dateTimeFormatter,
 UserManager userManager,
 JiraAuthenticationContext jiraAuthenticationContext,
 PermissionManager permissionManager,
 WorkflowTransitionResource.Factory transitionFactory)

Method Details

getAllWorkflows

@GET
public jakarta.ws.rs.core.Response getAllWorkflows(@QueryParam("workflowName")
 String workflowName)

Returns all workflows. The “lastModifiedDate” is returned in Jira Complete Date/Time Format (dd/MMM/yy h:mm by default), but can also be returned as a relative date.

Returns:

all workflows.

getWorkflowTransitions

@Path("transitions")
public WorkflowTransitionResource getWorkflowTransitions(@QueryParam("workflowName")
 String workflowName,
 @QueryParam("workflowMode")
 String workflowMode)

Return a sub-resource to handle transitions.

Parameters:

workflowName - the name of the workflow to use.

workflowMode - the type of workflow to use. Can either be "live" or "draft".

Returns:

A WorkflowTransitionResource to handle the transition.