Configure data discovery
- Last UpdatedJul 09, 2025
- 2 minute read
- PI System
- Adapter for OPC UA 1.6
- Adapters
You can perform a data discovery for existing data items on demand. Data discovery is initiated through REST calls and it is tied to a specific discovery Id, which you can either specify or let the adapter generate it.
There are several actions you can take around data items or event types using discovery, such as:
-
Retrieve the discovery results
-
Query the discovery status
-
Cancel or delete discoveries
-
Merge discovery results with the data selection configuration
-
Retrieve results from a current discovery and compare it with results from a previous or discovery
-
Retrieve results from a current discovery and compare it with results from a current data selection configuration
Postman
To configure discovery using Postman:
-
Start any of the Configuration tools capable of making HTTP requests.
-
Run a POST command with the Id of the discovery and autoSelect set to either true or false to the following endpoint: http://localhost:5590/api/v1/configuration/<ComponentId>/Discoveries.
Note: Including an Id is optional. If you do not include one, the adapter automatically generates one. Additionally, 5590 is the default port number. If you selected a different port number, replace it with that value.
Example using Postman:
POST http://localhost:5590/api/v1/configuration/<ComponentId>/Discoveries
{
"Id": "TestDiscovery",
"autoSelect": true
}
EdgeCmd
To configure discovery using EdgeCmd:
-
Using a text editor, create an empty text file.
-
Copy and paste an example configuration for data discovery into the file.
-
Update the example JSON parameters for your environment.
For sample JSONs, see the Examples section.
-
Save the file. For example, ConfigureDiscoveries.json.
-
Open a command line session. Change directory to the location of your saved file.
-
Use the following edgecmd command with the name of your JSON file. For this example, we will use AddDiscoveries.json for the saved file.
edgecmd -port <port number> -cid <componentId> add Discoveries -file /.AddDiscoveries.json
For a list of other REST operations you can perform, like updating or deleting a data source configuration, see the REST URLs section below.