Sign in
South Connectors

Test a discovery query

Test a Configuration Workflow discovery query as currently typed, against an ephemeral or the live connector (mirrors testItem), and return its raw rows

post/api/south/{southId}/test/discovery-query

Path parameters

southIdstring required

Query parameters

southType'opcua' | 'mqtt' | 'modbus' | 'oianalytics' | 'ads' | 'bacnet' | 'folder-scanner' | 'ftp' | 'influxdb' | 'mongodb' | 'mssql' | 'mysql' | 'odbc' | 'oledb' | 'opc' | 'oracle' | 'osisoft-pi' | 'postgresql' | 'rest' | 's7' | 'sftp' | 'sqlite' required

Type representing the possible types for a South connector.

Request body

querystring required

The dedicated metadata query to run, as currently typed (before the workflow is saved)

Response

The rows returned by the query

OIBusRecord[] required

Changes

Changed in 7 of the 241 revisions of this API.34