Yamcs HTTP API
Methods
- 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
Stream Parameter IndexΒΆ
Streams back parameter index records
Warning
This method uses server-streaming. Yamcs sends an unspecified amount of data using chunked transfer encoding.
URI Template
POST /api/archive/{instance}:streamParameterIndex
{instance}
Yamcs instance name
Request Body
interface StreamParameterIndexRequest {
// The time at which to start retrieving index records.
start: string; // RFC 3339 timestamp
// The time at which to stop retrieving index records.
stop: string; // RFC 3339 timestamp
// Value in milliseconds that indicates the maximum gap before two consecutive index
// ranges are merged together.
mergeTime: number;
}
Response Type
//contains histogram data
interface ArchiveRecord {
id: NamedObjectId;
num: number;
seqFirst: string; // String decimal
seqLast: string; // String decimal
first: string; // RFC 3339 timestamp
last: string; // RFC 3339 timestamp
extra: {[key: string]: string};
}
Related Types
// 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;
}