/  Yamcs HTTP API  /  Events  /  Stream Events

Stream EventsΒΆ

Streams back events

Warning

This method uses server-streaming. Yamcs sends an unspecified amount of data using chunked transfer encoding.

URI Template

POST /api/stream-archive/{instance}:streamEvents
{instance}

Yamcs instance name.

Request Body

interface StreamEventsRequest {
  start: string;  // RFC 3339
  stop: string;  // RFC 3339
  source: string[];
  severity: string;
  q: string;
}

Response Type

interface Event {
  source: string;
  generationTime: string;  // RFC 3339
  receptionTime: string;  // RFC 3339
  seqNumber: number;
  type: string;
  message: string;
  severity: EventSeverity;
  generationTimeUTC: string;
  receptionTimeUTC: string;

  // Set by API when event was posted by a user
  createdBy: string;
}

Related Types

enum EventSeverity {
  INFO = "INFO",
  WARNING = "WARNING",
  ERROR = "ERROR",

  //the levels below are compatible with XTCE
  // we left the 4 out since it could be used
  // for warning if we ever decide to get rid of the old ones
  WATCH = "WATCH",
  DISTRESS = "DISTRESS",
  CRITICAL = "CRITICAL",
  SEVERE = "SEVERE",
}