EventFrame GetReferencedElements

Retrieve the event frame's referenced elements.

Request

GET eventframes/{webId}/referencedelements

URL Parameters

• webId

  The ID of the event frame whose referenced elements should be retrieved. See WebID 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.

• associations

  Associated values to return in the response, separated by semicolons (;). This call supports Paths to return all paths to the element. If this parameter is not specified, paths are not returned. See Associations for more information.

Status Codes

200: A list of referenced elements.

Sample Response Body

{
  "Items": [
    {
      "WebId": "I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA",
      "Id": "cbb28260-853d-11e4-80c5-00155d844304",
      "Name": "MachineName",
      "Description": "Manufacturing Equipment MachineName",
      "Path": "\\\\MyAssetServer\\MyDatabase\\CityName\\EngineeringProcess\\Equipment\\MachineName",
      "Paths": null,
      "TemplateName": "MachineName",
      "HasChildren": false,
      "CategoryNames": [
        "Equipment Assets"
      ],
      "ExtendedProperties": {},
      "Errors": null,
      "Links": {
        "Self": "https://localhost.osisoft.int/piwebapi/elements/I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA"
      }
    },
    {
      "WebId": "I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA",
      "Id": "cbb28260-853d-11e4-80c5-00155d844304",
      "Name": "MachineName",
      "Description": "Manufacturing Equipment MachineName",
      "Path": "\\\\MyAssetServer\\MyDatabase\\CityName\\EngineeringProcess\\Equipment\\MachineName",
      "Paths": null,
      "TemplateName": "MachineName",
      "HasChildren": false,
      "CategoryNames": [
        "Equipment Assets"
      ],
      "ExtendedProperties": {},
      "Errors": null,
      "Links": {
        "Self": "https://localhost.osisoft.int/piwebapi/elements/I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA"
      }
    }
  ],
  "Links": {}
}