Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Adapter for Structured Data Files

Data discovery REST URLs

  • Last UpdatedMar 21, 2025
  • 3 minute read

The following is a list of available REST (REpresentational State Transfer) URL (Uniform Resource Locator)s:

HTTP (Hypertext Transfer Protocol) verb

Relative URL (Uniform Resource Locator)

Action

GET

api/v1/configuration/<componentId>/discoveries

Returns status of all discoveries.

POST

api/v1/configuration/<componentId>/discoveries

Initiates a new discovery and returns its Id (Identification).

DELETE

api/v1/configuration/<componentId>/discoveries

Cancels and deletes all saved discoveries.

GET

api/v1/configuration/<componentId>/discoveries/<discoveryId>

Gets the status of an individual discovery.

Note: If a discovery with the specified Id (Identification) does not exist, you will get an error message.

DELETE

api/v1/configuration/<componentId>/discoveries/<discoveryId>

Cancels and deletes discovery and result.

GET

api/v1/configuration/<componentId>/discoveries/<discoveryId>/result

Returns the result of a discovery.

GET

api/v1/configuration/<componentId>/discoveries/<discoveryId>/result?diff=previousId

Returns the difference between the result and the previous result

GET

api/v1/configuration/<componentId>/dataselection?diff=<discoveryId>>

Returns the difference between the data selection configuration and the discovery results

DELETE

api/v1/configuration/<componentId>/discoveries/<discoveryId>/result

Cancels and deletes discovery result.

Note: The discovery Id (Identification) 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.

POST

api/v1/configuration/<componentId>/discoveries/<discoveryId>/cancel

Cancels the on-demand data source discovery.

POST

api/v1/configuration/<componentId>/dataselection/select?discoveryid=<discoveryId>

Adds the discovered items to data selection with selected set to true.

POST

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 Id (Identification) of your adapter component and replace <discoveryId> with the Id (Identification) of the discovery for which you want to perform the action.

TitleResults for “How to create a CRG?”Also Available in