List Commands¶

List commands

URI Template

GET /api/archive/{instance}/commands

{instance}: Yamcs instance name.

Query Parameters

pos: The zero-based row number at which to start outputting results. Default: 0

This option is deprecated and will be removed in a later version. Use the returned continuationToken instead.
limit: The maximum number of returned records per page. Choose this value too high and you risk hitting the maximum response size limit enforced by the server. Default: 100
order: The order of the returned results. Can be either asc or desc. Default: desc
q: Text to search in the name of the command. This searches both the qualified name, and any aliases.
next: Continuation token returned by a previous page response.
start: Filter the lower bound of the command's generation time. Specify a date string in ISO 8601 format. This bound is inclusive.
stop: Filter the upper bound of the command's generation time. Specify a date string in ISO 8601 format. This bound is exclusive.
queue: Filter the results by the used queue.

Response Type

interface ListCommandsResponse {
  entry: CommandHistoryEntry[];

  // Token indicating the response is only partial. More results can then
  // be obtained by performing the same request (including all original
  // query parameters) and setting the ``next`` parameter to this token.
  continuationToken: string;
}

Related Types

interface CommandHistoryEntry {
  id: string;

  // Qualified name
  commandName: string;

  // Name aliases keyed by namespace.
  // (as currently present in Mission Database)
  aliases: {[key: string]: string};
  origin: string;
  sequenceNumber: number;
  commandId: CommandId;
  attr: CommandHistoryAttribute[];
  generationTime: string;  // RFC 3339 timestamp
  assignments: CommandAssignment[];
}

interface CommandId {
  generationTime: string;  // String decimal
  origin: string;
  sequenceNumber: number;
  commandName: string;
}

interface CommandHistoryAttribute {
  name: string;
  value: Value;
  time: string;  // String decimal
}

// Union type for storing a value
interface Value {
  type: Type;
  floatValue: number;
  doubleValue: number;
  sint32Value: number;
  uint32Value: number;
  binaryValue: string;  // Base64
  stringValue: string;
  timestampValue: string;  // String decimal
  uint64Value: string;  // String decimal
  sint64Value: string;  // String decimal
  booleanValue: boolean;
  aggregateValue: AggregateValue;
  arrayValue: Value[];
}

// An aggregate value is an ordered list of (member name, member value).
// Two arrays are used in order to be able to send just the values (since
// the names will not change)
interface AggregateValue {
  name: string[];
  value: Value[];
}

interface CommandAssignment {
  name: string;
  value: Value;
  userInput: boolean;
}

enum Type {
  FLOAT = "FLOAT",
  DOUBLE = "DOUBLE",
  UINT32 = "UINT32",
  SINT32 = "SINT32",
  BINARY = "BINARY",
  STRING = "STRING",
  TIMESTAMP = "TIMESTAMP",
  UINT64 = "UINT64",
  SINT64 = "SINT64",
  BOOLEAN = "BOOLEAN",
  AGGREGATE = "AGGREGATE",
  ARRAY = "ARRAY",

  // Enumerated values have both an integer (sint64Value) and a string representation
  ENUMERATED = "ENUMERATED",
  NONE = "NONE",
}