Update Tag Configuration API

You can use this API to update tag properties.

The Update Tag Configuration API allows you to set or modify any tag property values.

A Rename cannot be done using the Update Tag Configuration properties.

METHOD:PUT
URI:https://<historianservername>:8443/historian-rest-api/v1/tags/properties/tagName
SAMPLE DELETE URI: 
https://<historianservername>:8443/historian-rest-api/v1/tags/properties/tagName

Payload:
{
    "PropertyName" : "PropertyValue"
}
SAMPLE cURL COMMAND:curl -i -H "Accept: application/json" -i -H "Content-Type: application/json" -H "Authorization: Bearer <TOKEN> -d ?{ \ ?Description\ ?:\ ?SampleDesc\ ?} -X PUT https://<historianservername>:8443/historian-rest-api/v1/tags/properties/tagName

Query Parameters

ParameterDescriptionRequired?Values
tagNameTag name for which properties need to be set or modified.YesString
PayloadJSON array of PropertyName and PropertyValue.At least one property must be provided.Multidata types. See Payload Parameter for a list of tag properties used to update a tag configuration.

Response Parameters

ParameterData TypeRequired?Description
ErrorCodeIntegerYesFor example, 0.
ErrorMessageStringYesFor example, NULL.

Sample Payload

{
     "Description" : "Test desc".
     "CollectionOffset" : 4294967295 
     }

Sample Response

{
"ErrorCode": 0,
"ErrorMessage": null
}