createTransitionDefinition

Back to index

Summary

Creates a new transition definition for workflow 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.

targetState

Stringrequired

Target state for the transition definition.

actualParameter

Arrayoptional

The actual parameters to the transition's 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.

trigger

Stringoptional

Specifies the type of trigger for this transaction.

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

Usage

Perl

$cmdr->createTransitionDefinition(
  "test-projectName", # projectName
  "test-workflowDefinitionName", # workflowDefinitionName
  "test-stateDefinitionName", # stateDefinitionName
  "test-transitionDefinitionName", # transitionDefinitionName
  "test-targetState" # targetState
  # optionals
);▼

ectool

ectool createTransitionDefinition \
  "test-projectName" `# projectName` \
  "test-workflowDefinitionName" `# workflowDefinitionName` \
  "test-stateDefinitionName" `# stateDefinitionName` \
  "test-transitionDefinitionName" `# transitionDefinitionName` \
  "test-targetState" `# targetState` \
  # optionals▼

Examples

Perl

$cmdr->createTransitionDefinition("Default", "BTD", "build", "build2test", "test", {trigger => "manual", description => "Production"});▼

ectool

ectool createTransitionDefinition "Default" "BTD" "build" "build2test" "test" --trigger manual --description "Production"▼