modifyStateDefinition

On this page
Back to index

Summary

Modifies an existing state 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.
actualParameters
Array<ActualParameter>optional
The actual parameters to the state definition's process.
clearActualParameters
Booleanoptional
True if the state definition should remove all actual parameters to the process.
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.
startable
Booleanoptional
True if the workflow can begin in this state.
subprocedure
Stringoptional
The name of the subprocedure.
subproject
Stringoptional
The name of the project that contains the subprocedure.
substartingState
Stringoptional
The name of the starting state to use in the subworkflowDefinition.
subworkflowDefinition
Stringoptional
The name of the subworkflowDefinition.

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow import com.electriccloud.client.groovy.models.* ElectricFlow ef = new ElectricFlow() def result = ef.modifyStateDefinition( projectName: "test-projectName", workflowDefinitionName: "test-workflowDefinitionName", stateDefinitionName: "test-stateDefinitionName" /* optional arguments */ )