Index
modifyEnvTemplTierResourceTemplMapping
getPluginCatalog
getResourceUsage
getRetrievedArtifacts
runDiscovery
getServerSettings
getServerSettingsCategories
revokeToken
getWorkItems
ActionParameterActualParameterAdditionalFilterAttributeDataTypeAttributePathCfgMgrParameterCloudProviderParameterColorComponentVersionCredentialCredentialReferenceParameterDefinitionParameterDefinitionSourceParameterDeployParameterDestinationMappingExportParameterFieldFilterFormParameterHookActualParameterHookParameterImportParameterLinkParameterOptionPipelineParameterPluginParameterProvisionParameterReleaseFlowRuntimeMappingResourcePhaseMappingResourcePoolPhaseMappingRollbackParameterSelectSortTierMappingTierResourceCountVisualizationProperty

createActualParameter

On this page
Back to index

Summary

Creates a new actual parameter for a step that calls a nested procedure. The parameter is passed to the nested procedure when the step runs. At runtime, the actual parameter name must match the name of a formal parameter in the nested procedure.
projectName
Stringrequired
The name for the project that must be unique among all projects.
releaseName
Stringoptional
The name of the release, if the actual parameter is on a release.
actualParameterName
Stringrequired
The name of the parameter to create/modify/delete.
applicationName
Stringoptional
The name of the application, if the actual parameter is on an application process step.
archiveConnectorName
Stringoptional
The name of the archive connector.
catalogItemName
Stringoptional
The name of the catalog item.
catalogItemRunId
Stringoptional
The ID of the catalog item run, if the actual parameter is on a catalog item run.
catalogName
Stringoptional
The name of the catalog.
componentName
Stringoptional
The name of the component, if the actual parameter is on a component process step.
dashboardName
Stringoptional
The name of the 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.
pipelineName
Stringoptional
The name of the pipeline.
procedureName
Stringoptional
The name of the procedure.
processName
Stringoptional
The name of the process, if the actual parameter is on a process step.
processStepName
Stringoptional
The name of the process step, if the actual parameter is on a process step.
scheduleName
Stringoptional
The name of the schedule.
stateDefinitionName
Stringoptional
The name of the state definition.
stepName
Stringoptional
The name of the step.
tierMapName
Stringoptional
The name of the tier map.
transitionDefinitionName
Stringoptional
The name of the state definition.
triggerName
Stringoptional
The name of the trigger.
value
Stringoptional
The value of the actual parameter, if creating or modifying.
widgetName
Stringoptional
The name of the widget.
workflowDefinitionName
Stringoptional
The name of the workflow definition.

Usage

Groovy

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

ElectricFlow ef = new ElectricFlow()

def result = ef.createActualParameter(
  projectName: "test-projectName",
  actualParameterName: "test-actualParameterName"
  /* optional arguments */
)
▼