Index
addResourcePoolToEnvironmentTieraddResourceTemplateToEnvironmentTemplateTieraddResourceToEnvironmentTemplateTiercreateEnvironmentTemplatecreateEnvironmentTemplateTiercreateEnvironmentTemplateTierMapcreateHookcreateResourceTemplatedeleteEnvironmentTemplatedeleteEnvironmentTemplateTierdeleteEnvironmentTemplateTierMapdeleteEnvironmentTemplateTierMappingdeleteHookdeleteResourceTemplategetAvailableResourcesForEnvironmentgetEnvironmentTemplategetEnvironmentTemplatesgetEnvironmentTemplateTiergetEnvironmentTemplateTierMapsgetEnvironmentTemplateTiersgetHookgetHooksgetProvisionedEnvironmentsgetResourcePoolsInEnvironmentTiergetResourcesInEnvironmentTemplateTiergetResourceTemplategetResourceTemplatesgetResourceTemplatesInEnvironmentTemplateTiermodifyEnvironmentTemplatemodifyEnvironmentTemplateTiermodifyEnvironmentTemplateTierMapmodifyEnvTemplTierResourceTemplMappingmodifyHookmodifyResourceTemplateprovisionEnvironmentprovisionResourcePoolremoveResourceFromEnvironmentTemplateTierremoveResourcePoolFromEnvironmentTierremoveResourceTemplateFromEnvironmentTemplateTier
getPluginCatalog
getServerSettingsCategories
processWebhookTrigger
getWorkItems

abortPipelineRun

Back to index

Summary

Aborts a pipeline run.
flowRuntimeId
UUIDoptional
The ID of the flow runtime.
flowRuntimeName
Stringoptional
The name of the flow runtime.
force
Booleanoptional
If true running tasks are force aborted.
projectName
Stringoptional
The name of the project.

Usage

Perl

$cmdr->abortPipelineRun(
  # optionals
);
▼

ectool

ectool abortPipelineRun \
  # optionals
▼

Examples

When making calls using ectool or cb-perl, you must provide values for either flowRuntimeId or both flowRuntimeName and projectName to identify the pipeline run to abort. Refer to the examples below for more information.

Abort pipeline using flowRuntimeId

Perl

$cmdr->abortPipelineRun({flowRuntimeId => "009a4a58-a59b-11ef-98c4-687a6484a35a"});
▼

ectool

ectool abortPipelineRun --flowRuntimeId "009a4a58-a59b-11ef-98c4-687a6484a35a"
▼

Abort pipeline using flowRuntimeName and projectName

Perl

$cmdr->abortPipelineRun({flowRuntimeName => "Final Release", projectName => "Production"});
▼

ectool

ectool abortPipelineRun --flowRuntimeName "Final Release" --projectName "Production"
▼