South Connectors

Test south connector item

Test a south connector item

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

Path parameters

southIdstring required

Query parameters

Type representing the possible types for a South connector.

itemNamestring required

Request body

Example request

{
  "itemSettings": {
    "dateTimeFields": [
      {
        "timezone": "Europe/Paris"
      }
    ],
    "serialization": {
      "outputTimezone": "Europe/Paris"
    }
  }
}

Response

Raw and (optionally) transformed test results

connectionDurationnumber double required

queryDurationnumber double required

Example response

{
  "raw": {
    "type": "time-values",
    "content": [
      {
        "pointId": "point1",
        "timestamp": "2023-10-31T12:34:56.789Z"
      }
    ]
  },
  "transformed": {
    "type": "time-values",
    "content": [
      {
        "pointId": "point1",
        "timestamp": "2023-10-31T12:34:56.789Z"
      }
    ]
  }
}

Changes

Changed in 37 of the 73 revisions of this API.969583

Aug 18, 202687fa588c6b1b2See the full diff
- ▲
  added the new required request property southSettings/anyOf[SouthFTPSettings]/retryInterval
  new-required-request-property
- ▲
  added the new required request property southSettings/anyOf[SouthSFTPSettings]/retryInterval
  new-required-request-property
Jul 29, 2026c6f1125cd74f2See the full diff
- ○
  added the required property connectionDuration to the response with the 200 status
  response-required-property-added
- ○
  added the required property queryDuration to the response with the 200 status
  response-required-property-added
Jul 28, 20269a6250881fa7210See the full diff
- ▲
  added the new required request property southSettings/anyOf[SouthOPCUASettings]/maxParallelRun
  new-required-request-property
- ▲
  the response's body type/format changed from / to object/ for status 200
  response-body-type-changed
- ○
  added the new optional request property southSettings/anyOf[SouthFolderScannerSettings]/domain
  new-optional-request-property
- ○
  added the new optional request property southSettings/anyOf[SouthFolderScannerSettings]/password
  new-optional-request-property
- ○
  added the new optional request property southSettings/anyOf[SouthFolderScannerSettings]/username
  new-optional-request-property
- ○
  added the new optional request property testingSettings/transformer
  new-optional-request-property
- ○
  added the new enum value influxdb to the query request parameter southType
  request-parameter-enum-value-added
- ○
  added SouthInfluxDBItemSettings to the itemSettings request property anyOf list
  request-property-any-of-added
- ○
  added SouthInfluxDBSettings to the southSettings request property anyOf list
  request-property-any-of-added
- ○
  removed OIBusTimeValueContent OIBusFileContent OIBusAnyContent OIBusSetpointContent from the response body anyOf list for the response status 200
  response-body-any-of-removed
- ○
  added the required property raw to the response with the 200 status
  response-required-property-added
- ○
  added the required property transformed to the response with the 200 status
  response-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 26, 2026ea1c80cb9c69641See the full diff
- ▲
  removed the enum value influxdb from the query request parameter southType
  request-parameter-enum-value-removed
- ▲
  removed SouthInfluxDBItemSettings from the itemSettings request property anyOf list
  request-property-any-of-removed
- ▲
  removed SouthInfluxDBSettings from the southSettings request property anyOf list
  request-property-any-of-removed
- ▲
  the response's body type/format changed from object/ to / for status 200
  response-body-type-changed
- ▲
  removed the required property raw from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property transformed from the response with the 200 status
  response-required-property-removed
- ●
  removed the request property southSettings/anyOf[SouthFolderScannerSettings]/domain
  request-property-removed
- ●
  removed the request property southSettings/anyOf[SouthFolderScannerSettings]/password
  request-property-removed
- ●
  removed the request property southSettings/anyOf[SouthFolderScannerSettings]/username
  request-property-removed
- ●
  removed the request property testingSettings/transformer
  request-property-removed
- ○
  added OIBusTimeValueContent OIBusFileContent OIBusAnyContent OIBusSetpointContent to the response body anyOf list for the response status 200
  response-body-any-of-added
This revision also has 29 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 20, 20266c492d4689a813See the full diff
- ▲
  the response's body type/format changed from / to object/ for status 200
  response-body-type-changed
- ○
  removed OIBusTimeValueContent OIBusFileContent OIBusAnyContent OIBusSetpointContent from the response body anyOf list for the response status 200
  response-body-any-of-removed
- ○
  added the required property raw to the response with the 200 status
  response-required-property-added
- ○
  added the required property transformed to the response with the 200 status
  response-required-property-added
Jul 20, 20266a232346b1587See the full diff
- ○
  added the new optional request property southSettings/anyOf[SouthFolderScannerSettings]/domain
  new-optional-request-property
- ○
  added the new optional request property southSettings/anyOf[SouthFolderScannerSettings]/password
  new-optional-request-property
- ○
  added the new optional request property southSettings/anyOf[SouthFolderScannerSettings]/username
  new-optional-request-property
- ○
  added the new optional request property testingSettings/transformer
  new-optional-request-property
- ○
  added the new enum value influxdb to the query request parameter southType
  request-parameter-enum-value-added
- ○
  added SouthInfluxDBItemSettings to the itemSettings request property anyOf list
  request-property-any-of-added
- ○
  added SouthInfluxDBSettings to the southSettings request property anyOf list
  request-property-any-of-added
Jul 15, 202657cbe043ec5a33See the full diff
- ▲
  removed the enum value influxdb from the query request parameter southType
  request-parameter-enum-value-removed
- ▲
  removed SouthInfluxDBItemSettings from the itemSettings request property anyOf list
  request-property-any-of-removed
- ▲
  removed SouthInfluxDBSettings from the southSettings request property anyOf list
  request-property-any-of-removed
- ●
  removed the request property southSettings/anyOf[SouthFolderScannerSettings]/domain
  request-property-removed
- ●
  removed the request property southSettings/anyOf[SouthFolderScannerSettings]/password
  request-property-removed
- ●
  removed the request property southSettings/anyOf[SouthFolderScannerSettings]/username
  request-property-removed
This revision also has 23 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 6, 20264c50d4a73f666See the full diff
- ○
  added the new optional request property southSettings/anyOf[SouthFolderScannerSettings]/domain
  new-optional-request-property
- ○
  added the new optional request property southSettings/anyOf[SouthFolderScannerSettings]/password
  new-optional-request-property
- ○
  added the new optional request property southSettings/anyOf[SouthFolderScannerSettings]/username
  new-optional-request-property
- ○
  added the new enum value influxdb to the query request parameter southType
  request-parameter-enum-value-added
- ○
  added SouthInfluxDBItemSettings to the itemSettings request property anyOf list
  request-property-any-of-added
- ○
  added SouthInfluxDBSettings to the southSettings request property anyOf list
  request-property-any-of-added
Jul 3, 2026a460443e789e3See the full diff
- ▲
  removed the enum value influxdb from the query request parameter southType
  request-parameter-enum-value-removed
- ▲
  removed SouthInfluxDBItemSettings from the itemSettings request property anyOf list
  request-property-any-of-removed
- ▲
  removed SouthInfluxDBSettings from the southSettings request property anyOf list
  request-property-any-of-removed
This revision also has 23 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 29, 2026ea736a81a9313See the full diff
- ○
  added the new enum value influxdb to the query request parameter southType
  request-parameter-enum-value-added
- ○
  added SouthInfluxDBItemSettings to the itemSettings request property anyOf list
  request-property-any-of-added
- ○
  added SouthInfluxDBSettings to the southSettings request property anyOf list
  request-property-any-of-added

Full history (37 revisions)