Skip to content
Kumquat
Esc
↑↓navigate↵open⌘Jpreview

Run As Of

The run as it stood then: what was wired, where it sat, and what every node held.

Kept rather than worked out — the state that made a file is written down before anything can overwrite it (RunVersion), and a run nothing has changed since is its own record, live.

A moment no version spans is a state that produced nothing, which is why it was not kept. Its wiring is still in the log, so that is what comes back, without results: those were overwritten and are nobody’s to give back. A moment the log no longer reaches comes back empty.

GET/api/v1/runs/{run_id}/at
Authorization
AuthorizationBearer token · headerrequired
or
AuthorizationOAuth2 access token · headerrequired
Path parameters
run_idstringrequired
Query parameters
atstring<date-time>required
The moment being read
generationinteger | any
The state a file came out of, as stamped on it — exact where a moment is not
Responses
200Successful Response
successboolean
default: true
dataRunAsOf | any
Show properties
Any of:
RunAsOf
liveboolean
default: false
definitionobject
ui_stateobject
nodesobject
any
any
messagestring | any
Show properties
Any of:
string
string
any
any
errorsstring[] | any
Show properties
Any of:
string[]
Array of string
string
any
any
422Validation Error
detailValidationError[]
Show properties
Array of ValidationError
locstring | integer[]required
Show properties
Array of string | integer
Any of:
string
string
integer
integer
msgstringrequired
typestringrequired
inputany
ctxobject
Request
curl -X GET "/api/v1/runs/string/at?at=2019-08-24T14%3A15%3A22Z" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "success": true,
  "data": {
    "live": false,
    "definition": {},
    "ui_state": {},
    "nodes": {
      "property1": {
        "status": "pending",
        "progress": 0,
        "outputs": {},
        "error": "string",
        "message": "string",
        "credits_consumed": 0,
        "duration_seconds": 0,
        "checkpoint": {},
        "items": {
          "property1": {
            "status": "pending",
            "progress": 0,
            "outputs": {},
            "error": "string",
            "message": "string",
            "credits_consumed": 0,
            "duration_seconds": 0,
            "checkpoint": {}
          },
          "property2": {
            "status": "pending",
            "progress": 0,
            "outputs": {},
            "error": "string",
            "message": "string",
            "credits_consumed": 0,
            "duration_seconds": 0,
            "checkpoint": {}
          }
        },
        "started_at": "2019-08-24T14:15:22Z"
      },
      "property2": {
        "status": "pending",
        "progress": 0,
        "outputs": {},
        "error": "string",
        "message": "string",
        "credits_consumed": 0,
        "duration_seconds": 0,
        "checkpoint": {},
        "items": {
          "property1": {
            "status": "pending",
            "progress": 0,
            "outputs": {},
            "error": "string",
            "message": "string",
            "credits_consumed": 0,
            "duration_seconds": 0,
            "checkpoint": {}
          },
          "property2": {
            "status": "pending",
            "progress": 0,
            "outputs": {},
            "error": "string",
            "message": "string",
            "credits_consumed": 0,
            "duration_seconds": 0,
            "checkpoint": {}
          }
        },
        "started_at": "2019-08-24T14:15:22Z"
      }
    }
  },
  "message": "string",
  "errors": [
    "string"
  ]
}