EventFrame GetEventFramesQuery

Retrieve event frames based on the specified conditions. Returns event frames using the specified search query string.

Request

GET eventframes/search

URL Parameters

• databaseWebId

  The ID of the asset database to use as the root of the query. See WebID for more information.

• query

  The query string is a list of filters used to perform an AFSearch for the eventframes in the asset database. An example would be: "query=Name:=MyEventFrame* Category:=MyCategory Template:=EFTemplate". See Search Query Syntax for more information.See URL Encoding 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": {}
}