Index
addResourcePoolToEnvironmentTieraddResourceTemplateToEnvironmentTemplateTieraddResourceToEnvironmentTemplateTiercreateEnvironmentTemplatecreateEnvironmentTemplateTiercreateEnvironmentTemplateTierMapcreateHookcreateResourceTemplatedeleteEnvironmentTemplatedeleteEnvironmentTemplateTierdeleteEnvironmentTemplateTierMapdeleteEnvironmentTemplateTierMappingdeleteHookdeleteResourceTemplategetAvailableResourcesForEnvironmentgetEnvironmentTemplategetEnvironmentTemplatesgetEnvironmentTemplateTiergetEnvironmentTemplateTierMapsgetEnvironmentTemplateTiersgetHookgetHooksgetProvisionedEnvironmentsgetResourcePoolsInEnvironmentTiergetResourcesInEnvironmentTemplateTiergetResourceTemplategetResourceTemplatesgetResourceTemplatesInEnvironmentTemplateTiermodifyEnvironmentTemplatemodifyEnvironmentTemplateTiermodifyEnvironmentTemplateTierMapmodifyEnvTemplTierResourceTemplMappingmodifyHookmodifyResourceTemplateprovisionEnvironmentprovisionResourcePoolremoveResourceFromEnvironmentTemplateTierremoveResourcePoolFromEnvironmentTierremoveResourceTemplateFromEnvironmentTemplateTier
getPluginCatalog
getServerSettingsCategories
processWebhookTrigger
getWorkItems

deleteEventSubscription

Back to index

Summary

Delete a list of event subscriptions.
You must specify a notifierName and specify locator arguments to find the event subscription you want to delete.
notifierName
Stringrequired
The name of the email notifier.
applicationName
Stringoptional
The name of the application which is related to the target email container (Process/ProcessStep).
componentName
Stringoptional
The name of the component which is related to the target email container (Process/ProcessStep).
flowName
Stringoptional
The name of the flow container of the email notifier.
flowRuntimeId
UUIDoptional
The primary key or name of the flowRuntime container of the email notifier.
flowRuntimeStateId
UUIDoptional
The primary key or name of the flowRuntimeState container of the email notifier.
flowStateName
Stringoptional
The name of the flow container of the email notifier.
gateType
Stringoptional
The type of the gate.
Possible values: "POST", "PRE"
groupName
Arrayoptional
A list of names of the groups which receives the notification.
jobId
Stringoptional
The primary key or name of the job container of the email notifier.
jobStepId
UUIDoptional
The primary key of the job-step container of the email notifier.
pipelineName
Stringoptional
The name of the pipeline container of the email notifier.
procedureName
Stringoptional
The name of the procedure container of the email notifier.
processName
Stringoptional
The name of the process container of the email notifier.
processStepName
Stringoptional
The name of the process step container of the email notifier.
projectName
Stringoptional
The name of the project container of the email notifier.
releaseName
Stringoptional
The name of the release containing the pipeline.
stageName
Stringoptional
The name of the stage container of the email notifier.
stateDefinitionName
Stringoptional
The name of the state definition container of the email notifier.
stateName
Stringoptional
The name of the state container of the email notifier.
stepName
Stringoptional
The name of the step container of the email notifier.
userName
Arrayoptional
A list of names of the users who receives the notification.
workflowDefinitionName
Stringoptional
The name of the workflow definition container of the email notifier.
workflowName
Stringoptional
The name of the workflow container of the email notifier.

Usage

Perl

$cmdr->deleteEventSubscription(
  "test-notifierName" # notifierName
  # optionals
);
▼

ectool

ectool deleteEventSubscription \
  "test-notifierName" `# notifierName` \
  # optionals
▼

Examples

Perl

$cmdr->deleteEventSubscription(mySubscription, {applicationName => myAppEvent});
▼

ectool

ectool deleteEventSubscription mySubscription --applicationName myAppEvent
▼