GetElements
GET elements/{webId}/elements

Retrieve elements based on the specified conditions. By default, this method selects immediate children of the specified element.

Remarks

Users can search for the elements based on specific search parameters. If no parameters are specified in the search, the default values for each parameter will be used and will return the elements that match the default search.

URL Parameters

Status Codes

200: A list of elements matching the specified conditions.

Sample Response

{
  "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": {}
}
Enabling Operational Intelligence