EventFrame CreateAnnotation
- Last UpdatedJun 15, 2023
- 1 minute read
- PI System
- PI Web API Reference
- Developer
EventFrame CreateAnnotation
Create an annotation on an event frame.
Request
POST eventframes/{webId}/annotations
URL Parameters
-
webId The ID of the owner event frame on which to create the annotation. See WebID for more information.
-
webIdType Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType". See WebID Type for more information.
Body Parameter
The new annotation definition.
Status Codes
201: The annotation was created. The response's Location header is a link to the annotation.
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."
}