EventFrame GetEventFrames

Retrieve event frames based on the specified conditions. By default, returns all children of the specified root event frame that have been active in the past 8 hours.

Request

GET eventframes/{webId}/eventframes

URL Parameters

• webId

  The ID of the event frame to use as the root of the search. See WebID for more information.

• searchMode

  Determines how the startTime and endTime parameters are treated when searching for event frame objects to be included in the returned collection. If this parameter is one of the 'Backward*' or 'Forward*' values, none of endTime, sortField, or sortOrder may be specified. The default is 'Overlapped'. See Search Mode for more information.

• startTime

  The starting time for the search. startTime must be less than or equal to the endTime. The searchMode parameter will control whether the comparison will be performed against the event frame's startTime or endTime. The default is '*-8h'. See Time Strings for more information.

• endTime

  The ending time for the search. The endTime must be greater than or equal to the startTime. The searchMode parameter will control whether the comparison will be performed against the event frame's startTime or endTime. The default is '*' if searchMode is not one of the 'Backward*' or 'Forward*' values. See Time Strings for more information.

• nameFilter

  The name query string used for finding event frames. The default is no filter. See Query String for more information.

• referencedElementNameFilter

  The name query string which must match the name of a referenced element. The default is no filter. See Query String for more information.

• categoryName

  Specify that returned event frames must have this category. The default is no category filter.

• templateName

  Specify that returned event frames must have this template or a template derived from this template. The default is no template filter. Specify this parameter by name.

• referencedElementTemplateName

  Specify that returned event frames must have an element in the event frame's referenced elements collection that derives from the template. Specify this parameter by name.

• severity

  Specify that returned event frames must have this severity. Multiple severity values may be specified with multiple instances of the parameter. The default is no severity filter. See Severity for more information.

• canBeAcknowledged

  Specify the returned event frames' canBeAcknowledged property. The default is no canBeAcknowledged filter.

• isAcknowledged

  Specify the returned event frames' isAcknowledged property. The default no isAcknowledged filter.

• searchFullHierarchy

  Specifies whether the search should include objects nested further than the immediate children of the search root. The default is 'false'.

• sortField

  The field or property of the object used to sort the returned collection. The default is 'Name' if searchMode is not one of the 'Backward*' or 'Forward*' values. See Sort Field for more information.

• sortOrder

  The order that the returned collection is sorted. The default is 'Ascending' if searchMode is not one of the 'Backward*' or 'Forward*' values. See Sort Order for more information.

• startIndex

  The starting index (zero based) of the items to be returned. The default is 0.

• maxCount

  The maximum number of objects to be returned per call (page size). The default is 1000.

• 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: A list of event frames matching the specified conditions.

Sample Response Body

{
  "Items": [
    {
      "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"
      }
    },
    {
      "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"
      }
    }
  ],
  "Links": {}
}