EventFrame UpdateAnnotation
- Last UpdatedJun 15, 2023
- 1 minute read
- PI System
- PI Web API Reference
- Developer
EventFrame UpdateAnnotation
Update an annotation on an event frame by replacing items in its definition.
Request
PATCH eventframes/{webId}/annotations/{id}
URL Parameters
-
webId The ID of the owner event frame of the annotation to update. See WebID for more information.
-
id The Annotation identifier of the annotation to be updated.
Body Parameter
A partial annotation containing the desired changes.
Status Codes
204: The annotation was updated.
Sample Request Body
{
"Name": "Temperature Annotation",
"Description": "Signifies a spike in temperature.",
"Value": "The temperature spiked because of a malfunction with a unit in our west plant."
}