Stream Index¶

Streams back index records

Warning

Avoid using this method. It is tagged for removal. Use other methods that are specific in which type of index they are fetching.

Warning

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

URI Template

POST /api/archive/{instance}:streamIndex

{instance}: Yamcs instance name.

Request Body

interface StreamIndexRequest {

  // The time at which to start retrieving index records.
  start: string;  // RFC 3339

  // The time at which to stop retrieving index records.
  stop: string;  // RFC 3339

  // The type of indexes to retrieve. Choose out of ``tm``, ``pp``,
  // ``events``, ``commands`` or ``completeness``. By default all
  // indexes are sent.
  filters: string[];

  // Specify exact names for the TM packets for which you want to
  // retrieve index records. Setting this parameter, automatically
  // implies that ``tm`` is added to the filter.
  packetnames: string[];
}

Response Type

interface IndexResult {
  records: ArchiveRecord[];

  //type can be histogram or completeness
  type: string;

  //if type=histogram, the tableName is the table for which the histogram is sent
  tableName: string;
}

Related Types

//contains histogram data
interface ArchiveRecord {
  id: NamedObjectId;
  num: number;
  seqFirst: string;  // String decimal
  seqLast: string;  // String decimal
  first: string;  // RFC 3339
  last: string;  // RFC 3339
  extra: {[key: string]: string};
}

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