--- title: "Update south connector" method: PUT path: "/api/south/{southId}" tags: ["South Connectors"] --- # Update south connector `PUT /api/south/{southId}` Updates an existing south connector configuration ## Path parameters - `southId` string, required ## Request body - union — Command Data Transfer Object for creating or updating a South connector. Used as the request body for South connector creation/update endpoints. - SouthConnectorADSCommandDTO — South connector command for Beckhoff ADS. - `name` string, required — The name of the South connector. - `type` 'ads', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthADSSettings, required - `netId` string, required - `port` number, double, required - `routerAddress` string, nullable, required - `routerTcpPort` number, double, nullable, required - `clientAmsNetId` string, nullable, required - `clientAdsPort` number, double, nullable, required - `retryInterval` number, double, required - `plcName` string, nullable, required - `enumAsText` 'text' | 'integer', required - `boolAsText` 'text' | 'integer', required - `structureFiltering` SouthADSSettingsStructureFiltering[], nullable, required - `name` string, required - `fields` string, required - `items` SouthConnectorADSItemCommandDTO[], required — List of items (data points) to configure for this connector. - `id` string, nullable, required — The ID of the item (null when creating a new item). - `enabled` boolean, required — Whether this item should be enabled. - `name` string, required — The name of the item. - `settings` SouthADSItemSettings, required - `address` string, required - `scanModeId` string, nullable, required — The ID of the scan mode to use for this item. Null when the scan mode should be determined by the system. - `scanModeName` string, nullable, required — The name of the scan mode to use when ID is not available. Null when not specifying by name. - `groupId` string, nullable, required — The ID of the group this item belongs to. Null when the item is not in any group. - `groupName` string, nullable, required — The name of the group this item belongs to. Used when importing from CSV where group IDs are not available. Null when the item is not in any group. - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields are inherited from the group. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. If the resulting end time is not after the effective start time, the query is skipped. - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - `id` string, nullable, required — The ID of the group (null when creating a new group). - `standardSettings` object, required - `scanModeId` string, required — The ID of the scan mode to use for this group. - `name` string, required — The name of the group. - `historySettings` object, required - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. If the resulting end time is not after the effective start time, the query is skipped. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Negative values extend the window backwards (equivalent to the old overlap behaviour). - SouthConnectorFolderScannerCommandDTO — South connector command for the Folder Scanner. - `name` string, required — The name of the South connector. - `type` 'folder-scanner', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthFolderScannerSettings, required - `inputFolder` string, required - `compression` boolean, required - `username` string, nullable - `password` string, nullable - `domain` string, nullable - `items` SouthConnectorFolderScannerItemCommandDTO[], required — List of items (data points) to configure for this connector. - `id` string, nullable, required — The ID of the item (null when creating a new item). - `enabled` boolean, required — Whether this item should be enabled. - `name` string, required — The name of the item. - `settings` SouthFolderScannerItemSettings, required - `regex` string, required - `minAge` number, double, required - `preserveFiles` boolean, required - `ignoreModifiedDate` boolean - `maxFiles` number, double, required - `maxSize` number, double, required - `recursive` boolean, required - `scanModeId` string, nullable, required — The ID of the scan mode to use for this item. Null when the scan mode should be determined by the system. - `scanModeName` string, nullable, required — The name of the scan mode to use when ID is not available. Null when not specifying by name. - `groupId` string, nullable, required — The ID of the group this item belongs to. Null when the item is not in any group. - `groupName` string, nullable, required — The name of the group this item belongs to. Used when importing from CSV where group IDs are not available. Null when the item is not in any group. - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields are inherited from the group. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. If the resulting end time is not after the effective start time, the query is skipped. - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - `id` string, nullable, required — The ID of the group (null when creating a new group). - `standardSettings` object, required - `scanModeId` string, required — The ID of the scan mode to use for this group. - `name` string, required — The name of the group. - `historySettings` object, required - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. If the resulting end time is not after the effective start time, the query is skipped. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Negative values extend the window backwards (equivalent to the old overlap behaviour). - SouthConnectorFTPCommandDTO — South connector command for FTP file transfer. - `name` string, required — The name of the South connector. - `type` 'ftp', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthFTPSettings, required - `host` string, required - `port` number, double, required - `authentication` 'none' | 'password', required - `username` string, nullable - `password` string, nullable - `compression` boolean, required - `items` SouthConnectorFTPItemCommandDTO[], required — List of items (data points) to configure for this connector. - `id` string, nullable, required — The ID of the item (null when creating a new item). - `enabled` boolean, required — Whether this item should be enabled. - `name` string, required — The name of the item. - `settings` SouthFTPItemSettings, required - `remoteFolder` string, required - `regex` string, required - `minAge` number, double, required - `preserveFiles` boolean, required - `ignoreModifiedDate` boolean - `maxFiles` number, double, required - `maxSize` number, double, required - `recursive` boolean, required - `scanModeId` string, nullable, required — The ID of the scan mode to use for this item. Null when the scan mode should be determined by the system. - `scanModeName` string, nullable, required — The name of the scan mode to use when ID is not available. Null when not specifying by name. - `groupId` string, nullable, required — The ID of the group this item belongs to. Null when the item is not in any group. - `groupName` string, nullable, required — The name of the group this item belongs to. Used when importing from CSV where group IDs are not available. Null when the item is not in any group. - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields are inherited from the group. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. If the resulting end time is not after the effective start time, the query is skipped. - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - `id` string, nullable, required — The ID of the group (null when creating a new group). - `standardSettings` object, required - `scanModeId` string, required — The ID of the scan mode to use for this group. - `name` string, required — The name of the group. - `historySettings` object, required - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. If the resulting end time is not after the effective start time, the query is skipped. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Negative values extend the window backwards (equivalent to the old overlap behaviour). - SouthConnectorInfluxDBCommandDTO — South connector command for InfluxDB time series database. - `name` string, required — The name of the South connector. - `type` 'influxdb', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthInfluxDBSettings, required - `version` '1' | '2' | '3', required - `host` string - `port` number, double - `protocol` 'http' | 'https' - `database` string - `username` string, nullable - `password` string, nullable - `url` string - `token` string, nullable - `organisation` string - `bucket` string - `items` SouthConnectorInfluxDBItemCommandDTO[], required — List of items (data points) to configure for this connector. - `id` string, nullable, required — The ID of the item (null when creating a new item). - `enabled` boolean, required — Whether this item should be enabled. - `name` string, required — The name of the item. - `settings` SouthInfluxDBItemSettings, required - `query` string, required - `requestTimeout` number, double, required - `scanModeId` string, nullable, required — The ID of the scan mode to use for this item. Null when the scan mode should be determined by the system. - `scanModeName` string, nullable, required — The name of the scan mode to use when ID is not available. Null when not specifying by name. - `groupId` string, nullable, required — The ID of the group this item belongs to. Null when the item is not in any group. - `groupName` string, nullable, required — The name of the group this item belongs to. Used when importing from CSV where group IDs are not available. Null when the item is not in any group. - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields are inherited from the group. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. If the resulting end time is not after the effective start time, the query is skipped. - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - `id` string, nullable, required — The ID of the group (null when creating a new group). - `standardSettings` object, required - `scanModeId` string, required — The ID of the scan mode to use for this group. - `name` string, required — The name of the group. - `historySettings` object, required - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. If the resulting end time is not after the effective start time, the query is skipped. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Negative values extend the window backwards (equivalent to the old overlap behaviour). - SouthConnectorModbusCommandDTO — South connector command for Modbus. - `name` string, required — The name of the South connector. - `type` 'modbus', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthModbusSettings, required - `host` string, required - `port` number, double, required - `connectTimeout` number, double, required - `networkTimeout` number, double, required - `retryInterval` number, double, required - `slaveId` number, double, required - `addressOffset` 'modbus' | 'jbus', required - `endianness` 'big-endian' | 'little-endian', required - `swapBytesInWords` boolean, required - `swapWordsInDWords` boolean, required - `batchQuery` boolean, required - `groupingGap` number, double - `items` SouthConnectorModbusItemCommandDTO[], required — List of items (data points) to configure for this connector. - `id` string, nullable, required — The ID of the item (null when creating a new item). - `enabled` boolean, required — Whether this item should be enabled. - `name` string, required — The name of the item. - `settings` SouthModbusItemSettings, required - `address` string, required - `modbusType` 'coil' | 'discrete-input' | 'input-register' | 'holding-register', required - `data` SouthModbusItemSettingsData - `dataType` 'uint16' | 'int16' | 'uint32' | 'int32' | 'big-uint64' | 'big-int64' | 'float' | 'double' | 'bit', required - `bitIndex` number, double - `multiplierCoefficient` number, double, required - `scanModeId` string, nullable, required — The ID of the scan mode to use for this item. Null when the scan mode should be determined by the system. - `scanModeName` string, nullable, required — The name of the scan mode to use when ID is not available. Null when not specifying by name. - `groupId` string, nullable, required — The ID of the group this item belongs to. Null when the item is not in any group. - `groupName` string, nullable, required — The name of the group this item belongs to. Used when importing from CSV where group IDs are not available. Null when the item is not in any group. - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields are inherited from the group. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. If the resulting end time is not after the effective start time, the query is skipped. - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - `id` string, nullable, required — The ID of the group (null when creating a new group). - `standardSettings` object, required - `scanModeId` string, required — The ID of the scan mode to use for this group. - `name` string, required — The name of the group. - `historySettings` object, required - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. If the resulting end time is not after the effective start time, the query is skipped. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Negative values extend the window backwards (equivalent to the old overlap behaviour). - SouthConnectorMQTTCommandDTO — South connector command for MQTT. - `name` string, required — The name of the South connector. - `type` 'mqtt', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthMQTTSettings, required - `url` string, required - `qos` '0' | '1' | '2', required - `persistent` boolean - `authentication` SouthMQTTSettingsAuthentication, required - `type` 'none' | 'basic' | 'cert', required - `username` string - `password` string, nullable - `certFilePath` string - `keyFilePath` string - `caFilePath` string - `rejectUnauthorized` boolean, required - `reconnectPeriod` number, double, required - `connectTimeout` number, double, required - `maxNumberOfMessages` number, double, required - `flushMessageTimeout` number, double, required - `items` SouthConnectorMQTTItemCommandDTO[], required — List of items (data points) to configure for this connector. - `id` string, nullable, required — The ID of the item (null when creating a new item). - `enabled` boolean, required — Whether this item should be enabled. - `name` string, required — The name of the item. - `settings` SouthMQTTItemSettings, required - `topic` string, required - `scanModeId` string, nullable, required — The ID of the scan mode to use for this item. Null when the scan mode should be determined by the system. - `scanModeName` string, nullable, required — The name of the scan mode to use when ID is not available. Null when not specifying by name. - `groupId` string, nullable, required — The ID of the group this item belongs to. Null when the item is not in any group. - `groupName` string, nullable, required — The name of the group this item belongs to. Used when importing from CSV where group IDs are not available. Null when the item is not in any group. - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields are inherited from the group. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. If the resulting end time is not after the effective start time, the query is skipped. - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - `id` string, nullable, required — The ID of the group (null when creating a new group). - `standardSettings` object, required - `scanModeId` string, required — The ID of the scan mode to use for this group. - `name` string, required — The name of the group. - `historySettings` object, required - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. If the resulting end time is not after the effective start time, the query is skipped. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Negative values extend the window backwards (equivalent to the old overlap behaviour). - SouthConnectorMSSQLCommandDTO — South connector command for Microsoft SQL Server. - `name` string, required — The name of the South connector. - `type` 'mssql', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthMSSQLSettings, required - `host` string, required - `port` number, double, required - `connectionTimeout` number, double, required - `database` string, required - `encryption` boolean, required - `trustServerCertificate` boolean, required - `username` string, nullable, required - `password` string, nullable, required - `domain` string, nullable, required - `requestTimeout` number, double, required - `items` SouthConnectorMSSQLItemCommandDTO[], required — List of items (data points) to configure for this connector. - `id` string, nullable, required — The ID of the item (null when creating a new item). - `enabled` boolean, required — Whether this item should be enabled. - `name` string, required — The name of the item. - `settings` SouthMSSQLItemSettings, required - `query` string, required - `dateTimeFields` SouthMSSQLItemSettingsDateTimeFields[], nullable, required - `fieldName` string, required - `useAsReference` boolean, required - `type` 'string' | 'date' | 'date-time' | 'date-time-2' | 'date-time-offset' | 'small-date-time' | 'iso-string' | 'unix-epoch' | 'unix-epoch-ms', required - `timezone` string — Represents a timezone as an IANA timezone string. - `format` string - `locale` string - `serialization` SouthMSSQLItemSettingsSerialization, required - `type` 'csv', required - `filename` string, required - `delimiter` 'DOT' | 'SEMI_COLON' | 'COLON' | 'COMMA' | 'NON_BREAKING_SPACE' | 'SLASH' | 'TAB' | 'PIPE', required - `compression` boolean, required - `outputTimestampFormat` string, required - `outputTimezone` string, required — Represents a timezone as an IANA timezone string. - `scanModeId` string, nullable, required — The ID of the scan mode to use for this item. Null when the scan mode should be determined by the system. - `scanModeName` string, nullable, required — The name of the scan mode to use when ID is not available. Null when not specifying by name. - `groupId` string, nullable, required — The ID of the group this item belongs to. Null when the item is not in any group. - `groupName` string, nullable, required — The name of the group this item belongs to. Used when importing from CSV where group IDs are not available. Null when the item is not in any group. - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields are inherited from the group. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. If the resulting end time is not after the effective start time, the query is skipped. - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - `id` string, nullable, required — The ID of the group (null when creating a new group). - `standardSettings` object, required - `scanModeId` string, required — The ID of the scan mode to use for this group. - `name` string, required — The name of the group. - `historySettings` object, required - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. If the resulting end time is not after the effective start time, the query is skipped. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Negative values extend the window backwards (equivalent to the old overlap behaviour). - SouthConnectorMySQLCommandDTO — South connector command for MySQL. - `name` string, required — The name of the South connector. - `type` 'mysql', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthMySQLSettings, required - `host` string, required - `port` number, double, required - `connectionTimeout` number, double, required - `database` string, required - `username` string, nullable, required - `password` string, nullable, required - `items` SouthConnectorMySQLItemCommandDTO[], required — List of items (data points) to configure for this connector. - `id` string, nullable, required — The ID of the item (null when creating a new item). - `enabled` boolean, required — Whether this item should be enabled. - `name` string, required — The name of the item. - `settings` SouthMySQLItemSettings, required - `query` string, required - `requestTimeout` number, double, required - `dateTimeFields` SouthMySQLItemSettingsDateTimeFields[], nullable, required - `fieldName` string, required - `useAsReference` boolean, required - `type` 'string' | 'date-time' | 'iso-string' | 'unix-epoch' | 'unix-epoch-ms', required - `timezone` string — Represents a timezone as an IANA timezone string. - `format` string - `locale` string - `serialization` SouthMySQLItemSettingsSerialization, required - `type` 'csv', required - `filename` string, required - `delimiter` 'DOT' | 'SEMI_COLON' | 'COLON' | 'COMMA' | 'NON_BREAKING_SPACE' | 'SLASH' | 'TAB' | 'PIPE', required - `compression` boolean, required - `outputTimestampFormat` string, required - `outputTimezone` string, required — Represents a timezone as an IANA timezone string. - `scanModeId` string, nullable, required — The ID of the scan mode to use for this item. Null when the scan mode should be determined by the system. - `scanModeName` string, nullable, required — The name of the scan mode to use when ID is not available. Null when not specifying by name. - `groupId` string, nullable, required — The ID of the group this item belongs to. Null when the item is not in any group. - `groupName` string, nullable, required — The name of the group this item belongs to. Used when importing from CSV where group IDs are not available. Null when the item is not in any group. - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields are inherited from the group. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. If the resulting end time is not after the effective start time, the query is skipped. - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - `id` string, nullable, required — The ID of the group (null when creating a new group). - `standardSettings` object, required - `scanModeId` string, required — The ID of the scan mode to use for this group. - `name` string, required — The name of the group. - `historySettings` object, required - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. If the resulting end time is not after the effective start time, the query is skipped. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Negative values extend the window backwards (equivalent to the old overlap behaviour). - SouthConnectorODBCCommandDTO — South connector command for ODBC. - `name` string, required — The name of the South connector. - `type` 'odbc', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthODBCSettings, required - `remoteAgent` boolean, required - `agentUrl` string - `connectionTimeout` number, double, required - `retryInterval` number, double, required - `requestTimeout` number, double - `connectionString` string, required - `password` string, nullable, required - `items` SouthConnectorODBCItemCommandDTO[], required — List of items (data points) to configure for this connector. - `id` string, nullable, required — The ID of the item (null when creating a new item). - `enabled` boolean, required — Whether this item should be enabled. - `name` string, required — The name of the item. - `settings` SouthODBCItemSettings, required - `query` string, required - `dateTimeFields` SouthODBCItemSettingsDateTimeFields[], nullable, required - `fieldName` string, required - `useAsReference` boolean, required - `type` 'string' | 'iso-string' | 'unix-epoch' | 'unix-epoch-ms', required - `timezone` string — Represents a timezone as an IANA timezone string. - `format` string - `locale` string - `serialization` SouthODBCItemSettingsSerialization, required - `type` 'csv', required - `filename` string, required - `delimiter` 'DOT' | 'SEMI_COLON' | 'COLON' | 'COMMA' | 'NON_BREAKING_SPACE' | 'SLASH' | 'TAB' | 'PIPE', required - `compression` boolean, required - `outputTimestampFormat` string, required - `outputTimezone` string, required — Represents a timezone as an IANA timezone string. - `scanModeId` string, nullable, required — The ID of the scan mode to use for this item. Null when the scan mode should be determined by the system. - `scanModeName` string, nullable, required — The name of the scan mode to use when ID is not available. Null when not specifying by name. - `groupId` string, nullable, required — The ID of the group this item belongs to. Null when the item is not in any group. - `groupName` string, nullable, required — The name of the group this item belongs to. Used when importing from CSV where group IDs are not available. Null when the item is not in any group. - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields are inherited from the group. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. If the resulting end time is not after the effective start time, the query is skipped. - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - `id` string, nullable, required — The ID of the group (null when creating a new group). - `standardSettings` object, required - `scanModeId` string, required — The ID of the scan mode to use for this group. - `name` string, required — The name of the group. - `historySettings` object, required - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. If the resulting end time is not after the effective start time, the query is skipped. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Negative values extend the window backwards (equivalent to the old overlap behaviour). - SouthConnectorOIAnalyticsCommandDTO — South connector command for OIAnalytics. - `name` string, required — The name of the South connector. - `type` 'oianalytics', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthOIAnalyticsSettings, required - `useOiaModule` boolean, required - `timeout` number, double, required - `specificSettings` SouthOIAnalyticsSettingsSpecificSettings - `host` string, required - `acceptUnauthorized` boolean, required - `authentication` 'basic' | 'aad-client-secret' | 'aad-certificate', required - `accessKey` string - `secretKey` string, nullable - `tenantId` string - `clientId` string - `clientSecret` string, nullable - `certificateId` string - `scope` string - `useProxy` boolean, required - `proxyUrl` string - `proxyUsername` string - `proxyPassword` string, nullable - `items` SouthConnectorOIAnalyticsItemCommandDTO[], required — List of items (data points) to configure for this connector. - `id` string, nullable, required — The ID of the item (null when creating a new item). - `enabled` boolean, required — Whether this item should be enabled. - `name` string, required — The name of the item. - `settings` SouthOIAnalyticsItemSettings, required - `endpoint` string, required - `queryParams` SouthOIAnalyticsItemSettingsQueryParams[], required - `key` string, required - `value` string, required - `serialization` SouthOIAnalyticsItemSettingsSerialization, required - `type` 'csv', required - `filename` string, required - `delimiter` 'DOT' | 'SEMI_COLON' | 'COLON' | 'COMMA' | 'NON_BREAKING_SPACE' | 'SLASH' | 'TAB' | 'PIPE', required - `compression` boolean, required - `outputTimestampFormat` string, required - `outputTimezone` string, required — Represents a timezone as an IANA timezone string. - `scanModeId` string, nullable, required — The ID of the scan mode to use for this item. Null when the scan mode should be determined by the system. - `scanModeName` string, nullable, required — The name of the scan mode to use when ID is not available. Null when not specifying by name. - `groupId` string, nullable, required — The ID of the group this item belongs to. Null when the item is not in any group. - `groupName` string, nullable, required — The name of the group this item belongs to. Used when importing from CSV where group IDs are not available. Null when the item is not in any group. - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields are inherited from the group. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. If the resulting end time is not after the effective start time, the query is skipped. - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - `id` string, nullable, required — The ID of the group (null when creating a new group). - `standardSettings` object, required - `scanModeId` string, required — The ID of the scan mode to use for this group. - `name` string, required — The name of the group. - `historySettings` object, required - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. If the resulting end time is not after the effective start time, the query is skipped. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Negative values extend the window backwards (equivalent to the old overlap behaviour). - SouthConnectorOLEDBCommandDTO — South connector command for OLE DB. - `name` string, required — The name of the South connector. - `type` 'oledb', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthOLEDBSettings, required - `agentUrl` string, required - `connectionTimeout` number, double, required - `retryInterval` number, double, required - `requestTimeout` number, double, required - `connectionString` string, required - `password` string, nullable, required - `items` SouthConnectorOLEDBItemCommandDTO[], required — List of items (data points) to configure for this connector. - `id` string, nullable, required — The ID of the item (null when creating a new item). - `enabled` boolean, required — Whether this item should be enabled. - `name` string, required — The name of the item. - `settings` SouthOLEDBItemSettings, required - `query` string, required - `dateTimeFields` SouthOLEDBItemSettingsDateTimeFields[], nullable, required - `fieldName` string, required - `useAsReference` boolean, required - `type` 'string' | 'iso-string' | 'unix-epoch' | 'unix-epoch-ms', required - `timezone` string — Represents a timezone as an IANA timezone string. - `format` string - `locale` string - `serialization` SouthOLEDBItemSettingsSerialization, required - `type` 'csv', required - `filename` string, required - `delimiter` 'DOT' | 'SEMI_COLON' | 'COLON' | 'COMMA' | 'NON_BREAKING_SPACE' | 'SLASH' | 'TAB' | 'PIPE', required - `compression` boolean, required - `outputTimestampFormat` string, required - `outputTimezone` string, required — Represents a timezone as an IANA timezone string. - `scanModeId` string, nullable, required — The ID of the scan mode to use for this item. Null when the scan mode should be determined by the system. - `scanModeName` string, nullable, required — The name of the scan mode to use when ID is not available. Null when not specifying by name. - `groupId` string, nullable, required — The ID of the group this item belongs to. Null when the item is not in any group. - `groupName` string, nullable, required — The name of the group this item belongs to. Used when importing from CSV where group IDs are not available. Null when the item is not in any group. - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields are inherited from the group. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. If the resulting end time is not after the effective start time, the query is skipped. - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - `id` string, nullable, required — The ID of the group (null when creating a new group). - `standardSettings` object, required - `scanModeId` string, required — The ID of the scan mode to use for this group. - `name` string, required — The name of the group. - `historySettings` object, required - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. If the resulting end time is not after the effective start time, the query is skipped. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Negative values extend the window backwards (equivalent to the old overlap behaviour). - SouthConnectorOPCCommandDTO — South connector command for classic OPC (OLE for Process Control). - `name` string, required — The name of the South connector. - `type` 'opc', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthOPCSettings, required - `agentUrl` string, required - `retryInterval` number, double, required - `host` string, required - `serverName` string, required - `mode` 'hda' | 'da', required - `items` SouthConnectorOPCItemCommandDTO[], required — List of items (data points) to configure for this connector. - `id` string, nullable, required — The ID of the item (null when creating a new item). - `enabled` boolean, required — Whether this item should be enabled. - `name` string, required — The name of the item. - `settings` SouthOPCItemSettings, required - `nodeId` string, required - `aggregate` 'raw' | 'interpolative' | 'total' | 'average' | 'time-average' | 'count' | 'stdev' | 'minimum-actual-time' | 'minimum' | 'maximum-actual-time' | 'maximum' | 'start' | 'end' | 'delta' | 'reg-slope' | 'reg-const' | 'reg-dev' | 'variance' | 'range' | 'duration-good' | 'duration-bad' | 'percent-good' | 'percent-bad' | 'worst-quality' | 'annotations', required - `resampling` 'none' | '1s' | '10s' | '30s' | '1min' | '1h' | '1d' - `scanModeId` string, nullable, required — The ID of the scan mode to use for this item. Null when the scan mode should be determined by the system. - `scanModeName` string, nullable, required — The name of the scan mode to use when ID is not available. Null when not specifying by name. - `groupId` string, nullable, required — The ID of the group this item belongs to. Null when the item is not in any group. - `groupName` string, nullable, required — The name of the group this item belongs to. Used when importing from CSV where group IDs are not available. Null when the item is not in any group. - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields are inherited from the group. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. If the resulting end time is not after the effective start time, the query is skipped. - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - `id` string, nullable, required — The ID of the group (null when creating a new group). - `standardSettings` object, required - `scanModeId` string, required — The ID of the scan mode to use for this group. - `name` string, required — The name of the group. - `historySettings` object, required - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. If the resulting end time is not after the effective start time, the query is skipped. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Negative values extend the window backwards (equivalent to the old overlap behaviour). - SouthConnectorOPCUACommandDTO — South connector command for OPC UA. - `name` string, required — The name of the South connector. - `type` 'opcua', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthOPCUASettings, required - `url` string, required - `keepSessionAlive` boolean, required - `readTimeout` number, double, required - `retryInterval` number, double, required - `maxNumberOfMessages` number, double, required - `flushMessageTimeout` number, double, required - `securityMode` 'none' | 'sign' | 'sign-and-encrypt', required - `securityPolicy` 'none' | 'basic128' | 'basic192' | 'basic256' | 'basic128-rsa15' | 'basic192-rsa15' | 'basic256-rsa15' | 'basic256-sha256' | 'aes128-sha256-rsa-oaep' | 'pub-sub-aes-128-ctr' | 'pub-sub-aes-256-ctr' - `maxParallelRun` number, double, required - `authentication` SouthOPCUASettingsAuthentication, required - `type` 'none' | 'basic' | 'cert', required - `username` string - `password` string, nullable - `certFilePath` string - `keyFilePath` string - `items` SouthConnectorOPCUAItemCommandDTO[], required — List of items (data points) to configure for this connector. - `id` string, nullable, required — The ID of the item (null when creating a new item). - `enabled` boolean, required — Whether this item should be enabled. - `name` string, required — The name of the item. - `settings` SouthOPCUAItemSettings, required - `nodeId` string, required - `mode` 'da' | 'ha', required - `haMode` SouthOPCUAItemSettingsHaMode - `aggregate` 'raw' | 'average' | 'count' | 'minimum' | 'maximum', required - `resampling` 'none' | '1s' | '10s' | '30s' | '1min' | '1h' | '1d' - `timestampOrigin` 'oibus' | 'point' | 'server' - `scanModeId` string, nullable, required — The ID of the scan mode to use for this item. Null when the scan mode should be determined by the system. - `scanModeName` string, nullable, required — The name of the scan mode to use when ID is not available. Null when not specifying by name. - `groupId` string, nullable, required — The ID of the group this item belongs to. Null when the item is not in any group. - `groupName` string, nullable, required — The name of the group this item belongs to. Used when importing from CSV where group IDs are not available. Null when the item is not in any group. - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields are inherited from the group. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. If the resulting end time is not after the effective start time, the query is skipped. - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - `id` string, nullable, required — The ID of the group (null when creating a new group). - `standardSettings` object, required - `scanModeId` string, required — The ID of the scan mode to use for this group. - `name` string, required — The name of the group. - `historySettings` object, required - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. If the resulting end time is not after the effective start time, the query is skipped. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Negative values extend the window backwards (equivalent to the old overlap behaviour). - SouthConnectorOracleCommandDTO — South connector command for Oracle Database. - `name` string, required — The name of the South connector. - `type` 'oracle', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthOracleSettings, required - `thickMode` boolean, required - `oracleClient` string - `host` string, required - `port` number, double, required - `connectionTimeout` number, double, required - `database` string, required - `username` string, nullable, required - `password` string, nullable, required - `items` SouthConnectorOracleItemCommandDTO[], required — List of items (data points) to configure for this connector. - `id` string, nullable, required — The ID of the item (null when creating a new item). - `enabled` boolean, required — Whether this item should be enabled. - `name` string, required — The name of the item. - `settings` SouthOracleItemSettings, required - `query` string, required - `requestTimeout` number, double, required - `dateTimeFields` SouthOracleItemSettingsDateTimeFields[], nullable, required - `fieldName` string, required - `useAsReference` boolean, required - `type` 'string' | 'date-time' | 'iso-string' | 'unix-epoch' | 'unix-epoch-ms', required - `timezone` string — Represents a timezone as an IANA timezone string. - `format` string - `locale` string - `serialization` SouthOracleItemSettingsSerialization, required - `type` 'csv', required - `filename` string, required - `delimiter` 'DOT' | 'SEMI_COLON' | 'COLON' | 'COMMA' | 'NON_BREAKING_SPACE' | 'SLASH' | 'TAB' | 'PIPE', required - `compression` boolean, required - `outputTimestampFormat` string, required - `outputTimezone` string, required — Represents a timezone as an IANA timezone string. - `scanModeId` string, nullable, required — The ID of the scan mode to use for this item. Null when the scan mode should be determined by the system. - `scanModeName` string, nullable, required — The name of the scan mode to use when ID is not available. Null when not specifying by name. - `groupId` string, nullable, required — The ID of the group this item belongs to. Null when the item is not in any group. - `groupName` string, nullable, required — The name of the group this item belongs to. Used when importing from CSV where group IDs are not available. Null when the item is not in any group. - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields are inherited from the group. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. If the resulting end time is not after the effective start time, the query is skipped. - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - `id` string, nullable, required — The ID of the group (null when creating a new group). - `standardSettings` object, required - `scanModeId` string, required — The ID of the scan mode to use for this group. - `name` string, required — The name of the group. - `historySettings` object, required - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. If the resulting end time is not after the effective start time, the query is skipped. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Negative values extend the window backwards (equivalent to the old overlap behaviour). - SouthConnectorOsisoftPICommandDTO — South connector command for OSIsoft PI System. - `name` string, required — The name of the South connector. - `type` 'osisoft-pi', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthPISettings, required - `agentUrl` string, required - `retryInterval` number, double, required - `items` SouthConnectorOsisoftPIItemCommandDTO[], required — List of items (data points) to configure for this connector. - `id` string, nullable, required — The ID of the item (null when creating a new item). - `enabled` boolean, required — Whether this item should be enabled. - `name` string, required — The name of the item. - `settings` SouthPIItemSettings, required - `type` 'point-id' | 'point-query', required - `piPoint` string - `piQuery` string - `scanModeId` string, nullable, required — The ID of the scan mode to use for this item. Null when the scan mode should be determined by the system. - `scanModeName` string, nullable, required — The name of the scan mode to use when ID is not available. Null when not specifying by name. - `groupId` string, nullable, required — The ID of the group this item belongs to. Null when the item is not in any group. - `groupName` string, nullable, required — The name of the group this item belongs to. Used when importing from CSV where group IDs are not available. Null when the item is not in any group. - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields are inherited from the group. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. If the resulting end time is not after the effective start time, the query is skipped. - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - `id` string, nullable, required — The ID of the group (null when creating a new group). - `standardSettings` object, required - `scanModeId` string, required — The ID of the scan mode to use for this group. - `name` string, required — The name of the group. - `historySettings` object, required - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. If the resulting end time is not after the effective start time, the query is skipped. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Negative values extend the window backwards (equivalent to the old overlap behaviour). - SouthConnectorPostgreSQLCommandDTO — South connector command for PostgreSQL. - `name` string, required — The name of the South connector. - `type` 'postgresql', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthPostgreSQLSettings, required - `host` string, required - `port` number, double, required - `sslMode` boolean, required - `database` string, required - `connectionTimeout` number, double, required - `requestTimeout` number, double, required - `username` string, nullable, required - `password` string, nullable, required - `items` SouthConnectorPostgreSQLItemCommandDTO[], required — List of items (data points) to configure for this connector. - `id` string, nullable, required — The ID of the item (null when creating a new item). - `enabled` boolean, required — Whether this item should be enabled. - `name` string, required — The name of the item. - `settings` SouthPostgreSQLItemSettings, required - `query` string, required - `dateTimeFields` SouthPostgreSQLItemSettingsDateTimeFields[], nullable, required - `fieldName` string, required - `useAsReference` boolean, required - `type` 'string' | 'iso-string' | 'unix-epoch' | 'unix-epoch-ms' | 'timestamp' | 'timestamptz', required - `timezone` string — Represents a timezone as an IANA timezone string. - `format` string - `locale` string - `serialization` SouthPostgreSQLItemSettingsSerialization, required - `type` 'csv', required - `filename` string, required - `delimiter` 'DOT' | 'SEMI_COLON' | 'COLON' | 'COMMA' | 'NON_BREAKING_SPACE' | 'SLASH' | 'TAB' | 'PIPE', required - `compression` boolean, required - `outputTimestampFormat` string, required - `outputTimezone` string, required — Represents a timezone as an IANA timezone string. - `scanModeId` string, nullable, required — The ID of the scan mode to use for this item. Null when the scan mode should be determined by the system. - `scanModeName` string, nullable, required — The name of the scan mode to use when ID is not available. Null when not specifying by name. - `groupId` string, nullable, required — The ID of the group this item belongs to. Null when the item is not in any group. - `groupName` string, nullable, required — The name of the group this item belongs to. Used when importing from CSV where group IDs are not available. Null when the item is not in any group. - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields are inherited from the group. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. If the resulting end time is not after the effective start time, the query is skipped. - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - `id` string, nullable, required — The ID of the group (null when creating a new group). - `standardSettings` object, required - `scanModeId` string, required — The ID of the scan mode to use for this group. - `name` string, required — The name of the group. - `historySettings` object, required - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. If the resulting end time is not after the effective start time, the query is skipped. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Negative values extend the window backwards (equivalent to the old overlap behaviour). - SouthConnectorRESTCommandDTO — South connector command for the REST API. - `name` string, required — The name of the South connector. - `type` 'rest', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthRestSettings, required - `host` string, required - `acceptUnauthorized` boolean, required - `timeout` number, double, required - `authentication` SouthRestSettingsAuthentication, required - `type` 'none' | 'basic' | 'bearer' | 'api-key', required - `username` string - `password` string, nullable - `token` string, nullable - `apiKey` string - `apiValue` string, nullable - `addTo` 'header' | 'query-params' - `proxy` SouthRestSettingsProxy, required - `useProxy` boolean, required - `proxyUrl` string - `proxyUsername` string, nullable - `proxyPassword` string, nullable - `test` SouthRestSettingsTest, required - `method` 'GET' | 'POST' | 'PUT', required - `endpoint` string, required - `successCode` number, double, required - `body` string, nullable - `items` SouthConnectorRESTItemCommandDTO[], required — List of items (data points) to configure for this connector. - `id` string, nullable, required — The ID of the item (null when creating a new item). - `enabled` boolean, required — Whether this item should be enabled. - `name` string, required — The name of the item. - `settings` SouthRestItemSettings, required - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE', required - `endpoint` string, required - `returnType` 'file' | 'body', required - `queryParams` SouthRestItemSettingsQueryParams[], required - `key` string, required - `value` string, required - `dateTimeInput` SouthRestItemSettingsQueryParamsDateTimeInput - `type` 'string' | 'iso-string' | 'unix-epoch' | 'unix-epoch-ms', required - `timezone` string — Represents a timezone as an IANA timezone string. - `format` string, nullable - `headers` SouthRestItemSettingsHeaders[], required - `key` string, required - `value` string, required - `dateTimeInput` SouthRestItemSettingsHeadersDateTimeInput - `type` 'string' | 'iso-string' | 'unix-epoch' | 'unix-epoch-ms', required - `timezone` string — Represents a timezone as an IANA timezone string. - `format` string, nullable - `body` SouthRestItemSettingsBody - `content` string, nullable, required - `dateTimeInput` SouthRestItemSettingsBodyDateTimeInput - `type` 'string' | 'iso-string' | 'unix-epoch' | 'unix-epoch-ms', required - `timezone` string — Represents a timezone as an IANA timezone string. - `format` string, nullable - `trackingInstant` SouthRestItemSettingsTrackingInstant - `trackInstant` boolean, required - `jsonPath` string - `dateTimeInput` SouthRestItemSettingsTrackingInstantDateTimeInput - `type` 'string' | 'iso-string' | 'unix-epoch' | 'unix-epoch-ms', required - `timezone` string — Represents a timezone as an IANA timezone string. - `format` string - `locale` string - `scanModeId` string, nullable, required — The ID of the scan mode to use for this item. Null when the scan mode should be determined by the system. - `scanModeName` string, nullable, required — The name of the scan mode to use when ID is not available. Null when not specifying by name. - `groupId` string, nullable, required — The ID of the group this item belongs to. Null when the item is not in any group. - `groupName` string, nullable, required — The name of the group this item belongs to. Used when importing from CSV where group IDs are not available. Null when the item is not in any group. - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields are inherited from the group. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. If the resulting end time is not after the effective start time, the query is skipped. - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - `id` string, nullable, required — The ID of the group (null when creating a new group). - `standardSettings` object, required - `scanModeId` string, required — The ID of the scan mode to use for this group. - `name` string, required — The name of the group. - `historySettings` object, required - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. If the resulting end time is not after the effective start time, the query is skipped. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Negative values extend the window backwards (equivalent to the old overlap behaviour). - SouthConnectorSFTPCommandDTO — South connector command for SFTP file transfer. - `name` string, required — The name of the South connector. - `type` 'sftp', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthSFTPSettings, required - `host` string, required - `port` number, double, required - `authentication` 'password' | 'private-key', required - `username` string, required - `password` string, nullable - `privateKey` string - `passphrase` string, nullable - `compression` boolean, required - `items` SouthConnectorSFTPItemCommandDTO[], required — List of items (data points) to configure for this connector. - `id` string, nullable, required — The ID of the item (null when creating a new item). - `enabled` boolean, required — Whether this item should be enabled. - `name` string, required — The name of the item. - `settings` SouthSFTPItemSettings, required - `remoteFolder` string, required - `regex` string, required - `minAge` number, double, required - `preserveFiles` boolean, required - `ignoreModifiedDate` boolean - `maxFiles` number, double, required - `maxSize` number, double, required - `recursive` boolean, required - `scanModeId` string, nullable, required — The ID of the scan mode to use for this item. Null when the scan mode should be determined by the system. - `scanModeName` string, nullable, required — The name of the scan mode to use when ID is not available. Null when not specifying by name. - `groupId` string, nullable, required — The ID of the group this item belongs to. Null when the item is not in any group. - `groupName` string, nullable, required — The name of the group this item belongs to. Used when importing from CSV where group IDs are not available. Null when the item is not in any group. - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields are inherited from the group. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. If the resulting end time is not after the effective start time, the query is skipped. - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - `id` string, nullable, required — The ID of the group (null when creating a new group). - `standardSettings` object, required - `scanModeId` string, required — The ID of the scan mode to use for this group. - `name` string, required — The name of the group. - `historySettings` object, required - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. If the resulting end time is not after the effective start time, the query is skipped. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Negative values extend the window backwards (equivalent to the old overlap behaviour). - SouthConnectorSQLiteCommandDTO — South connector command for SQLite. - `name` string, required — The name of the South connector. - `type` 'sqlite', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthSQLiteSettings, required - `databasePath` string, required - `items` SouthConnectorSQLiteItemCommandDTO[], required — List of items (data points) to configure for this connector. - `id` string, nullable, required — The ID of the item (null when creating a new item). - `enabled` boolean, required — Whether this item should be enabled. - `name` string, required — The name of the item. - `settings` SouthSQLiteItemSettings, required - `query` string, required - `dateTimeFields` SouthSQLiteItemSettingsDateTimeFields[], nullable, required - `fieldName` string, required - `useAsReference` boolean, required - `type` 'string' | 'iso-string' | 'unix-epoch' | 'unix-epoch-ms', required - `timezone` string — Represents a timezone as an IANA timezone string. - `format` string - `locale` string - `serialization` SouthSQLiteItemSettingsSerialization, required - `type` 'csv', required - `filename` string, required - `delimiter` 'DOT' | 'SEMI_COLON' | 'COLON' | 'COMMA' | 'NON_BREAKING_SPACE' | 'SLASH' | 'TAB' | 'PIPE', required - `compression` boolean, required - `outputTimestampFormat` string, required - `outputTimezone` string, required — Represents a timezone as an IANA timezone string. - `scanModeId` string, nullable, required — The ID of the scan mode to use for this item. Null when the scan mode should be determined by the system. - `scanModeName` string, nullable, required — The name of the scan mode to use when ID is not available. Null when not specifying by name. - `groupId` string, nullable, required — The ID of the group this item belongs to. Null when the item is not in any group. - `groupName` string, nullable, required — The name of the group this item belongs to. Used when importing from CSV where group IDs are not available. Null when the item is not in any group. - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields are inherited from the group. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. When null and item is in a group, inherits from group settings. If the resulting end time is not after the effective start time, the query is skipped. - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - `id` string, nullable, required — The ID of the group (null when creating a new group). - `standardSettings` object, required - `scanModeId` string, required — The ID of the scan mode to use for this group. - `name` string, required — The name of the group. - `historySettings` object, required - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first. - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. If the resulting end time is not after the effective start time, the query is skipped. - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Negative values extend the window backwards (equivalent to the old overlap behaviour). ## Response `204` No Content --- [API](https://skmtc.net/optimistiksas/apis/oibus-api.md) · [All operations](https://skmtc.net/optimistiksas/apis/oibus-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/optimistiksas/oibus-api/versions/743d1b62f042/schema)