Docs / Yamcs HTTP API / Tables / List Tables

List Tables

List all tables for the given instance:

GET /api/archive/:instance/tables

This is low-level API for those cases where access to the internal key/value tables of Yamcs is wanted. It is recommended to use other API operations for any of the default built-in tables.

Example

Status: 200 OK
{
  "table" : [ {
    "name" : "tm",
    "keyColumn" : [ {
      "name" : "gentime",
      "type" : "TIMESTAMP"
    }, {
      "name" : "seqNum",
      "type" : "INT"
    } ],
    "valueColumn" : [ {
      "name" : "rectime",
      "type" : "TIMESTAMP"
    }, {
      "name" : "packet",
      "type" : "BINARY"
    }, {
      "name" : "pname",
      "type" : "ENUM"
    } ]
  } ]
}

Note that this will only list the fixed columns of the table. Tuples may always add extra value columns.

Alternative Media Types

Protobuf

Use HTTP header:

Accept: application/protobuf

Response is of type:

rest/rest.proto 
message ListTablesResponse {
  repeated archive.TableInfo table = 1;
}