List Parameter Index¶

List parameter index

URI Template

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

{instance}

Yamcs instance name

Query Parameters

mergeTime

Value in milliseconds that indicates the maximum gap before two consecutive index ranges are merged together. Default: 20000

limit

The maximum number of returned entries. Choose this value too high and you risk hitting the maximum response size limit enforced by the server. Default: 1000. Note that in general it is advised to control the size of the response via mergeTime, rather than via limit.

start

Filter the lower bound of the index entries. Specify a date string in ISO 8601 format.

stop

Filter the upper bound of the index entries. Specify a date string in ISO 8601 format.

next

Continuation token returned by a previous page response.

group

Filter on specific parameter groups.

Response Type

interface IndexResponse {
  group: IndexGroup[];

  // 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

interface IndexGroup {
  id: NamedObjectId;
  entry: IndexEntry[];
}

// Used by external clients to identify an item in the Mission Database
// If namespace is set, then the name is that of an alias, rather than
// the qualified name.
interface NamedObjectId {
  name: string;
  namespace: string;
}

interface IndexEntry {
  start: string;
  stop: string;
  count: number;
  seqStart: string;  // String decimal
  seqStop: string;  // String decimal
}