EventFrame GetByPath

Retrieve an event frame by path.

Remarks

This method returns an event frame based on the hierarchical path associated with it, and should be used when a path has been received from a separate part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available.

Request

GET eventframes

URL Parameters

• path

  The path to the event frame. See Path Syntax for more information.

• 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 specified event frame.

Sample Response Body

{
  "WebId": "I1FmDqD5loBNH0erqeqJodtALADqD5loBNH0cAAAAAAASwAg",
  "Id": "96f9a00e-4d80-471f-0000-00000004b002",
  "Name": "EF20140725-001",
  "Description": "Event Frame of Past Week",
  "Path": "\\\\MyAssetServer\\MyDatabase\\EventFrames[EF20140725-001]",
  "TemplateName": "Template",
  "HasChildren": false,
  "CategoryNames": [
    "Processing Plant"
  ],
  "ExtendedProperties": {},
  "StartTime": "2014-07-18T14:45:29Z",
  "EndTime": "2014-07-25T14:45:29Z",
  "Severity": "None",
  "AcknowledgedBy": "MyDomain\\UserA",
  "AcknowledgedDate": "2014-07-30T11:04:23Z",
  "CanBeAcknowledged": true,
  "IsAcknowledged": true,
  "IsAnnotated": false,
  "IsLocked": false,
  "AreValuesCaptured": false,
  "RefElementWebIds": [
    "I1EmDqD5loBNH0erqeqJodtALAaqQoQHk26BGgMQAVXYR0Ag"
  ],
  "Security": {
    "CanAnnotate": true,
    "CanDelete": true,
    "CanExecute": true,
    "CanRead": true,
    "CanReadData": true,
    "CanSubscribe": true,
    "CanSubscribeOthers": true,
    "CanWrite": true,
    "CanWriteData": true,
    "HasAdmin": true,
    "Rights": [
      "Read",
      "WriteData"
    ]
  },
  "Links": {
    "Self": "https://localhost.osisoft.int/piwebapi/eventframes/I1FmDqD5loBNH0erqeqJodtALADqD5loBNH0cAAAAAAASwAg"
  }
}