Back to index
Summary
Modifies an existing state definition.projectNameStringrequiredThe name for the project that must be unique among all projects. workflowDefinitionNameStringrequiredThe name of the workflow definition. stateDefinitionNameStringrequiredThe name used for the state definition. actualParametersArray<ActualParameter>optionalThe actual parameters to the state definition's process. clearActualParametersBooleanoptionalTrue if the state definition should remove all actual parameters to the process. descriptionStringoptionalComment text describing this object that is not interpreted at all by CloudBees CD/RO. newNameStringoptionalThe new name for an existing object that is being renamed. startableBooleanoptionalTrue if the workflow can begin in this state. subprocedureStringoptionalThe name of the subprocedure. subprojectStringoptionalThe name of the project that contains the subprocedure. substartingStateStringoptionalThe name of the starting state to use in the subworkflowDefinition. subworkflowDefinitionStringoptionalThe 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 */ )