completeJob

Back to index

Summary

Completes an externally managed job. Marks the job root step so the job is marked completed when all child steps are completed, and updates the runtime for the root step.
jobId
Stringrequired
The primary key of the job, or the name of the job.
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

Perl

$cmdr->completeJob( "test-jobId" # jobId # optionals );

ectool

ectool completeJob \ "test-jobId" `# jobId` \ # optionals

Examples

Perl

$cmdr->completeJob(1234);

ectool

ectool completeJob 1234