Start a run

deprecated

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

Marks the run as RUNNING.

Path Parameters

id uuid required

The ID of the run.

Query Parameters

at date-time

An ISO-8601 timestamp representing the time when the run transitioned.

Responses

• 200

---

OK

application/json

Schema

Example (from schema)

---

Schema

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

{
  "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": "RUNNING",
  "startedAt": "2019-05-09T15:17:32.690346",
  "endedAt": null,
  "durationMs": null,
  "args": {
    "email": "me@example.com",
    "emailOnFailure": "false",
    "emailOnRetry": "true",
    "retries": "1"
  },
  "facets": {}
}

POST /jobs/runs/:id/start

Request

Base URL

http://localhost:5000/api/v1

id — path required

at — query

curl / cURL

curl -L -X POST 'http://localhost:5000/api/v1/jobs/runs/:id/start' \
-H 'Accept: application/json'

python / requests

curl -L -X POST 'http://localhost:5000/api/v1/jobs/runs/:id/start' \
-H 'Accept: application/json'

go / native

curl -L -X POST 'http://localhost:5000/api/v1/jobs/runs/:id/start' \
-H 'Accept: application/json'

nodejs / axios

curl -L -X POST 'http://localhost:5000/api/v1/jobs/runs/:id/start' \
-H 'Accept: application/json'

ruby / Net::HTTP

curl -L -X POST 'http://localhost:5000/api/v1/jobs/runs/:id/start' \
-H 'Accept: application/json'

csharp / RestSharp

curl -L -X POST 'http://localhost:5000/api/v1/jobs/runs/:id/start' \
-H 'Accept: application/json'

php / cURL

curl -L -X POST 'http://localhost:5000/api/v1/jobs/runs/:id/start' \
-H 'Accept: application/json'

java / OkHttp

curl -L -X POST 'http://localhost:5000/api/v1/jobs/runs/:id/start' \
-H 'Accept: application/json'

powershell / RestMethod

curl -L -X POST 'http://localhost:5000/api/v1/jobs/runs/:id/start' \
-H 'Accept: application/json'