Docs / Yamcs HTTP API / Tags / Edit Tag

Edit Tag

Edit a tag:

PATCH /api/archive/:instance/tags/:start/:id

Parameters

Name Type Description
name string The name of the tag.
description string The description of the tag.
start string The start time of the tag. Must be a date string in ISO 8601 format. Set to empty to indicate unbounded.
stop string The stop time of the tag. Must be a date string in ISO 8601 format. Set to empty to indicate unbounded.
color string The color of the tag. Must be an RGB hex color, e.g. #ff0000

The same parameters can also be specified in the request body. In case both query string parameters and body parameters are specified, they are merged with priority being given to query string parameters.

Example

Change the color, and the description:

{
  "color" : "#00ff00",
  "description": "a sample description"
}

Alternative Media Types

Protobuf

Use these HTTP headers:

Content-Type: application/protobuf
Accept: application/protobuf

Request is of type:

rest/rest.proto 
message EditTagRequest {
  optional string name = 1;
  optional string start = 2;
  optional string stop = 3;
  optional string description = 4;
  optional string color = 5;
}