Yamcs HTTP API
- Activities
- Alarms
- Audit
- Buckets
- Clearance
- Commands
- COP-1
- Database
- Events
- File Transfer
- IAM
- Indexes
- Instances
- Links
- MDB Override
- MDB
- Packets
- Parameter Archive
- Parameter Lists
- Parameter Values
- Processing
- Queues
- Replication
- RocksDB
- Server
- Services
- Sessions
- Stream Archive
- Table
- Time Correlation
- Time
- Timeline
Related
Yamcs Server Manual
Yamcs Release Notes
Source Code Documentation
Download this Document
Get StreamΒΆ
Get a stream
URI Template
GET /api/archive/{instance}/streams/{name}
{instance}
Yamcs instance name
{name}
Stream name
Response Type
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[];
}
Related Types
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;
}