Create a run

deprecated

This endpoint has been deprecated and may be removed in future versions of the API.

Creates a new run object for a job.

Path Parameters

namespace string required

Possible values: <= 1024 characters

The name of the namespace.

job string required

Possible values: <= 1024 characters

The name of the job.

application/json

Request Body

id uuid

An optional user-provided unique ID of the run. A run ID must be an UUID. If an ID for the run is not provided, a random UUID will be generated for the given run.

nominalStartTime date-time

An ISO-8601 timestamp representing the nominal start time of the run.

nominalEndTime date-time

An ISO-8601 timestamp representing the nominal end time of the run.

args object

The arguments of the run.

Responses

• 201

---

CREATED

application/json

Schema

Example (from schema)

---

Schema

anyOf
IncompleteRun
MOD2
---
id uuid
The ID of the run.
createdAt date-time
An ISO-8601 timestamp representing the date/time the run was created.
updatedAt date-time
An ISO-8601 timestamp representing the date/time the run was updated.
nominalStartTime date-time
An ISO-8601 timestamp representing the nominal start time of the run.
nominalEndTime date-time
An ISO-8601 timestamp representing the nominal end time of the run.
state string
Possible values: [NEW, RUNNING, COMPLETED, FAILED, ABORTED]
The current state of the run.
startedAt date-time
An ISO-8601 timestamp representing the start time of the run.
endedAt date-time
An ISO-8601 timestamp representing the end time of the run.
durationMs integer
The total duration of the run. Measured in milliseconds.
args object
The arguments of the run.
facets object
The facets of the run. For a full list of standard run facets, see OpenLineage.
description
allOf
title
jobVersion object
namespace string
The namespace of the job.
name string
The name of the job.
version uuid
The version of the job.
inputDatasetVersions object[]
Array [
datasetVersionId object required
namespace string required
The namespace of the dataset.
name string required
The name of the dataset.
version uuid required
The version of the dataset.
facets object required
Dataset facets in run context, like inputFacets.
property name* string
]
outputDatasetVersions object[]
Array [
datasetVersionId object required
namespace string required
The namespace of the dataset.
name string required
The name of the dataset.
version uuid required
The version of the dataset.
facets object required
Dataset facets in run context, like outputFacets.
property name* string
]
context object deprecated
A key/value pair that must be of type string. A context can be used for getting additional details about the job.
facets object
The facets of the run. For a full list of standard run facets, see OpenLineage.
description
allOf
title

{
  "id": "870492da-ecfb-4be0-91b9-9a89ddd3db90",
  "createdAt": "2019-05-09T19:49:24.201361Z",
  "updatedAt": "2019-05-09T19:49:24.201361Z",
  "nominalStartTime": null,
  "nominalEndTime": null,
  "state": "COMPLETED",
  "startedAt": "2019-05-09T15:17:32.690346",
  "endedAt": "2019-05-09T20:05:46.815920Z",
  "durationMs": 4250894125,
  "args": {
    "email": "me@example.com",
    "emailOnFailure": "false",
    "emailOnRetry": "true",
    "retries": "1"
  },
  "context": {
    "SQL": "SELECT * FROM mytable;"
  },
  "facets": {}
}

POST /namespaces/:namespace/jobs/:job/runs

Request

Base URL

http://localhost:5000/api/v1

namespace — path required

job — path required

Body

{
  "args": {
    "email": "me@example.com",
    "emailOnFailure": false,
    "emailOnRetry": true,
    "retries": 1
  }
}

curl / cURL

curl -L -X POST 'http://localhost:5000/api/v1/namespaces/:namespace/jobs/:job/runs' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "args": {
    "email": "me@example.com",
    "emailOnFailure": false,
    "emailOnRetry": true,
    "retries": 1
  }
}'

python / requests

curl -L -X POST 'http://localhost:5000/api/v1/namespaces/:namespace/jobs/:job/runs' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "args": {
    "email": "me@example.com",
    "emailOnFailure": false,
    "emailOnRetry": true,
    "retries": 1
  }
}'

go / native

curl -L -X POST 'http://localhost:5000/api/v1/namespaces/:namespace/jobs/:job/runs' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "args": {
    "email": "me@example.com",
    "emailOnFailure": false,
    "emailOnRetry": true,
    "retries": 1
  }
}'

nodejs / axios

curl -L -X POST 'http://localhost:5000/api/v1/namespaces/:namespace/jobs/:job/runs' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "args": {
    "email": "me@example.com",
    "emailOnFailure": false,
    "emailOnRetry": true,
    "retries": 1
  }
}'

ruby / Net::HTTP

curl -L -X POST 'http://localhost:5000/api/v1/namespaces/:namespace/jobs/:job/runs' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "args": {
    "email": "me@example.com",
    "emailOnFailure": false,
    "emailOnRetry": true,
    "retries": 1
  }
}'

csharp / RestSharp

curl -L -X POST 'http://localhost:5000/api/v1/namespaces/:namespace/jobs/:job/runs' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "args": {
    "email": "me@example.com",
    "emailOnFailure": false,
    "emailOnRetry": true,
    "retries": 1
  }
}'

php / cURL

curl -L -X POST 'http://localhost:5000/api/v1/namespaces/:namespace/jobs/:job/runs' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "args": {
    "email": "me@example.com",
    "emailOnFailure": false,
    "emailOnRetry": true,
    "retries": 1
  }
}'

java / OkHttp

curl -L -X POST 'http://localhost:5000/api/v1/namespaces/:namespace/jobs/:job/runs' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "args": {
    "email": "me@example.com",
    "emailOnFailure": false,
    "emailOnRetry": true,
    "retries": 1
  }
}'

powershell / RestMethod

curl -L -X POST 'http://localhost:5000/api/v1/namespaces/:namespace/jobs/:job/runs' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "args": {
    "email": "me@example.com",
    "emailOnFailure": false,
    "emailOnRetry": true,
    "retries": 1
  }
}'