Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

PI Web API Reference

EventFrame CreateEventFrame

EventFrame CreateEventFrame

Create an event frame as a child of the specified event frame.

Request

POST eventframes/{webId}/eventframes

URL Parameters

  • webId

    The ID of the parent event frame on which to create the event frame. 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 event frame definition.

Status Codes

201: The event frame was created. The response's Location header is a link to the event frame.

Sample Request Body

{
  "Name": "EF20140725-001",
  "Description": "Event Frame of Past Week",
  "TemplateName": "Template",
  "CategoryNames": [
    "Processing Plant"
  ],
  "ExtendedProperties": {},
  "StartTime": "2014-07-18T14:45:29Z",
  "EndTime": "2014-07-25T14:45:29Z",
  "Severity": "None",
  "CanBeAcknowledged": true,
  "RefElementWebIds": [
    "I1EmDqD5loBNH0erqeqJodtALAaqQoQHk26BGgMQAVXYR0Ag"
  ]
}
In This Topic
TitleResults for “How to create a CRG?”Also Available in