Add Band¶

interface AddBandRequest {

  // Band name
  name: 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;

  // Items containing these tags will be part of the timeline
  // this is deprecated, the filters below should be used instead
  tags: string[];

  // A query filter which can be used to limit additionally the items which are part of the band
  filters: ItemFilter[];

  // Type of band
  type: TimelineBandType;

  // Band description
  description: string;

  // Additional properties used by yamcs-web to render this band
  properties: {[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, then all items from the given source are part of the band
  //this is deprecated, the filters below should be used to select the items
  tags: string[];

  // The filters are to be considered in an AND manner.
  // An item is part of the band if it matches all filters.
  // If the list is empty, then all items from the given source are part of the band
  filters: ItemFilter[];

  // Type of band
  type: TimelineBandType;

  // Band description
  description: string;

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

// An item matches the filter if it matches any of the criteria from the list.
// If the list is empty, the filter will not match.
interface ItemFilter {
  criteria: FilterCriterion[];
}

// Available filter criteria depend on the item's source.
//
// When the source is rdb:
//
// tag
//   An item matches if the value property is among its tags.
//
// When the source is commands:
//
// cmdNamePattern:
//   value is considered as a regexp and matched against the ``cmdName``
//   column from the ``cmdhist`` table.
interface FilterCriterion {
  key: string;
  value: string;
}

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