runProcedure

Summary

Creates and starts a new job using a procedure directly or a procedure specified indirectly through a schedule. Returns a new job ID.

projectName

Stringrequired

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

actualParameters

Array<ActualParameter>optional

Parameters passed as arguments to the procedure.

credentialName

Stringoptional

The name of the credential argument.

credentialReferenceParameters

Array<CredentialReferenceParameter>optional

List of credential parameters with references to existing credentials as parameter values. If the parameter value is a property reference then the credential would be resolved at runtime.

credentials

Array<Credential>optional

Credentials to be used in the job.

destinationProject

Stringoptional

The project that will own the job.

parsedWebhookData

Stringoptional

JSON with parsed webhook data to be set on a pipeline/release/procedure run.

password

Stringoptional

Secret value used to identify the account for a particular user.

priority

Stringoptional

The priority of the job.

Possible values: "low", "normal", "high", "highest"

procedureName

Stringoptional

Name for the procedure; must be unique within the project.

scheduleName

Stringoptional

Name for the schedule; must be unique among all schedules for the project.

userName

Stringoptional

User name under which you wish to login.

webhookData

Stringoptional

The webhook data to be set on the pipeline/release/procedure run.

webhookHeaders

Stringoptional

The webhook headers in JSON format to be set on the pipeline/release/procedure run.

Usage

Groovy

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

ElectricFlow ef = new ElectricFlow()

def result = ef.runProcedure(
  projectName: "test-projectName"
  /* optional arguments */
)▼