getProcessStep

Back to index

Summary

Retrieves an application or component process step.

projectName

Stringrequired

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

processName

Stringrequired

The name of the process.

processStepName

Stringrequired

The name of the process step.

applicationEntityRevisionId

UUIDoptional

The revision ID of the versioned object.

applicationName

Stringoptional

The name of the application, if the process is owned by an application.

componentApplicationName

Stringoptional

If specified, the component is scoped to this application not the project.

componentName

Stringoptional

The name of the component, if the process is owned by a component.

microserviceApplicationName

Stringoptional

If specified, the microservice is scoped to an application.

microserviceName

Stringoptional

The name of the microservice, if the process is owned by a microservice.

Usage

Perl

$cmdr->getProcessStep(
  "test-projectName", # projectName
  "test-processName", # processName
  "test-processStepName" # processStepName
  # optionals
);▼

ectool

ectool getProcessStep \
  "test-projectName" `# projectName` \
  "test-processName" `# processName` \
  "test-processStepName" `# processStepName` \
  # optionals▼

Examples

Perl

To retrieve a component process step in a master component:

$cmdr->getProcessStep('Default', 'Deploy', 'Check out', {componentName => 'WAR file'});▼

To retrieve a component process step in a specific application:

$cmdr->getProcessStep('Default', 'Deploy', 'Check out', {componentName => 'WAR file', componentApplicationName => 'Shopping Cart'});▼

To retrieve an application process step:

$cmdr->getProcessStep('Default', 'Deploy', 'Check out', {applicationName => 'Shopping Cart'});▼

ectool

To retrieve a component process step in a master component:

ectool getProcessStep 'Default' 'Deploy' 'Check out' --componentName 'WAR file'▼

To retrieve a component process step in a specific application:

ectool getProcessStep 'Default' 'Deploy' 'Check out' --componentName 'WAR file' --componentApplicationName 'Shopping Cart'▼

To retrieve an application process step:

ectool getProcessStep  'Default' 'Deploy' 'Check out' --applicationName 'Shopping Cart'▼