ActualParameter

createActualParameter

Create a new actual parameter.

Arguments

Argument Name	Type	Description
projectName	String	The name for the project that must be unique among all projects. (Required)
actualParameterName	String	The name of the parameter to create/modify/delete. (Required)
releaseName	String	The name of the release, if the actual parameter is on a release.
applicationName	String	The name of the application, if the actual parameter is on an application process step.
archiveConnectorName	String	The name of the archive connector.
catalogItemName	String	The name of the Catalog Item
catalogItemRunId	String	The id of the catalog item run, if the actual parameter is on an catalog item run.
catalogName	String	The name of the Catalog
componentName	String	The name of the component, if the actual parameter is on a component process step.
dashboardName	String	The name of the dashboard.
flowName	String	The name of the flow to which the flow state belongs to.
flowStateName	String	The name of the flow state, if the formal parameter is on a flow state.
pipelineName	String	The name of the pipeline
procedureName	String	The name of the procedure.
processName	String	The name of the process, if the actual parameter is on a process step.
processStepName	String	The name of the process step, if the actual parameter is on a process step.
scheduleName	String	The name of the schedule.
stateDefinitionName	String	The name of the state definition.
stepName	String	The name of the step.
tierMapName	String	The name of the tier map.
transitionDefinitionName	String	The name of the state definition.
triggerName	String	The name of the trigger.
value	String	The value of the actual parameter, if creating or modifying.
widgetName	String	The name of the widget.
workflowDefinitionName	String	The name of the workflow definition.

Argument Name

Type

Description

projectName

String

The name for the project that must be unique among all projects. (Required)

actualParameterName

String

The name of the parameter to create/modify/delete. (Required)

releaseName

String

The name of the release, if the actual parameter is on a release.

applicationName

String

The name of the application, if the actual parameter is on an application process step.

archiveConnectorName

String

The name of the archive connector.

catalogItemName

String

The name of the Catalog Item

catalogItemRunId

String

The id of the catalog item run, if the actual parameter is on an catalog item run.

catalogName

String

The name of the Catalog

componentName

String

The name of the component, if the actual parameter is on a component process step.

dashboardName

String

The name of the dashboard.

flowName

String

The name of the flow to which the flow state belongs to.

flowStateName

String

The name of the flow state, if the formal parameter is on a flow state.

pipelineName

String

The name of the pipeline

procedureName

String

The name of the procedure.

processName

String

The name of the process, if the actual parameter is on a process step.

processStepName

String

The name of the process step, if the actual parameter is on a process step.

scheduleName

String

The name of the schedule.

stateDefinitionName

String

The name of the state definition.

stepName

String

The name of the step.

tierMapName

String

The name of the tier map.

transitionDefinitionName

String

The name of the state definition.

triggerName

String

The name of the trigger.

value

String

The value of the actual parameter, if creating or modifying.

widgetName

String

The name of the widget.

workflowDefinitionName

String

The name of the workflow definition.

Usage

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 */)▼

deleteActualParameter

Delete an actual parameter.

Arguments

Argument Name	Type	Description
projectName	String	The name for the project that must be unique among all projects. (Required)
actualParameterName	String	The name of the parameter to create/modify/delete. (Required)
releaseName	String	The name of the release, if the actual parameter is on a release.
applicationName	String	The name of the application, if the actual parameter is on an application process step.
archiveConnectorName	String	The name of the archive connector.
catalogItemName	String	The name of the Catalog Item
catalogItemRunId	String	The id of the catalog item run, if the actual parameter is on an catalog item run.
catalogName	String	The name of the Catalog
componentName	String	The name of the component, if the actual parameter is on a component process step.
dashboardName	String	The name of the dashboard.
flowName	String	The name of the flow to which the flow state belongs to.
flowStateName	String	The name of the flow state, if the formal parameter is on a flow state.
pipelineName	String	The name of the pipeline
procedureName	String	The name of the procedure.
processName	String	The name of the process, if the actual parameter is on a process step.
processStepName	String	The name of the process step, if the actual parameter is on a process step.
scheduleName	String	The name of the schedule.
stateDefinitionName	String	The name of the state definition.
stepName	String	The name of the step.
tierMapName	String	The name of the tier map.
transitionDefinitionName	String	The name of the state definition.
triggerName	String	The name of the trigger.
widgetName	String	The name of the widget.
workflowDefinitionName	String	The name of the workflow definition.

Argument Name

Type

Description

projectName

String

The name for the project that must be unique among all projects. (Required)

actualParameterName

String

The name of the parameter to create/modify/delete. (Required)

releaseName

String

The name of the release, if the actual parameter is on a release.

applicationName

String

The name of the application, if the actual parameter is on an application process step.

archiveConnectorName

String

The name of the archive connector.

catalogItemName

String

The name of the Catalog Item

catalogItemRunId

String

The id of the catalog item run, if the actual parameter is on an catalog item run.

catalogName

String

The name of the Catalog

componentName

String

The name of the component, if the actual parameter is on a component process step.

dashboardName

String

The name of the dashboard.

flowName

String

The name of the flow to which the flow state belongs to.

flowStateName

String

The name of the flow state, if the formal parameter is on a flow state.

pipelineName

String

The name of the pipeline

procedureName

String

The name of the procedure.

processName

String

The name of the process, if the actual parameter is on a process step.

processStepName

String

The name of the process step, if the actual parameter is on a process step.

scheduleName

String

The name of the schedule.

stateDefinitionName

String

The name of the state definition.

stepName

String

The name of the step.

tierMapName

String

The name of the tier map.

transitionDefinitionName

String

The name of the state definition.

triggerName

String

The name of the trigger.

widgetName

String

The name of the widget.

workflowDefinitionName

String

The name of the workflow definition.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getActualParameter_32

Get an actual parameter by name.

Arguments

Argument Name	Type	Description
actualParameterName	String	The name of the parameter (Required)
jobId	String	The primary key of the job, or the name of the job.
applicationEntityRevisionId	String	Revisionid of the versioned object
applicationName	String	The name of the application, if the actual parameter is on an application process step.
catalogItemName	String	The name of the catalog item.
catalogItemRunId	String	The id of the catalog item run, if the actual parameter is on an catalog item run.
catalogName	String	The name of a catalog.
componentName	String	The name of the component, if the actual parameter is on a component process step.
dashboardName	String	The name of the dashboard.
flowName	String	The name of the flow to which the flow state belongs to.
flowRuntimeId	String	The id of the flow runtime, to which flow runtime belongs
flowRuntimeName	String	The name of the flow runtime, to which flow runtime belongs
flowRuntimeStateId	String	The id of the flow runtime state.
flowRuntimeStateName	String	The name of the flow runtime state
flowStateName	String	The name of the flow state, if the actual parameter is on a flow state.
jobStepId	String	The primary key for a job step.
pipelineName	String	The name of a pipeline.
procedureName	String	The name of a procedure.
processName	String	The name of the process, if the actual parameter is on a process step.
processStepName	String	The name of the process step, if the actual parameter is on a process step.
projectName	String	The name of a project.
releaseName	String	The name of the release, if the actual parameter is on release.
scheduleName	String	The name of a schedule.
searchJobStepHierarchy	Boolean	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	String	The name of a workflow state definition.
stateName	String	The name of a workflow state.
stepName	String	The name of a procedure step.
tierMapName	String	The name of the tier map.
transitionDefinitionName	String	The name of a workflow transition definition.
transitionName	String	The name of a workflow transition.
triggerName	String	The name of the trigger.
widgetName	String	The name of a widget.
workflowDefinitionName	String	The name of a workflow definition.
workflowName	String	The name of a workflow.

Argument Name

Type

Description

actualParameterName

String

The name of the parameter (Required)

jobId

String

The primary key of the job, or the name of the job.

applicationEntityRevisionId

String

Revisionid of the versioned object

applicationName

String

The name of the application, if the actual parameter is on an application process step.

catalogItemName

String

The name of the catalog item.

catalogItemRunId

String

The id of the catalog item run, if the actual parameter is on an catalog item run.

catalogName

String

The name of a catalog.

componentName

String

The name of the component, if the actual parameter is on a component process step.

dashboardName

String

The name of the dashboard.

flowName

String

The name of the flow to which the flow state belongs to.

flowRuntimeId

String

The id of the flow runtime, to which flow runtime belongs

flowRuntimeName

String

The name of the flow runtime, to which flow runtime belongs

flowRuntimeStateId

String

The id of the flow runtime state.

flowRuntimeStateName

String

The name of the flow runtime state

flowStateName

String

The name of the flow state, if the actual parameter is on a flow state.

jobStepId

String

The primary key for a job step.

pipelineName

String

The name of a pipeline.

procedureName

String

The name of a procedure.

processName

String

The name of the process, if the actual parameter is on a process step.

processStepName

String

The name of the process step, if the actual parameter is on a process step.

projectName

String

The name of a project.

releaseName

String

The name of the release, if the actual parameter is on release.

scheduleName

String

The name of a schedule.

searchJobStepHierarchy

Boolean

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

String

The name of a workflow state definition.

stateName

String

The name of a workflow state.

stepName

String

The name of a procedure step.

tierMapName

String

The name of the tier map.

transitionDefinitionName

String

The name of a workflow transition definition.

transitionName

String

The name of a workflow transition.

triggerName

String

The name of the trigger.

widgetName

String

The name of a widget.

workflowDefinitionName

String

The name of a workflow definition.

workflowName

String

The name of a workflow.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getActualParameter(
                actualParameterName: 'test-actualParameterName'
                /* optional arguments */)▼

modifyActualParameter

Modify an existing actual parameter.

Arguments

Argument Name	Type	Description
projectName	String	The name for the project that must be unique among all projects. (Required)
actualParameterName	String	The name of the parameter to create/modify/delete. (Required)
scheduleName	String	The name of the schedule.
applicationName	String	The name of the application, if the actual parameter is on an application process step.
archiveConnectorName	String	The name of the archive connector.
catalogItemName	String	The name of the Catalog Item
catalogItemRunId	String	The id of the catalog item run, if the actual parameter is on an catalog item run.
catalogName	String	The name of the Catalog
componentName	String	The name of the component, if the actual parameter is on a component process step.
dashboardName	String	The name of the dashboard.
flowName	String	The name of the flow to which the flow state belongs to.
flowStateName	String	The name of the flow state, if the formal parameter is on a flow state.
newName	String	New name for an existing object that is being renamed.
pipelineName	String	The name of the pipeline
procedureName	String	The name of the procedure.
processName	String	The name of the process, if the actual parameter is on a process step.
processStepName	String	The name of the process step, if the actual parameter is on a process step.
releaseName	String	The name of the release, if the actual parameter is on a release.
stateDefinitionName	String	The name of the state definition.
stepName	String	The name of the step.
tierMapName	String	The name of the tier map.
transitionDefinitionName	String	The name of the state definition.
triggerName	String	The name of the trigger.
value	String	The value of the actual parameter, if creating or modifying.
widgetName	String	The name of the widget.
workflowDefinitionName	String	The name of the workflow definition.

Argument Name

Type

Description

projectName

String

The name for the project that must be unique among all projects. (Required)

actualParameterName

String

The name of the parameter to create/modify/delete. (Required)

scheduleName

String

The name of the schedule.

applicationName

String

The name of the application, if the actual parameter is on an application process step.

archiveConnectorName

String

The name of the archive connector.

catalogItemName

String

The name of the Catalog Item

catalogItemRunId

String

The id of the catalog item run, if the actual parameter is on an catalog item run.

catalogName

String

The name of the Catalog

componentName

String

The name of the component, if the actual parameter is on a component process step.

dashboardName

String

The name of the dashboard.

flowName

String

The name of the flow to which the flow state belongs to.

flowStateName

String

The name of the flow state, if the formal parameter is on a flow state.

newName

String

New name for an existing object that is being renamed.

pipelineName

String

The name of the pipeline

procedureName

String

The name of the procedure.

processName

String

The name of the process, if the actual parameter is on a process step.

processStepName

String

The name of the process step, if the actual parameter is on a process step.

releaseName

String

The name of the release, if the actual parameter is on a release.

stateDefinitionName

String

The name of the state definition.

stepName

String

The name of the step.

tierMapName

String

The name of the tier map.

transitionDefinitionName

String

The name of the state definition.

triggerName

String

The name of the trigger.

value

String

The value of the actual parameter, if creating or modifying.

widgetName

String

The name of the widget.

workflowDefinitionName

String

The name of the workflow definition.

Usage

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


ElectricFlow ef = new ElectricFlow()

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