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 beloging 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/archive/{instance}/parameterArchive/info/parameters

{instance}

Yamcs instance name.

Query Parameters

q

The search keywords.

system

List only direct child parameters of the specified system. Only the parameters whose fully qualified name start with system will be returned.

When system and q are used together, the q search will be matched on the parameters filtered by system.

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

Response Type

interface ArchivedParametersInfoResponse {
  parameters: ArchivedParameterInfo[];
}

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 a 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 will contain data even for parameters removed from the MDB
interface ArchivedParameterInfo {

  //parameter id
  pid: number;

  //parameter fully qualified name
  fqn: string;

  // parameter raw type
  rawType: Type;

  //parameter engineering type
  engType: Type;

  //the groups which this parameter is part of
  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",
}