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
Mapoptional
The list of actual parameters.
credentials
Collectionoptional
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

Perl

$cmdr->runWorkflow( "test-projectName", # projectName "test-workflowDefinitionName" # workflowDefinitionName # optionals );

ectool

ectool runWorkflow \ "test-projectName" `# projectName` \ "test-workflowDefinitionName" `# workflowDefinitionName` \ # optionals

Examples

Perl

$cmdr->runWorkflow("Default", "BTD", {startingState => "Build"});

ectool

ectool runWorkflow "Default" "BTD" --startingState "Build"