runCatalogItem

On this page
Back to index

Summary

Run a catalog item.
projectName
Stringrequired
The name for the project that must be unique among all projects.
catalogName
Stringrequired
The name of the catalog.
catalogItemName
Stringrequired
The name of the catalog item.
actualParameters
Array<ActualParameter>optional
Parameters passed as arguments to the procedure or to DSL.
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.
formParameters
Array<FormParameter>optional
Parameters passed as arguments to the DSL.
parsedWebhookData
Stringoptional
JSON with parsed webhook data to be set on a pipeline/release/procedure run.
scheduleName
Stringoptional
Name for the schedule; must be unique among all schedules for the project.
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.runCatalogItem( projectName: "test-projectName", catalogName: "test-catalogName", catalogItemName: "test-catalogItemName" /* optional arguments */ )