com.atlassian.jira.rest.v2.admin

Class WorkflowTransitionResource.TransitionResource

java.lang.Object

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

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

Enclosing class:

WorkflowTransitionResource

public static class WorkflowTransitionResource.TransitionResource
extends WorkflowTransitionResource

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.jira.rest.v2.admin.WorkflowTransitionResource

WorkflowTransitionResource.ConstantResponseResource, WorkflowTransitionResource.Factory, WorkflowTransitionResource.PropertyBean, WorkflowTransitionResource.TransitionResource, WorkflowTransitionResource.WorkflowMode

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createProperty(long transitionId, String key, String workflowName, String workflowMode, WorkflowTransitionResource.PropertyBean body) Add a new property to a transition.
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.
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.
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 javax.ws.rs.core.Response getProperties(long transitionId,
                                               boolean includeReservedKeys,
                                               String key,
                                               String workflowName,
                                               String workflowMode)

Description copied from class: WorkflowTransitionResource

Return the property or properties associated with a transition.

Specified by:

getProperties in class WorkflowTransitionResource

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".

createProperty

public javax.ws.rs.core.Response createProperty(long transitionId,
                                                String key,
                                                String workflowName,
                                                String workflowMode,
                                                WorkflowTransitionResource.PropertyBean body)

Description copied from class: WorkflowTransitionResource

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

Specified by:

createProperty in class WorkflowTransitionResource

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".

updateProperty

public javax.ws.rs.core.Response updateProperty(long transitionId,
                                                String key,
                                                String workflowName,
                                                String workflowMode,
                                                WorkflowTransitionResource.PropertyBean body)

Description copied from class: WorkflowTransitionResource

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

Specified by:

updateProperty in class WorkflowTransitionResource

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".

deleteProperty

public javax.ws.rs.core.Response deleteProperty(long transitionId,
                                                String key,
                                                String workflowName,
                                                String workflowMode)

Description copied from class: WorkflowTransitionResource

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

Specified by:

deleteProperty in class WorkflowTransitionResource

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".