Index
modifyEnvTemplTierResourceTemplMapping
getPluginCatalog
getResourceUsage
getRetrievedArtifacts
runDiscovery
getServerSettings
getServerSettingsCategories
revokeToken
getWorkItems
ActionParameterActualParameterAdditionalFilterAttributeDataTypeAttributePathCfgMgrParameterCloudProviderParameterColorComponentVersionCredentialCredentialReferenceParameterDefinitionParameterDefinitionSourceParameterDeployParameterDestinationMappingExportParameterFieldFilterFormParameterHookActualParameterHookParameterImportParameterLinkParameterOptionPipelineParameterPluginParameterProvisionParameterReleaseFlowRuntimeMappingResourcePhaseMappingResourcePoolPhaseMappingRollbackParameterSelectSortTierMappingTierResourceCountVisualizationProperty

deleteFormalParameter

On this page
Back to index

Summary

Deletes a formal parameter and any additional property that was created by createFormalParameter or modifyFormalParameter.
projectName
Stringoptional
The name for the project that must be unique among all projects.
reportName
Stringoptional
The name of the report, if the formal parameter is on a report.
formalParameterName
Stringrequired
Name for this parameter; used when the procedure is invoked to specify a value for the parameter.
applicationName
Stringoptional
The name of the application, if the formal parameter is on an application process.
archiveConnectorName
Stringoptional
The name of the archive connector, if the formal parameter is on an archive connector.
catalogItemName
Stringoptional
The name of the catalog item, if the formal parameter is on a catalog item.
catalogName
Stringoptional
The name of the catalog to which the catalog item belongs to.
componentName
Stringoptional
The name of the component, if the formal parameter is on a component process.
dashboardName
Stringoptional
The name of the dashboard, if the formal parameter is on a dashboard.
flowName
Stringoptional
The name of the flow to which the flow state belongs to.
flowStateName
Stringoptional
The name of the flow state, if the formal parameter is on a flow state.
gateType
Stringoptional
The type of the gate which contains the task, if the formal parameter is belongs to a task.
Possible values: "POST", "PRE"
microserviceName
Stringoptional
The name of the microservice.
pipelineName
Stringoptional
The name of the pipeline, if the formal parameter is on a pipeline.
procedureName
Stringoptional
The name of the procedure.
processName
Stringoptional
The name of the process, if the formal parameter is on a process.
processStepName
Stringoptional
The name of the process step, if the formal parameter is on a process step.
releaseName
Stringoptional
The name of the release, if the formal parameter is on a release-scoped pipeline.
stageName
Stringoptional
The name of the stage which contains the task, if the formal parameter is belongs to a task.
stateDefinitionName
Stringoptional
The name of the state definition.
stateName
Stringoptional
The name of a workflow state.
taskName
Stringoptional
The name of the task, if the formal parameter is belongs to a task.
updateFormXml
Booleanoptional
Whether the parameter form XML stored in the procedure property ec_parameterForm should also be updated.
workflowDefinitionName
Stringoptional
The name of the workflow definition.
workflowName
Stringoptional
The name of a workflow.

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*

ElectricFlow ef = new ElectricFlow()

def result = ef.deleteFormalParameter(
  formalParameterName: "test-formalParameterName"
  /* optional arguments */
)
▼