Back to index
Summary
Run the specified procedure, return new job ID. If the --pollInterval option is provided, wait until the job completes up to a maximum of --timeout seconds (if also provided). If the --scheduleName option is provided, the parameters provided by that schedule will be used.projectNameStringrequiredThe name for the project that must be unique among all projects. actualParametersStringoptionalParameters passed as arguments to the procedure. credentialNameStringoptionalThe name of the credential argument. credentialReferenceParametersStringoptionalList 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. credentialsStringoptionalCredentials to be used in the job. destinationProjectStringoptionalThe project that will own the job. parsedWebhookDataStringoptionalJSON with parsed webhook data to be set on a pipeline/release/procedure run. passwordStringoptionalSecret value used to identify the account for a particular user. priorityStringoptionalThe priority of the job. Possible values: "low" , "normal" , "high" , "highest" procedureNameStringoptionalName for the procedure; must be unique within the project. scheduleNameStringoptionalName for the schedule; must be unique among all schedules for the project. userNameStringoptionalUser name under which you wish to login. webhookDataStringoptionalThe webhook data to be set on the pipeline/release/procedure run. webhookHeadersStringoptionalThe webhook headers in JSON format to be set on the pipeline/release/procedure run. |
Usage
Perl
$cmdr->runProcedure( "test-projectName" # projectName # optionals );
ectool
ectool runProcedure \ "test-projectName" `# projectName` \ # optionals