/  Yamcs HTTP API  /  Timeline  /  Get View

Get ViewΒΆ

Get a view

URI Template

GET /api/timeline/{instance}/views/{id}
{instance}

Yamcs instance name

{id}

Item identifier

Response Type

interface TimelineView {

  // Yamcs instance name
  instance: string;

  // View identifier
  id: string;

  // View name
  name: string;

  // View description
  description: string;

  // array of bands
  bands: TimelineBand[];
}

Related Types

interface TimelineBand {

  // Yamcs instance name
  instance: string;

  // Band identifier
  id: string;

  // Band name
  name: string;

  //user who has created the band
  username: string;

  //if true, all users have access to this band, otherwise only the user who has created it
  shared: boolean;

  //the band contains only items from this source
  source: string;

  //the band contains only items with these tags; if the list is empty, then all items from the given source are part of the band
  tags: string[];

  // Type of band
  type: TimelineBandType;

  // Band description
  description: string;

  // Additional properties used by yamcs-web to render this band
  properties: {[key: string]: string};
}

enum TimelineBandType {
  TIME_RULER = "TIME_RULER",
  ITEM_BAND = "ITEM_BAND",
  SPACER = "SPACER",
  COMMAND_BAND = "COMMAND_BAND",
}