abortJobStep

Back to index

Summary

Abort a running job step.

Aborting a subprocedure step also aborts all steps of the subprocedure.
Steps marked always run still run to completion unless the force flag is specified.
You must enter a jobStepId.

jobStepId

UUIDrequired

The primary key for a 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.

reason

Stringoptional

User-supplied string.

Usage

Perl

$cmdr->abortJobStep(
  "test-jobStepId" # jobStepId
  # optionals
);▼

ectool

ectool abortJobStep \
  "test-jobStepId" `# jobStepId` \
  # optionals▼

Examples

Perl

$cmdr->abortJobStep(5da765dd-73f1-11e3-b67e-b0a420524153, {force => 1});▼

ectool

ectool abortJobStep 5da765dd-73f1-11e3-b67e-b0a420524153▼