Index
addResourcePoolToEnvironmentTieraddResourceTemplateToEnvironmentTemplateTieraddResourceToEnvironmentTemplateTiercreateEnvironmentTemplatecreateEnvironmentTemplateTiercreateEnvironmentTemplateTierMapcreateHookcreateResourceTemplatedeleteEnvironmentTemplatedeleteEnvironmentTemplateTierdeleteEnvironmentTemplateTierMapdeleteEnvironmentTemplateTierMappingdeleteHookdeleteResourceTemplategetAvailableResourcesForEnvironmentgetEnvironmentTemplategetEnvironmentTemplatesgetEnvironmentTemplateTiergetEnvironmentTemplateTierMapsgetEnvironmentTemplateTiersgetHookgetHooksgetProvisionedEnvironmentsgetResourcePoolsInEnvironmentTiergetResourcesInEnvironmentTemplateTiergetResourceTemplategetResourceTemplatesgetResourceTemplatesInEnvironmentTemplateTiermodifyEnvironmentTemplatemodifyEnvironmentTemplateTiermodifyEnvironmentTemplateTierMapmodifyEnvTemplTierResourceTemplMappingmodifyHookmodifyResourceTemplateprovisionEnvironmentprovisionResourcePoolremoveResourceFromEnvironmentTemplateTierremoveResourcePoolFromEnvironmentTierremoveResourceTemplateFromEnvironmentTemplateTier
getPluginCatalog
getServerSettingsCategories
processWebhookTrigger
getWorkItems

runPipeline

Back to index

Summary

Runs the specified pipeline. If the pipeline configures disableMultipleActiveRuns= true, only one active run of this pipeline is allowed at a time and attempts to start more than one results in an exception.
projectName
Stringrequired
The name for the project that must be unique among all projects.
pipelineName
Stringrequired
The name of the pipeline.
actualParameter
Arrayoptional
The list of actual parameters.
credentialReferenceParameter
Arrayoptional
List of credential parameters with references to existing credentials as parameter values. If the parameter value is a property reference then the credential would be resolved at runtime.
credential
Arrayoptional
Credentials to be used in the state.
parsedWebhookData
Stringoptional
JSON with parsed webhook data to be set on a pipeline/release/procedure run.
priority
Stringoptional
The priority of jobs launched by the pipeline.
Possible values: "low", "normal", "high", "highest"
releaseName
Stringoptional
The name of the release.
scheduleName
Stringoptional
Name for the schedule; must be unique among all schedules for the project.
stagesToRun
Arrayoptional
One or more stages to run in a pipeline.
startingStage
Stringoptional
The name of the starting stage.
startingTask
Stringoptional
The name of the starting task.
startingTaskStage
Stringoptional
The name of the stage containing starting task.
webhookData
Stringoptional
The webhook data to be set on the pipeline/release/procedure run.
webhookHeaders
Stringoptional
The webhook headers in JSON format to be set on the pipeline/release/procedure run.

Usage

Perl

$cmdr->runPipeline(
  "test-projectName", # projectName
  "test-pipelineName" # pipelineName
  # optionals
);
▼

ectool

ectool runPipeline \
  "test-projectName" `# projectName` \
  "test-pipelineName" `# pipelineName` \
  # optionals
▼

Examples

Perl

$cmdr->runPipeline("Default", "Web Site Update", {startingStage => "Green"});
▼

ectool

ectool runPipeline "Default" "Web Site Update" --startingStage "Green"
▼