ATataccama
Workflows

Get workflow

Retrieve the state of a specific workflow, typically to poll a processing until it completes.

The polling.href link returned when the run was started leads to this operation. For a run started elsewhere, take the workflow URN from the urn field in the List workflows response.

While status is PENDING or RUNNING, the response includes a Retry-After header with the number of seconds to wait before polling again. Any other status is terminal. Proceed to the run's results only on FINISHED.

A failed workflow lists its failures in errors. Each entry carries the URN of the failed job and a reason. Retrieve the job for further details.

For polling a DQ evaluation, including what each status value means for your pipeline, see Run DQ evaluation from pipelines.

get/processing/v1/workflows/{workflowUrn}

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 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.