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
- List Processor Types
- List Processors
- Get Processor
- Delete Processor
- Edit Processor
- Create Processor
- Get Parameter Value
- Set Parameter Value
- Batch Get Parameter Values
- Batch Set Parameter Values
- Subscribe TM Statistics
- Subscribe Parameters
- Subscribe Processors
- Get Algorithm Status
- Subscribe Algorithm Status
- Get Algorithm Trace
- Edit Algorithm Trace
- 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
Edit ProcessorΒΆ
Update a processor
URI Template
PATCH /api/processors/{instance}/{processor}
{instance}
Yamcs instance name
{processor}
Processor name
Request Body
// Request message for `EditProcessor`.
interface EditProcessorRequest {
// The state this replay processor should be updated to. Either ``paused`` or
// ``running``.
state: string;
// The time where the processing needs to jump towards. Must be a date string
// in ISO 8601 format.
seek: string; // RFC 3339 timestamp
// The speed of the processor. One of:
// * ``afap``
// * a speed factor relative to the original speed. Example: ``2x``
// * a fixed delay value in milliseconds. Example: ``2000``
speed: string;
// New start time
start: string; // RFC 3339 timestamp
// New stop time
stop: string; // RFC 3339 timestamp
// Continue replaying from ``start`` after having reached ``stop``.
loop: boolean;
}