South Connectors

Update south connector

Changed on

Updates an existing south connector configuration

put/api/south/{southId}

Request

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

Path parameters

southIdstring required

Request body

namestring required

The name of the South connector.

type'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.

descriptionstring required

Description of the South connector's purpose.

enabledboolean required

Whether the South connector should be enabled.

settingsobject required

Configuration settings specific to this South connector type.

Example request

{
  "name": "Production Data Files",
  "description": "Scans production data CSV files",
  "enabled": true,
  "items": [
    {
      "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
    }
  ],
  "groups": [
    {
      "standardSettings": {
        "scanModeId": "periodic-5min",
        "name": "Production Line A"
      },
      "historySettings": {
        "readDelay": 200,
        "maxReadInterval": 3600,
        "startTimeOffset": -1000
      }
    }
  ],
  "configurationWorkflows": [
    {
      "identityKeyFields": [
        "nodeId"
      ],
      "eligibilityFilter": [
        {
          "field": "type",
          "operator": "equals",
          "value": "Variable"
        }
      ]
    }
  ]
}

Response

No Content

Changes

  • 0df3f625a5c2Revision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property ///

    • breaking

      added the new required request property //

    • breaking

      added the new required request property //

    • breaking

      added the new required request property //

    • breaking

      added the new required request property //

    • breaking

      added the new required request property //

    • breaking

      added the new required request property //

    • info

      added the new bacnet enum value to the request property

    • info

      added the new mongodb enum value to the request property

    • info

      added the new s7 enum value to the request property

  • 21b34a490fa3Revision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      removed from the request body anyOf list

    • breaking

      the request's body type changed from no type to object