Get the frame history of a settled progress bar / redraw line

GET

/api/tasks/{taskName}/runs/{runId}/log/line/{lineNum}/history

const url = 'http://localhost:9477/api/tasks/example/runs/example/log/line/1/history';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:9477/api/tasks/example/runs/example/log/line/1/history

Returns the prior whole-region frames a progress bar or multi-line redraw passed through before settling into the committed line. Empty unless the line’s frame_count is non-zero.

Parameters

Path Parameters

taskName

required

Task name

string

>= 1 characters <= 100 characters /^[a-zA-Z0-9._:-]+$/

Task name

runId

required

Run ULID

string

>= 26 characters <= 26 characters /^[0-9A-HJKMNP-TV-Z]{26}$/

Run ULID

lineNum

required

Anchor line number to fetch frame history for

integer format: int64

Anchor line number to fetch frame history for

Responses

200

application/json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

frames

required

Prior whole-region frames, oldest first; each frame is one or more rows

array | null

Example

{
  "$schema": "http://localhost:9477/schemas/LogLineHistoryBody.json"
}

default

Error

application/problem+json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

array | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "$schema": "http://localhost:9477/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}