Get Archived Parameters Info¶

Get information about the archived parameters.

Each combination of (parameter name, raw type, engineering type) is assigned a unique parameter id.

The parameters are grouped such that the samples of all parameters from one group have the same timestamp. For example all parameters extracted from one TM packet have usually the same timestamp and are part of the same group.

Each group is assigned a unique group id.

A parameter can be part of multiple groups. For instance a parameter appearing in the header of a packet is part of all groups made by inherited containers (i.e. each packet with that header will compose another group).

For each group, the parameter archive stores one common record for the timestamps and individual records for the raw and engineering values of each parameter. If a parameter appears in multiple groups, retrieving its value means combining (time-based merge operation) the records belonging to the groups in which the parameter appears.

The response to this method contains the parameter id, name, engineering type, raw type and the groups of which this parameter is part of.

URI Template

GET /api/parameter-archive/{instance}/pids

{instance}

Yamcs instance name

Query Parameters

filter

Filter query. See Filtering for how to write a filter query.

Literal text search matches against the field parameter.

Field comparisons can use any of the following fields:

pid	number
parameter	string
rawType	enum	One of float, double, uint32, sint32, binary, string, timestamp, uint64, sint64, boolean, aggregate, array, enumerated or none.
gid	number

limit

The maximum number of returned parameters. Choose this value too high and you risk hitting the maximum response size limit enforced by the server. Default: 100

next

Continuation token returned by a previous page response.

Response Type

interface ArchivedParametersInfoResponse {
  pids: ArchivedParameterInfo[];

  // Token indicating the response is only partial. More results can then
  // be obtained by performing the same request (including all original
  // query parameters) and setting the ``next`` parameter to this token.
  continuationToken: string;
}

Related Types

// This message contains information about one parameter in the parameter archive.
// Each (parameter name, raw type, engineering type) is assigned a unique id and all
// the samples are stored with that id.
//
// If an MDB change results in the parameter having a different engineering or raw type,
// a new pid will be allocated.
//
// This is why for the same parameter name, we can have multiple parameter ids.
//
// The parameter archive contains data even for parameters removed from the MDB.
interface ArchivedParameterInfo {

  // Parameter ID
  pid: number;

  // Fully-qualified parameter name
  parameter: string;

  // Raw type
  rawType: Type;

  // Engineering type
  engType: Type;

  // Groups where this parameter is included
  gids: number[];
}

enum Type {
  FLOAT = "FLOAT",
  DOUBLE = "DOUBLE",
  UINT32 = "UINT32",
  SINT32 = "SINT32",
  BINARY = "BINARY",
  STRING = "STRING",
  TIMESTAMP = "TIMESTAMP",
  UINT64 = "UINT64",
  SINT64 = "SINT64",
  BOOLEAN = "BOOLEAN",
  AGGREGATE = "AGGREGATE",
  ARRAY = "ARRAY",

  // Enumerated values have both an integer (sint64Value) and a string representation
  ENUMERATED = "ENUMERATED",
  NONE = "NONE",
}