com.atlassian.jira.rest.v2.admin

Class WorkflowTransitionResource

java.lang.Object

com.atlassian.jira.rest.v2.admin.WorkflowTransitionResource

Direct Known Subclasses:

WorkflowTransitionResource.ConstantResponseResource, WorkflowTransitionResource.TransitionResource

public abstract class WorkflowTransitionResource
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WorkflowTransitionResource.ConstantResponseResource
static class	WorkflowTransitionResource.Factory
static class	WorkflowTransitionResource.PropertyBean
static class	WorkflowTransitionResource.TransitionResource
static class	WorkflowTransitionResource.WorkflowMode

Method Summary

Modifier and Type	Method and Description
abstract javax.ws.rs.core.Response	createProperty(long transitionId, String key, String workflowName, String workflowMode, WorkflowTransitionResource.PropertyBean body) Add a new property to a transition.
abstract javax.ws.rs.core.Response	deleteProperty(long transitionId, String key, String workflowName, String workflowMode) Delete a property from the passed transition on the passed workflow.
abstract javax.ws.rs.core.Response	getProperties(long transitionId, boolean includeReservedKeys, String key, String workflowName, String workflowMode) Return the property or properties associated with a transition.
abstract javax.ws.rs.core.Response	updateProperty(long transitionId, String key, String workflowName, String workflowMode, WorkflowTransitionResource.PropertyBean body) Update/add new property to a transition.

Methods inherited from class java.lang.Object

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

Method Detail

getProperties

public abstract javax.ws.rs.core.Response getProperties(long transitionId,
                                                        boolean includeReservedKeys,
                                                        String key,
                                                        String workflowName,
                                                        String workflowMode)

Return the property or properties associated with a transition.

Parameters:

workflowName - the name of the workflow to use.

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

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.

createProperty

public abstract javax.ws.rs.core.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:

workflowName - the name of the workflow to use.

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

transitionId - the ID of the transition within the workflow.

key - the name of the property to add.

updateProperty

public abstract javax.ws.rs.core.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:

workflowName - the name of the workflow to use.

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

transitionId - the ID of the transition within the workflow.

key - the name of the property to add.

deleteProperty

public abstract javax.ws.rs.core.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:

workflowName - the name of the workflow to use.

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

transitionId - the ID of the transition within the workflow.

key - the name of the property to add.