/  Yamcs HTTP API  /  Timeline  /  Update Band

Update BandΒΆ

Update a band

URI Template

PUT /api/timeline/{instance}/bands/{id}
{instance}

Yamcs instance name

{id}

Band identifier

Request Body

interface UpdateBandRequest {

  // Band name
  name: string;

  // Band description
  description: string;

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

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

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

Response Type

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};
}

Related Types

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