South Connectors

Map discovered records to new items

Changed on

Discovers what a scope holds (e.g. nodes picked in the Explore modal) against the south connector settings as currently edited, and maps every record to a new item, as a configuration workflow would. Nothing is saved.

post/api/south/{southId}/test/discovered-items

Request

  • Base URL: http://localhost:2223
  • URL: http://localhost:2223/api/south/{southId}/test/discovered-items
  • Auth: none required

Path parameters

southIdstring required

The south connector id, or "create" for a connector not created yet

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

discoveryScopeRecordStringUnknown required

Construct a type with a set of properties K of type T

itemFieldMappingRecordStringString required

Construct a type with a set of properties K of type T

Response

One item to create per discovered record

Example response

[
  {
    "enabled": true,
    "name": "Temperature Logs",
    "scanModeId": "periodic-5min",
    "groupId": "group-123",
    "groupName": "Production Line A",
    "syncWithGroup": true,
    "maxReadInterval": 3600,
    "readDelay": 200,
    "startTimeOffset": -1000,
    "threshold": 1,
    "rangeHigh": 100,
    "maxCachingInterval": 3600000
  }
]

Changes