List Streams¶

List streams

Note that this will only list the fixed columns of the stream. Tuples may always have extra columns.

URI Template

GET /api/archive/{instance}/streams

{instance}: Yamcs instance name.

Response Type

interface ListStreamsResponse {
  streams: StreamInfo[];
}

Related Types

interface StreamInfo {

  // Stream name
  name: string;
  column: ColumnInfo[];
  columns: ColumnInfo[];
  script: string;
  dataCount: string;  // String decimal

  // Subscribers represented in the format ``className@hashCode``.
  subscribers: string[];
}

interface ColumnInfo {

  // Colum name
  name: string;

  // Column type
  type: string;
  enumValue: EnumValue[];

  // Attribute indicating automatic auto increment upon
  // record insertion. Only set for table column info.
  autoIncrement: boolean;
}

interface EnumValue {
  value: number;
  label: string;
}