The Add Tag Comment API

Using the Add Tag Comment API, you can add a comment to a tag.
METHOD POST
URI
https://<historianservername>/historian-rest-api/v1/tags/addcomment
SAMPLE URI
https://<historianservername>/historian-rest-api/v1/tags/addcomment

Payload
{
  "tagName":"rsserver2012-02.Simulation00003",
  "comment":"Retest",
  "timeStamp":"2020-04-22T00:00:00.000Z"
}
SAMPLE RESPONSE
{
               "ErrorCode": 0,
               "ErrorMessage": null,
               "Data": ""
              }
SAMPLE cURL COMMAND
curl -i -H "Accept: application/json" -i -H "Content-Type: application/json" -H "Authorization: Bearer <TOKEN> -d  ?{ \ ?tagName\ ?:\ rsserver2012-02.Simulation00003\ ?,\"comment\":\"Test10\",\"timeStamp\": \ ?2020-04-22T00:00:00.000Z \ ?} -X POST https://<historianservername>:8443/historian-rest-api/v1/tags/addcomment

Query Parameters

Query parameters include the Payload parameter, which is a JSON file, which contains the following properties.

Parameter Description Required? Values
tagName The name of the tag. Yes String
timestamp The timestamp of the comment. Yes String
comment The comment. Yes String

Response Parameters

Parameter Data Type Required? Description
ErrorCode Integer Yes For example, ErrorCode = 0 implies the operation was successful.
ErrorMessage String Yes For example, NULL.