EventFrame GetAnnotationById
- Last UpdatedJun 15, 2023
- 1 minute read
- PI System
- PI Web API Reference
- Developer
EventFrame GetAnnotationById
Get a specific annotation on an event frame.
Request
GET eventframes/{webId}/annotations/{id}
URL Parameters
-
webId The ID of the owner event frame. See WebID for more information.
-
id The Annotation identifier of the specific annotation.
-
selectedFields List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned. See Selected Fields 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.
Status Codes
200: The requested annotation.
Sample Response Body
{
"Links": {},
"Id": "512B6616-CE39-4F70-9048-8C6A025FB592",
"Name": "Temperature Annotation",
"Description": "Signifies a spike in temperature.",
"Value": "The temperature spiked because of a malfunction with a unit in our west plant.",
"Creator": "MyDomain\\UserA",
"CreationDate": "2016-06-21T14:45:50.2988321Z",
"Modifier": "MyDomain\\UserA",
"ModifyDate": "2016-06-21T14:45:50.2988321Z",
"Errors": null
}