Pipeline Jobs

Get pipeline job

Retrieve a pipeline job by URN.

URL-encode the pipeline job URN when placing it in the request path. Each colon (:) becomes %3A.

get/pipeline-monitoring/v1/pipeline-jobs/{pipelineJobUrn}

Request

  • Base URL
    https://your-environment.ataccama.one/api
  • Auth
    HTTP bearer

Path parameters

pipelineJobUrnstring uri required

URN of an observed pipeline job.

Format: urn:ata:{tenant}:pipeline-monitoring:pipeline-job:{uuid}

Example: urn:ata:acme-corp:pipeline-monitoring:pipeline-job:0197f3a0-5555-7c0c-8f9d-3a2b4c5d6e7f.

Example:urn:ata:acme-corp:pipeline-monitoring:pipeline-job:0197f3a0-5555-7c0c-8f9d-3a2b4c5d6e7f

Pipeline job URN.

Response

The requested pipeline job.

urnstring uri required

URN of an observed pipeline job.

Format: urn:ata:{tenant}:pipeline-monitoring:pipeline-job:{uuid}

Example: urn:ata:acme-corp:pipeline-monitoring:pipeline-job:0197f3a0-5555-7c0c-8f9d-3a2b4c5d6e7f.

namestring required

The fully qualified job name as observed (the OpenLineage job name), for example, analytics.nightly_customers. Within one orchestrator, the combination of name and namespace is unique.

namespacestring required

The OpenLineage namespace of the job, for example, dbt or default. The namespace can be any value the orchestrator reports.

orchestratorUrnstring uri required

URN of a pipeline orchestrator connection.

Format: urn:ata:{tenant}:pipeline-monitoring:orchestrator:{uuid}

Example: urn:ata:acme-corp:pipeline-monitoring:orchestrator:0197f3a0-6666-7c0c-8f9d-3a2b4c5d6e7f.

Example response

{
  "urn": "urn:ata:acme-corp:pipeline-monitoring:pipeline-job:0197f3a0-5555-7c0c-8f9d-3a2b4c5d6e7f",
  "orchestratorUrn": "urn:ata:acme-corp:pipeline-monitoring:orchestrator:0197f3a0-6666-7c0c-8f9d-3a2b4c5d6e7f"
}

Changes

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