Sign in
South Connectors

Preview a configuration workflow before saving it

Dry-runs a configuration workflow as currently edited (possibly never saved) against the south connector settings as currently edited: identical discovery and classification as a real run, but nothing is written. Used from the south connector edit page, where workflows can be previewed but not run.

post/api/south/{southId}/test/workflow-preview

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

workflowIdstring nullable required

The saved workflow being edited, to classify entries against its previous run - null for a workflow not saved yet

Example request

{
  "workflow": {
    "identityKeyFields": [
      "nodeId"
    ],
    "eligibilityFilter": [
      {
        "field": "type",
        "operator": "equals",
        "value": "Variable"
      }
    ]
  }
}

Response

What a run would find and how it would classify it

discoveredCountnumber double required
eligibleCountnumber double required
recordsOIBusRecord[] required

Remote (push-to-OIAnalytics) workflow only - the raw eligible records that would be sent, exactly as discovered, with no mapping or diffing applied. Empty for a local workflow.

Example response

{
  "entries": [
    {
      "status": "new"
    }
  ]
}

Changes

Changed in 3 of the 320 revisions of this API.12