EventFrame GetMultiple

Retrieve multiple event frames by web ids or paths.

Request

GET eventframes/multiple

URL Parameters

• webId

  The ID of an event frame. See WebID for more information. Multiple event frames may be specified with multiple instances of the parameter.

• path

  The path of an event frame. See Path Syntax for more information. Multiple event frames may be specified with multiple instances of the parameter.

• includeMode

  The include mode for the return list. See Include Mode for more information. The default is 'All'.

• asParallel

  Specifies if the retrieval processes should be run in parallel on the server. This may improve the response time for large amounts of requested attributes. The default is 'false'.

• 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 event frames

207: Some or all items contain exceptions.

Sample Response Body

{
  "Items": [
    {
      "Identifier": "\\\\server\\path",
      "IdentifierType": "Path",
      "Object": {
        "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"
        }
      },
      "Exception": null
    },
    {
      "Identifier": "\\\\server\\path",
      "IdentifierType": "Path",
      "Object": {
        "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"
        }
      },
      "Exception": null
    }
  ],
  "Links": {}
}