Index
addResourcePoolToEnvironmentTieraddResourceTemplateToEnvironmentTemplateTieraddResourceToEnvironmentTemplateTiercreateEnvironmentTemplatecreateEnvironmentTemplateTiercreateEnvironmentTemplateTierMapcreateHookcreateResourceTemplatedeleteEnvironmentTemplatedeleteEnvironmentTemplateTierdeleteEnvironmentTemplateTierMapdeleteEnvironmentTemplateTierMappingdeleteHookdeleteResourceTemplategetAvailableResourcesForEnvironmentgetEnvironmentTemplategetEnvironmentTemplatesgetEnvironmentTemplateTiergetEnvironmentTemplateTierMapsgetEnvironmentTemplateTiersgetHookgetHooksgetProvisionedEnvironmentsgetResourcePoolsInEnvironmentTiergetResourcesInEnvironmentTemplateTiergetResourceTemplategetResourceTemplatesgetResourceTemplatesInEnvironmentTemplateTiermodifyEnvironmentTemplatemodifyEnvironmentTemplateTiermodifyEnvironmentTemplateTierMapmodifyEnvTemplTierResourceTemplMappingmodifyHookmodifyResourceTemplateprovisionEnvironmentprovisionResourcePoolremoveResourceFromEnvironmentTemplateTierremoveResourcePoolFromEnvironmentTierremoveResourceTemplateFromEnvironmentTemplateTier
getPluginCatalog
getServerSettingsCategories
processWebhookTrigger
getWorkItems

getFormalParameter

Back to index

Summary

Retrieves a formal parameter by its name.
projectName
Stringrequired
Name for the project; must be unique among all projects.
procedureName
Stringrequired
The name of the procedure.
formalParameterName
Stringrequired
Name for this parameter; used when the procedure is invoked to specify a value for the parameter.
applicationEntityRevisionId
UUIDoptional
The revision ID of the versioned object.
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.
flowRuntimeStateId
UUIDoptional
The ID of the flow runtime state.
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"
includeDetails
Booleanoptional
True to include details such as corresponding properties in the ec_customEditorData property sheet (default is false).
microserviceName
Stringoptional
The name of the microservice.
pipelineName
Stringoptional
The name of the pipeline, if the formal parameter is on a pipeline.
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.
reportName
Stringoptional
The name of the report, if the formal parameter is on a report.
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.
workflowDefinitionName
Stringoptional
The name of the workflow definition.
workflowName
Stringoptional
The name of a workflow.

Usage

Perl

$cmdr->getFormalParameter(
  "test-projectName", # projectName
  "test-procedureName", # procedureName
  "test-formalParameterName" # formalParameterName
  # optionals
);
▼

ectool

ectool getFormalParameter \
  "test-projectName" `# projectName` \
  "test-procedureName" `# procedureName` \
  "test-formalParameterName" `# formalParameterName` \
  # optionals
▼

Examples

Perl

$cmdr->getFormalParameter("Default", "Use Existing Project", {pipeline=>"Test"});
▼

ectool

Example 1

ectool getFormalParameter "Default" "Test Case"
▼

Example 2

ectool getFormalParameter "Default" "Use Existing Project" --pipeline "Test"
▼