List a system's recent events, members included

GET

/systems/{name}/events

const url = 'https://example.com/api/v1/systems/example/events';
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 https://example.com/api/v1/systems/example/events

Returns the system’s own events and its members’, newest first, bounded to the last 24 hours, each row labeled by the owner that raised it. A component shared with another system appears in both systems’ lists. Gated by system:read; an out-of-scope system is a non-disclosing 404.

Parameters

Path Parameters

name

required

The system’s name, or a dotted address (e.g. boi.17c.$sys.av)

string

The system’s name, or a dotted address (e.g. boi.17c.$sys.av)

Responses

200

application/json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

events

required

Array<object> | null

object

attributes

Structured attributes, when the occurrence carried a JSON payload

event_type_id

required

The event_type’s uuid, the stable form of key

string

instance

The series discriminator (e.g. the interface), when set

string

key

required

The event_type name of the occurrence (e.g. call-started)

string

message

required

The occurrence message

string

origin

required

How the occurrence arrived (caught/caused/derived/scheduled)

string

owner

required

The owning row’s name (the system’s, or the member component’s)

string

owner_kind

required

Which arc raised the occurrence: system or component

string

provenance

required

The lineage of the occurrence (observed for direct collection)

string

source

The interface type that produced the occurrence

string

required

When the occurrence happened

string format: date-time

system

required

string

Example

{
  "$schema": "/api/v1/schemas/SystemEventsOutputBody.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<object> | 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": "/api/v1/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"
}