Back to index
Summary
Delete a list of event subscriptions.jobIdStringoptionalThe primary key or name of the job container of the email notifier. notifierNameStringrequiredThe name of the email notifier. userNamesArray<Unknown>optionalA list of names of the users who receives the notification. applicationNameStringoptionalThe name of the application which is related to the target email container (Process/ProcessStep). componentNameStringoptionalThe name of the component which is related to the target email container (Process/ProcessStep). flowNameStringoptionalThe name of the flow container of the email notifier. flowRuntimeIdStringoptionalThe primary key or name of the flowRuntime container of the email notifier. flowRuntimeStateIdStringoptionalThe primary key or name of the flowRuntimeState container of the email notifier. flowStateNameStringoptionalThe name of the flow container of the email notifier. gateTypeStringoptionalThe type of the gate. Possible values: "POST", "PRE"groupNamesArray<Unknown>optionalA list of names of the groups which receives the notification. jobStepIdStringoptionalThe primary key of the job-step container of the email notifier. pipelineNameStringoptionalThe name of the pipeline container of the email notifier. procedureNameStringoptionalThe name of the procedure container of the email notifier. processNameStringoptionalThe name of the process container of the email notifier. processStepNameStringoptionalThe name of the process step container of the email notifier. projectNameStringoptionalThe name of the project container of the email notifier. releaseNameStringoptionalThe name of the release containing the pipeline. stageNameStringoptionalThe name of the stage container of the email notifier. stateDefinitionNameStringoptionalThe name of the state definition container of the email notifier. stateNameStringoptionalThe name of the state container of the email notifier. stepNameStringoptionalThe name of the step container of the email notifier. workflowDefinitionNameStringoptionalThe name of the workflow definition container of the email notifier. workflowNameStringoptionalThe name of the workflow container of the email notifier. |
Usage
Groovy
import com.electriccloud.client.groovy.ElectricFlow import com.electriccloud.client.groovy.models.* ElectricFlow ef = new ElectricFlow() def result = ef.deleteEventSubscription( notifierName: "test-notifierName" /* optional arguments */ )