Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Retrieve Pi Locations file containing all locations that are available for the passed 'filterId' argument. If not filterId is passed then all locations configured in the pre-defined filter will be returned. The geoDatum used in the response is determined by the geoDatum configured in the locations.xml.

 

Request parameters

  • filterId (string): Filter id.
  • documentVersion (string): File format version.
  • documentFormat (string): PI_XML (default) or PI_JSON
  • showAttributes (boolean) Since 2017.02: toggle to show location attributes.
  • includeLocationRelations (boolean) Since 2019.02: toggle to include locationRelations. Optional, default is false. For xml format avalable from version 1.26 or higher.
  • includeTimeDependency  (boolean) Since 2019.02: toggle to include timeDependency. Optional, default is false. For xml format avalable from version 1.26 or higher.

Response

  • Locations PI-XML or PI-JSON file content.

...