public abstract class

WorkflowTransitionResource

extends Object
java.lang.Object
   ↳ com.atlassian.jira.rest.v2.admin.WorkflowTransitionResource
Known Direct Subclasses

Summary

Nested Classes
class WorkflowTransitionResource.ConstantResponseResource  
class WorkflowTransitionResource.Factory  
class WorkflowTransitionResource.PropertyBean  
class WorkflowTransitionResource.TransitionResource  
enum WorkflowTransitionResource.WorkflowMode  
Public Methods
abstract Response createProperty(long transitionId, String key, String workflowName, String workflowMode, WorkflowTransitionResource.PropertyBean body)
Add a new property to a transition.
abstract Response deleteProperty(long transitionId, String key, String workflowName, String workflowMode)
Delete a property from the passed transition on the passed workflow.
abstract Response getProperties(long transitionId, boolean includeReservedKeys, String key, String workflowName, String workflowMode)
Return the property or properties associated with a transition.
abstract Response updateProperty(long transitionId, String key, String workflowName, String workflowMode, WorkflowTransitionResource.PropertyBean body)
Update/add new property to a transition.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public abstract Response createProperty (long transitionId, String key, String workflowName, String workflowMode, WorkflowTransitionResource.PropertyBean body)

Add a new property to a transition. Trying to add a property that already exists will fail.

Parameters
transitionId the ID of the transition within the workflow.
key the name of the property to add.
workflowName the name of the workflow to use.
workflowMode the type of workflow to use. Can either be "live" or "draft".

public abstract Response deleteProperty (long transitionId, String key, String workflowName, String workflowMode)

Delete a property from the passed transition on the passed workflow. It is not an error to delete a property that does not exist.

Parameters
transitionId the ID of the transition within the workflow.
key the name of the property to add.
workflowName the name of the workflow to use.
workflowMode the type of workflow to use. Can either be "live" or "draft".

public abstract Response getProperties (long transitionId, boolean includeReservedKeys, String key, String workflowName, String workflowMode)

Return the property or properties associated with a transition.

Parameters
transitionId the ID of the transition within the workflow.
includeReservedKeys some keys under the "jira." prefix are editable, some are not. Set this to true in order to include the non-editable keys in the response.
key the name of the property key to query. Can be left off the query to return all properties.
workflowName the name of the workflow to use.
workflowMode the type of workflow to use. Can either be "live" or "draft".

public abstract Response updateProperty (long transitionId, String key, String workflowName, String workflowMode, WorkflowTransitionResource.PropertyBean body)

Update/add new property to a transition. Trying to update a property that does not exist will result in a new property being added.

Parameters
transitionId the ID of the transition within the workflow.
key the name of the property to add.
workflowName the name of the workflow to use.
workflowMode the type of workflow to use. Can either be "live" or "draft".