runWorkflow

Back to index

Summary

Runs the specified workflow definition and returns the workflow name.

projectName

Stringrequired

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

workflowDefinitionName

Stringrequired

The name of the workflow definition.

actualParameters

Array<ActualParameter>optional

The list of actual parameters.

credentials

Array<Credential>optional

Credentials to be used in the state.

priority

Stringoptional

The priority of jobs launched by the workflow.

Possible values: "low", "normal", "high", "highest"

scheduleName

Stringoptional

Name for the schedule; must be unique among all schedules for the project.

startingState

Stringoptional

The name of the starting state.

Usage

Groovy

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

ElectricFlow ef = new ElectricFlow()

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