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.

componentName

Stringoptional

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

processName

Stringrequired

The name of the process.

processStepName

Stringrequired

The name of the process step.

applicationEntityRevisionId

Stringoptional

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.

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

Groovy

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

ElectricFlow ef = new ElectricFlow()

def result = ef.getProcessStep(
  projectName: "test-projectName",
  processName: "test-processName",
  processStepName: "test-processStepName"
  /* optional arguments */
)▼