/  Yamcs HTTP API  /  Tag  /  Update Tag

Update TagΒΆ

Update a tag

Warning

This method is going to be removed. Use Yamcs Timeline instead by adding the service org.yamcs.timeline.TimelineService to your instance configuration.

URI Template

PATCH /api/archive/{instance}/tags/{tagTime}/{tagId}
{instance}

Yamcs instance name.

{tagTime}

{tagId}

Request Body

interface EditTagRequest {

  // The name of the tag.
  name: string;

  // The start time of the tag. Must be a date string in ISO 8601 format.
  start: string;

  // The stop time of the tag. Must be a date string in ISO 8601 format.
  stop: string;

  // The description of the tag.
  description: string;

  // The color of the tag. Must be an RGB hex color, e.g. ``#ff0000``.
  color: string;
}

Response Type

interface ArchiveTag {
  id: number;
  name: string;
  start: string;  // String decimal
  stop: string;  // String decimal
  description: string;
  color: string;
  startUTC: string;  // RFC 3339
  stopUTC: string;  // RFC 3339
}