modifyTransitionDefinition

Back to index

Summary

Modifies an existing transition definition.

projectName

Stringrequired

The name for the project that must be unique among all projects.

workflowDefinitionName

Stringrequired

The name of the workflow definition.

stateDefinitionName

Stringrequired

The name used for the state definition.

transitionDefinitionName

Stringrequired

The name used for the transition.

actualParameters

Array<ActualParameter>optional

The actual parameters to the transition's target state.

clearActualParameters

Booleanoptional

True if the transition should remove all actual parameters to the target state.

condition

Stringoptional

A fixed text or text embedding property references that is evaluated into a logical TRUE or FALSE. An empty string, a 0 or false is interpreted as FALSE. Any other result string is interpreted as TRUE.

description

Stringoptional

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

newName

Stringoptional

The new name for an existing object that is being renamed.

targetState

Stringoptional

Target state for the transition definition.

trigger

Stringoptional

Specifies the type of trigger for this transaction.

Possible values: "manual", "onCompletion", "onEnter", "onStart"

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*

ElectricFlow ef = new ElectricFlow()

def result = ef.modifyTransitionDefinition(
  projectName: "test-projectName",
  workflowDefinitionName: "test-workflowDefinitionName",
  stateDefinitionName: "test-stateDefinitionName",
  transitionDefinitionName: "test-transitionDefinitionName"
  /* optional arguments */
)▼