Docs / Yamcs HTTP API / Commanding / Download Commands

Download Commands

Download command history:

GET /api/archive/:instance/downloads/commands

This operation will possibly download a very large file.

Parameters

Name Type Description
start string Filter the lower bound of the command's generation time. Specify a date string in ISO 8601 format. This bound is inclusive.
stop string Filter the upper bound of the command'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 command history records.

Alternative Media Types

Protobuf

Use HTTP header:

Accept: application/protobuf

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

commanding/commanding.proto 
message CommandHistoryAttribute {
  optional string name = 1;
  optional yamcs.Value value = 2;
  optional int64 time = 3;
}

message CommandHistoryEntry {
  required CommandId commandId = 1;
  repeated CommandHistoryAttribute attr = 3;
}