Docs / Yamcs HTTP API / Events / Download Events

Download Events

Download archived events:

GET /api/archive/:instance/downloads/events

This operation will possibly download a very large file. If you worry about size for your application, check out the support for paged event retrievals instead.

Parameters

Name Type Description
severity string The minimum severity level of the events. One of info, watch, warning, distress or severe. Default: info
q string Text to search for in the message.
source array of strings The source of the events. Both these notations are accepted:
  • ?source=DataHandler,CustomAlgorithm
  • ?source[]=DataHandler&source[]=CustomAlgorithm
Names must match exactly.
start string Filter the lower bound of the event's generation time. Specify a date string in ISO 8601 format. This bound is inclusive.
stop string Filter the upper bound of the event's generation time. Specify a date string in ISO 8601 format. This bound is exclusive.
order string The order of the returned results. Can be either asc or desc. Default: asc

Response

The response will be a stream of self-standing event records.

Alternative Media Types

CSV

Use HTTP header:

Accept: text/csv

Or, add this query parameter to the URI: format=csv.

Response:

Status: 200 OK
Content-Type: text/csv
Source  Generation Time Reception Time  Event Type      Event Text
AlarmChecker    2015-11-13T14:46:36.029Z 2015-11-13T14:46:36.029Z IN_LIMITS       Parameter /YSS/SIMULATOR/BatteryVoltage2 has changed to value 195
AlarmChecker    2015-11-13T14:46:29.784Z 2015-11-13T14:46:29.784Z IN_LIMITS       Parameter /YSS/SIMULATOR/BatteryVoltage2 has changed to value 196
AlarmChecker    2015-11-13T14:46:23.571Z 2015-11-13T14:46:23.571Z IN_LIMITS       Parameter /YSS/SIMULATOR/BatteryVoltage2 has changed to value 197

Protobuf

Use HTTP header:

Accept: application/protobuf

The response is a stream of individual Protobuf messages delimited by a VarInt. Messages are of type:

yamcs.proto 
message Event {
  enum EventSeverity {
    INFO = 0;
    WARNING = 1;
    ERROR = 2;
  }
  required string source = 1;
  required int64 generationTime = 2;
  required int64 receptionTime = 3;
  required int32 seqNumber = 4;
  optional string type = 5;
  required string message = 6;
  optional EventSeverity severity = 7[default=INFO];

  optional string generationTimeUTC = 8;
  optional string receptionTimeUTC = 9;

  extensions 100 to 10000;
}