/  Yamcs HTTP API  /  Tag  /  Create Tag

Create TagΒΆ

Create 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

POST /api/archive/{instance}/tags
{instance}

Yamcs instance name.

Request Body

interface CreateTagRequest {

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

  // The start time of the tag. Default is unbounded.
  start: string;

  // The stop time of the tag. Default is unbounded.
  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
}