Data discovery REST URLs
- Last UpdatedNov 10, 2025
- 3 minute read
- PI System
- Adapter for RDBMS 1.1
- Adapters
The following is a list of available REST URLs:
|
HTTP verb |
Relative URL |
Action |
|---|---|---|
|
|
api/v1/configuration/<componentId>/discoveries |
Returns status of all discoveries. |
|
|
api/v1/configuration/<componentId>/discoveries |
Initiates a new discovery and returns its Id. |
|
|
api/v1/configuration/<componentId>/discoveries |
Cancels and deletes all saved discoveries. |
|
|
api/v1/configuration/<componentId>/discoveries/<discoveryId> |
Gets the status of an individual discovery. Note: If a discovery with the specified Id does not exist, you will get an error message. |
|
|
api/v1/configuration/<componentId>/discoveries/<discoveryId> |
Cancels and deletes discovery and result. |
|
|
api/v1/configuration/<componentId>/discoveries/<discoveryId>/result |
Returns the result of a discovery. |
|
|
api/v1/configuration/<componentId>/discoveries/<discoveryId>/result?diff=previousId |
Returns the difference between the result and the previous result |
|
|
api/v1/configuration/<componentId>/dataselection?diff=<discoveryId>> |
Returns the difference between the data selection configuration and the discovery results |
|
|
api/v1/configuration/<componentId>/discoveries/<discoveryId>/result |
Cancels and deletes discovery result. Note: The discovery Id is still valid, but a query will contain a status of canceled.Only the Status property will contain a canceled status, but not the query. |
|
|
api/v1/configuration/<componentId>/discoveries/<discoveryId>/cancel |
Cancels the on-demand data source discovery. |
|
|
api/v1/configuration/<componentId>/dataselection/select?discoveryid=<discoveryId> |
Adds the discovered items to data selection with selected set to true. |
|
|
api/v1/configuration/<componentId>/dataselection/unselect?discoveryid=<discoveryId> |
Adds the discovered items to data selection with selected set to false. |
Note: Replace <componentId> with the of your adapter component and replace <discoveryId> with the Id of the discovery for which you want to perform the action.


