Docs / Yamcs HTTP API / Parameter Values / Download Parameter Data

Download Parameter Data

Download archived parameters:

GET /api/archive/:instance/downloads/parameters/:namespace/:name

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

Parameters

Name Type Description
start string Filter the lower bound of the parameter's generation time. Specify a date string in ISO 8601 format
stop string Filter the upper bound of the parameter's generation time. Specify a date string in ISO 8601 format
norepeat bool Whether to filter out consecutive identical values. Default no.
order string The order of the returned results. Can be either asc or desc. Default: asc

When using CSV output some columns are hidden by default. You can add them via the extra flag:

Name Type Description
extra array of strings Extra columns added to the CSV output:
  • raw: Raw parameter values
  • monitoring: Monitoring status
Example: ?extra=raw,monitoring

Response

The response will be a stream of individual parameters.

Multi-get

Get the value history of multiple parameters in one and the same request using this address:

GET /api/archive/:instance/downloads/parameters

In addition to the parameters for the single parameter retrieval you can specify these:

Name Type Description
namespace string Namespace used to display parameter names in e.g. csv header. Only used when no parameter ids were specified
ids list of name pairs Parameters to be included in the output. If not specified, all parameters from the MDB will be dumped.

Example:

{
  "id" : [ {
    "name": "YSS_ccsds-apid",
    "namespace": "MDB:OPS Name"
  }, {
    "name": "/YSS/SIMULATOR/BatteryVoltage2"
  } ]
}

POST requests are also allowed, because some HTTP clients do not support GET with a request body.

Alternative Media Types

CSV

Use HTTP header:

Accept: text/csv

Or add the query parameter format=csv.

Protobuf

Use HTTP header:

Accept: application/protobuf

Bulk request is of type:

rest/rest.proto 
message BulkDownloadParameterValueRequest {
  optional string start = 1;
  optional string stop = 2;
  repeated yamcs.NamedObjectId id = 3;
  optional string namespace = 4;
}

The response is a stream of self-standing VarInt delimited messages of type:

pvalue/pvalue.proto 
message ParameterData {
  repeated ParameterValue parameter = 1;
}