Docs / Yamcs HTTP API / Mission Database / List Command Info

List Command Info

List all commands defined in the Mission Database for the given Yamcs instance:

GET /api/mdb/:instance/commands

Parameters

Name Type Description
namespace string Include commands under the specified namespace only
recurse bool If a namespace is given, specifies whether to list commands of any nested sub systems. Default no.
q string The search keywords.

The q parameter supports searching on namespace or name. For example:

/api/mdb/simulator/commands?q=volt+on

Response

Status: 200 OK
{
  "command" : [ {
    "name": "SWITCH_VOLTAGE_ON",
    "qualifiedName" : "/YSS/SIMULATOR/SWITCH_VOLTAGE_ON",
    "alias" : [ {
      "name" : "SIMULATOR_SWITCH_VOLTAGE_ON",
      "namespace" : "MDB:OPS Name"
    }, {
      "name" : "SWITCH_VOLTAGE_ON",
      "namespace" : "/YSS/SIMULATOR"
    } ],
    "baseCommand" : {
      "name": "SIM_TC",
      "qualifiedName" : "/YSS/SIMULATOR/SIM_TC"
    },
    "abstract" : false,
    "argument" : [ {
      "name" : "voltage_num",
      "description" : "voltage number to switch on",
      "type" : "integer",
      "unitSet" : [ {
        "unit" : "V"
      } ]
    } ],
    "argumentAssignment" : [ {
      "name" : "packet-id",
      "value" : "1"
    } ]
  } ]
}

Alternative Media Types

Protobuf

Use HTTP header:

Accept: application/protobuf

Response is of type:

rest/rest.proto 
message ListCommandInfoResponse {
  repeated mdb.CommandInfo command = 1;
}