Index
addResourcePoolToEnvironmentTieraddResourceTemplateToEnvironmentTemplateTieraddResourceToEnvironmentTemplateTiercreateEnvironmentTemplatecreateEnvironmentTemplateTiercreateEnvironmentTemplateTierMapcreateHookcreateResourceTemplatedeleteEnvironmentTemplatedeleteEnvironmentTemplateTierdeleteEnvironmentTemplateTierMapdeleteEnvironmentTemplateTierMappingdeleteHookdeleteResourceTemplategetAvailableResourcesForEnvironmentgetEnvironmentTemplategetEnvironmentTemplatesgetEnvironmentTemplateTiergetEnvironmentTemplateTierMapsgetEnvironmentTemplateTiersgetHookgetHooksgetProvisionedEnvironmentsgetResourcePoolsInEnvironmentTiergetResourcesInEnvironmentTemplateTiergetResourceTemplategetResourceTemplatesgetResourceTemplatesInEnvironmentTemplateTiermodifyEnvironmentTemplatemodifyEnvironmentTemplateTiermodifyEnvironmentTemplateTierMapmodifyEnvTemplTierResourceTemplMappingmodifyHookmodifyResourceTemplateprovisionEnvironmentprovisionResourcePoolremoveResourceFromEnvironmentTemplateTierremoveResourcePoolFromEnvironmentTierremoveResourceTemplateFromEnvironmentTemplateTier
getPluginCatalog
getServerSettingsCategories
processWebhookTrigger
getWorkItems

getActualParameter

Back to index

Summary

Retrieves an actual parameter by its name.
If you need actual parameters on a step, the projectName, procedureName, and stepName arguments must be used together to specify the step.
actualParameterName
Stringrequired
The name of the parameter.
applicationEntityRevisionId
UUIDoptional
The revision ID of the versioned object.
applicationName
Stringoptional
The name of the application, if the actual parameter is on an application process step.
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 a 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.
flowRuntimeId
Stringoptional
The ID of the flow runtime, to which flow runtime belongs.
flowRuntimeName
Stringoptional
The name of the flow runtime, to which flow runtime belongs.
flowRuntimeStateId
UUIDoptional
The ID of the flow runtime state.
flowRuntimeStateName
Stringoptional
The name of the flow runtime state.
flowStateName
Stringoptional
The name of the flow state, if the actual parameter is on a flow state.
jobId
Stringoptional
The primary key of the job, or the name of the job.
jobStepId
UUIDoptional
The primary key for a job step.
pipelineName
Stringoptional
The name of a pipeline.
procedureName
Stringoptional
The name of a 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.
projectName
Stringoptional
The name of a project.
releaseName
Stringoptional
The name of the release, if the actual parameter is on release.
scheduleName
Stringoptional
The name of a schedule.
searchJobStepHierarchy
Booleanoptional
Whether or not to search for the actual parameter in the job step hierarchy to find the specified actual parameter. Applicable only with jobStepId argument.
stateDefinitionName
Stringoptional
The name of a workflow state definition.
stateName
Stringoptional
The name of a workflow state.
stepName
Stringoptional
The name of a procedure step.
tierMapName
Stringoptional
The name of the tier map.
transitionDefinitionName
Stringoptional
The name of a workflow transition definition.
transitionName
Stringoptional
The name of a workflow transition.
triggerName
Stringoptional
The name of the trigger.
widgetName
Stringoptional
The name of a widget.
workflowDefinitionName
Stringoptional
The name of a workflow definition.
workflowName
Stringoptional
The name of a workflow.

Usage

Perl

$cmdr->getActualParameter(
  "test-actualParameterName" # actualParameterName
  # optionals
);
▼

ectool

ectool getActualParameter \
  "test-actualParameterName" `# actualParameterName` \
  # optionals
▼

Examples

Perl

$cmdr->getActualParameter("Extra Parameter",
    {"projectName" => "Sample Project",
   "procedureName" => "CallSub",
        "stepName" => "Step1"});
▼

ectool

ectool getActualParameter "Extra Parameter" --projectName "Sample Project"
  --procedureName "CallSub" --stepName "Step1"
▼