completeJobStep

On this page
Back to index

Summary

Completes an externally managed job step. Marks the job step completed when all child steps are completed and updates the step runtime.
jobStepId
Stringrequired
The primary key for a job step.
exitCode
Integeroptional
The exit code of the job step.
force
Booleanoptional
Instructs certain API calls to continue, even though doing to might have consequences. For example, if true, for abortJob, alwaysRun steps will be aborted as well; for import, existing objects will be replaced. If true, setDatabaseConfiguration will store the configuration even if it can't be validated.
outcome
Stringoptional
Overall outcome for a job or step: success, warning, error, or skipped.
Possible values: "success", "warning", "error", "skipped", "notRun"

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow import com.electriccloud.client.groovy.models.* ElectricFlow ef = new ElectricFlow() def result = ef.completeJobStep( jobStepId: "test-jobStepId" /* optional arguments */ )