createTransitionDefinition
Creates a new transition definition for a workflow definition.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
workflowDefinitionName | String | The name of the workflow definition. (Required) |
stateDefinitionName | String | The name used for the state definition (Required) |
transitionDefinitionName | String | The name used for the transition (Required) |
actualParameters | ActualParameter array | The actual parameters to the transition’s target state. |
condition | String | 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 | String | Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
targetState | String | Target state for the transition definition. |
trigger | String | Specifies the type of trigger for this transaction. |
Usage
import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*
ElectricFlow ef = new ElectricFlow()
def result = ef.createTransitionDefinition(
projectName: 'test-projectName',
workflowDefinitionName: 'test-workflowDefinitionName',
stateDefinitionName: 'test-stateDefinitionName',
transitionDefinitionName: 'test-transitionDefinitionName'
/* optional arguments */)
deleteTransitionDefinition
Deletes a transition definition.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
workflowDefinitionName | String | The name of the workflow definition. (Required) |
transitionDefinitionName | String | The name used for the transition (Required) |
stateDefinitionName | String | The name used for the state definition (Required) |
Usage
import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*
ElectricFlow ef = new ElectricFlow()
def result = ef.deleteTransitionDefinition(
projectName: 'test-projectName',
workflowDefinitionName: 'test-workflowDefinitionName',
transitionDefinitionName: 'test-transitionDefinitionName',
stateDefinitionName: 'test-stateDefinitionName')
getTransitionDefinition
Find a transition definition by name.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
workflowDefinitionName | String | The name of the workflow definition. (Required) |
transitionDefinitionName | String | The name used for the transition (Required) |
stateDefinitionName | String | The name used for the state definition (Required) |
Usage
import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*
ElectricFlow ef = new ElectricFlow()
def result = ef.getTransitionDefinition(
projectName: 'test-projectName',
workflowDefinitionName: 'test-workflowDefinitionName',
transitionDefinitionName: 'test-transitionDefinitionName',
stateDefinitionName: 'test-stateDefinitionName')
getTransitionDefinitions
Retrieve all transition definitions in a workflow definition.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
workflowDefinitionName | String | The name of the workflow definition. (Required) |
stateDefinitionName | String | The name used for the state definition (Required) |
targetState | String | Limits results to transition definitions that have the specified state definition as a target. |
Usage
import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*
ElectricFlow ef = new ElectricFlow()
def result = ef.getTransitionDefinitions(
projectName: 'test-projectName',
workflowDefinitionName: 'test-workflowDefinitionName',
stateDefinitionName: 'test-stateDefinitionName'
/* optional arguments */)
modifyTransitionDefinition
Modifies an existing transition definition.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
workflowDefinitionName | String | The name of the workflow definition. (Required) |
stateDefinitionName | String | The name used for the state definition (Required) |
transitionDefinitionName | String | The name used for the transition (Required) |
actualParameters | ActualParameter array | The actual parameters to the transition’s target state. |
clearActualParameters | Boolean | True if the transition should remove all actual parameters to the target state. |
condition | String | 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 | String | Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
newName | String | New name for an existing object that is being renamed. |
targetState | String | Target state for the transition definition. |
trigger | String | Specifies the type of trigger for this transaction. |
Usage
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 */)
moveTransitionDefinition
Move a transition definition within a workflow definition.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
workflowDefinitionName | String | The name of the workflow definition. (Required) |
stateDefinitionName | String | The name used for the state definition (Required) |
transitionDefinitionName | String | The name used for the transition (Required) |
beforeTransitionDefinition | String | The name of the transition before which 'transitionDefinitionName' should appear. Blank to move the transition to the last position. |
Usage
import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*
ElectricFlow ef = new ElectricFlow()
def result = ef.moveTransitionDefinition(
projectName: 'test-projectName',
workflowDefinitionName: 'test-workflowDefinitionName',
stateDefinitionName: 'test-stateDefinitionName',
transitionDefinitionName: 'test-transitionDefinitionName'
/* optional arguments */)