ATataccama
Workflows

Cancel workflow

Cancel a running workflow, identified by its URN, and return the workflow. Only a PENDING or RUNNING workflow can be canceled; canceling a workflow that is already CANCELED succeeds and returns it unchanged. A workflow in any other terminal state (for example FINISHED or FAILED) cannot be canceled and returns 409 Conflict. Only the workflow's owner or an administrator can cancel it.

The workflow is CANCELED as soon as the request succeeds, and no new jobs are started for it. Its PENDING and RUNNING jobs are canceled too, but may take a moment to stop; use List jobs to follow them.

post/processing/v1/workflows/{workflowUrn}/cancel

Request

Path parameters

workflowUrnstring uri required

A URN identifying a processing workflow.

Format: urn:ata:{tenant}:processing:workflow:{uuid}

Example: urn:ata:acme-corp:processing:workflow:123e4567-e89b-12d3-a456-426614174000.

Example:urn:ata:acme-corp:processing:workflow:123e4567-e89b-12d3-a456-426614174000

Response

The canceled processing workflow

urnstring uri required

A URN identifying a processing workflow.

Format: urn:ata:{tenant}:processing:workflow:{uuid}

Example: urn:ata:acme-corp:processing:workflow:123e4567-e89b-12d3-a456-426614174000.

typestring required

Type of the workflow, for example DQ-JOB for a DQ monitor processing.

namestring

Human-readable name of the workflow.

ownerstring
startedAtstring date-time required

When the workflow started.

finishedAtstring date-time

When the workflow finished.

durationinteger

Duration of the run.

statusstring required

@ExtensibleEnum The current status of the processing workflow.

  • PENDING: not started yet — keep polling.
  • RUNNING: in progress — keep polling.
  • FINISHED: completed successfully; its results are ready to retrieve.
  • FAILED: did not complete — see errors. No results are available for this run.
  • CANCELED: canceled before completion. No results are available for this run.
  • SKIPPED: there was nothing to run (for example, the DQ monitor has no rules assigned). No results are available for this run.

PENDING and RUNNING are the only non-terminal values. The set is extensible, so treat any value you do not recognize as not-success: proceed to results only on FINISHED.

Example response

{
  "urn": "urn:ata:acme-corp:processing:workflow:123e4567-e89b-12d3-a456-426614174000",
  "type": "DQ-JOB",
  "name": "CUSTOMERS / Primary Monitor",
  "owner": "jane.doe",
  "status": "PENDING",
  "errors": [
    {
      "job": "urn:ata:acme-corp:processing:job:123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.