/  Yamcs HTTP API  /  Parameter Archive  /  Get Archived Parameter Group

Get Archived Parameter GroupΒΆ

For a given group id, get the list of parameters which are part of the group

URI Template

GET /api/archive/{instance}/parameterArchive/info/groups/{gid*}
{instance}

Yamcs instance name

{gid*}

Group identifier

Response Type

interface ArchivedParameterGroupResponse {

  // Group identifier
  gid: number;

  // Parameters belonging to the group
  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",
}