/  Yamcs HTTP API  /  Stream Archive  /  Export Parameter Values

Export Parameter ValuesΒΆ

Export parameter values in CSV format

Warning

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

URI Template

GET /api/archive/{instance}:exportParameterValues
POST /api/archive/{instance}:exportParameterValues
{instance}

Yamcs instance name

Query Parameters

start

Filter the lower bound of the parameter's generation time. Specify a date string in ISO 8601 format.

stop

Filter the upper bound of the parameter's generation time. Specify a date string in ISO 8601 format.

parameters

The parameters to add to the export.

list

Identifier of a Parameter List, describing the parameters to export.

This may be used as an alternative to the parameters field.

namespace

Namespace used to display parameter names in csv header. Only used when no parameter ids were specified.

extra

Extra columns added to the CSV output:

  • raw: Raw parameter values

  • monitoring: Monitoring status

delimiter

Column delimiter. One of TAB, COMMA or SEMICOLON. Default: TAB.

interval

When specified, only one value each for each interval is returned. The value is in milliseconds.

preserveLastValue

If true, repeat the the previous value, if there is no value for the current timestamp. Default: false.

pos

The zero-based row number at which to start outputting results. Default: 0.

limit

The maximum number of returned records. Default: unlimited.

order

The order of the returned results. Can be either asc or desc. Default: asc.

filename

Preferred filename, this is returned in a Content-Disposition HTTP header. If unset, Yamcs will determine a name.

header

Header row to include in the response. One of QUALIFIED_NAME, SHORT_NAME or NONE. Default: QUALIFIED_NAME.