Save Band¶

interface SaveBandRequest {

  // Optional band identifier.
  //
  // If not set, an ID will be assigned by the server.
  //
  // If set, it should be a valid UUID.
  id: string;

  // Band name
  name: string;

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

  // Where the items shown on this band come from
  source: string;

  // Items containing these tags will be part of the timeline
  tags: string[];

  // If specified, the band shows only items matching this filter
  filter: string;

  // Type of band
  type: TimelineBandType;

  // Band description
  description: string;

  // Additional properties used by the Yamcs Web UI for rendering purposes.
  properties: {[key: string]: string};

  // Mission-specific custom data. Unlike `properties`, this field is ignored
  // by the Yamcs Web UI.
  extra: {[key: string]: string};
}

interface TimelineBand {

  // Yamcs instance name
  instance: string;

  // Band identifier (UUID)
  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,
  // all items from the given source are part of the band.
  tags: string[];

  // If specified, the band shows only items matching this filter
  filter: string;

  // Type of band
  type: TimelineBandType;

  // Detailed description of this band
  description: string;

  // Additional properties used by the Yamcs Web UI for rendering purposes.
  properties: {[key: string]: string};

  // Mission-specific custom data. Unlike `properties`, this field is ignored
  // by the Yamcs Web UI.
  extra: {[key: string]: string};
}

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