--- title: "List south connector items" method: GET path: "/api/south/{southId}/items/list" tags: ["South Connectors"] --- # List south connector items `GET /api/south/{southId}/items/list` List all items for a south connector ## Path parameters - `southId` string, required ## Response `200` Array of south connector item objects - SouthConnectorItemDTO[] - union — Data Transfer Object for an item to query within a South connector. Represents an individual data point or file to be collected. - SouthConnectorADSItemDTO — South connector item DTO for Beckhoff ADS. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the item. - `enabled` boolean, required — Whether this item is enabled and should be collected. - `settings` SouthADSItemSettings, required - `address` string, required - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `group` SouthItemGroupDTO, required — Data Transfer Object for a South item group. Represents a group of items that can share common settings. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `standardSettings` object, required - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `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. Only applicable for connectors with historian capabilities. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. 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. Only applicable for connectors with historian capabilities. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields (maxReadInterval, readDelay, startTimeOffset, endTimeOffset) 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. - SouthConnectorFolderScannerItemDTO — South connector item DTO for the Folder Scanner. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the item. - `enabled` boolean, required — Whether this item is enabled and should be collected. - `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 - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `group` SouthItemGroupDTO, required — Data Transfer Object for a South item group. Represents a group of items that can share common settings. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `standardSettings` object, required - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `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. Only applicable for connectors with historian capabilities. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. 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. Only applicable for connectors with historian capabilities. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields (maxReadInterval, readDelay, startTimeOffset, endTimeOffset) 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. - SouthConnectorFTPItemDTO — South connector item DTO for FTP file transfer. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the item. - `enabled` boolean, required — Whether this item is enabled and should be collected. - `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 - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `group` SouthItemGroupDTO, required — Data Transfer Object for a South item group. Represents a group of items that can share common settings. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `standardSettings` object, required - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `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. Only applicable for connectors with historian capabilities. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. 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. Only applicable for connectors with historian capabilities. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields (maxReadInterval, readDelay, startTimeOffset, endTimeOffset) 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. - SouthConnectorInfluxDBItemDTO — South connector item DTO for InfluxDB time series database. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the item. - `enabled` boolean, required — Whether this item is enabled and should be collected. - `settings` SouthInfluxDBItemSettings, required - `query` string, required - `requestTimeout` number, double, required - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `group` SouthItemGroupDTO, required — Data Transfer Object for a South item group. Represents a group of items that can share common settings. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `standardSettings` object, required - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `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. Only applicable for connectors with historian capabilities. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. 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. Only applicable for connectors with historian capabilities. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields (maxReadInterval, readDelay, startTimeOffset, endTimeOffset) 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. - SouthConnectorModbusItemDTO — South connector item DTO for Modbus. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the item. - `enabled` boolean, required — Whether this item is enabled and should be collected. - `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 - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `group` SouthItemGroupDTO, required — Data Transfer Object for a South item group. Represents a group of items that can share common settings. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `standardSettings` object, required - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `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. Only applicable for connectors with historian capabilities. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. 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. Only applicable for connectors with historian capabilities. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields (maxReadInterval, readDelay, startTimeOffset, endTimeOffset) 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. - SouthConnectorMQTTItemDTO — South connector item DTO for MQTT. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the item. - `enabled` boolean, required — Whether this item is enabled and should be collected. - `settings` SouthMQTTItemSettings, required - `topic` string, required - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `group` SouthItemGroupDTO, required — Data Transfer Object for a South item group. Represents a group of items that can share common settings. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `standardSettings` object, required - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `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. Only applicable for connectors with historian capabilities. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. 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. Only applicable for connectors with historian capabilities. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields (maxReadInterval, readDelay, startTimeOffset, endTimeOffset) 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. - SouthConnectorMSSQLItemDTO — South connector item DTO for Microsoft SQL Server. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the item. - `enabled` boolean, required — Whether this item is enabled and should be collected. - `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. - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `group` SouthItemGroupDTO, required — Data Transfer Object for a South item group. Represents a group of items that can share common settings. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `standardSettings` object, required - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `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. Only applicable for connectors with historian capabilities. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. 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. Only applicable for connectors with historian capabilities. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields (maxReadInterval, readDelay, startTimeOffset, endTimeOffset) 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. - SouthConnectorMySQLItemDTO — South connector item DTO for MySQL. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the item. - `enabled` boolean, required — Whether this item is enabled and should be collected. - `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. - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `group` SouthItemGroupDTO, required — Data Transfer Object for a South item group. Represents a group of items that can share common settings. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `standardSettings` object, required - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `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. Only applicable for connectors with historian capabilities. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. 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. Only applicable for connectors with historian capabilities. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields (maxReadInterval, readDelay, startTimeOffset, endTimeOffset) 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. - SouthConnectorODBCItemDTO — South connector item DTO for ODBC. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the item. - `enabled` boolean, required — Whether this item is enabled and should be collected. - `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. - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `group` SouthItemGroupDTO, required — Data Transfer Object for a South item group. Represents a group of items that can share common settings. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `standardSettings` object, required - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `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. Only applicable for connectors with historian capabilities. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. 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. Only applicable for connectors with historian capabilities. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields (maxReadInterval, readDelay, startTimeOffset, endTimeOffset) 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. - SouthConnectorOIAnalyticsItemDTO — South connector item DTO for OIAnalytics. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the item. - `enabled` boolean, required — Whether this item is enabled and should be collected. - `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. - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `group` SouthItemGroupDTO, required — Data Transfer Object for a South item group. Represents a group of items that can share common settings. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `standardSettings` object, required - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `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. Only applicable for connectors with historian capabilities. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. 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. Only applicable for connectors with historian capabilities. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields (maxReadInterval, readDelay, startTimeOffset, endTimeOffset) 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. - SouthConnectorOLEDBItemDTO — South connector item DTO for OLE DB. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the item. - `enabled` boolean, required — Whether this item is enabled and should be collected. - `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. - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `group` SouthItemGroupDTO, required — Data Transfer Object for a South item group. Represents a group of items that can share common settings. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `standardSettings` object, required - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `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. Only applicable for connectors with historian capabilities. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. 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. Only applicable for connectors with historian capabilities. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields (maxReadInterval, readDelay, startTimeOffset, endTimeOffset) 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. - SouthConnectorOPCItemDTO — South connector item DTO for classic OPC (OLE for Process Control). - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the item. - `enabled` boolean, required — Whether this item is enabled and should be collected. - `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' - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `group` SouthItemGroupDTO, required — Data Transfer Object for a South item group. Represents a group of items that can share common settings. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `standardSettings` object, required - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `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. Only applicable for connectors with historian capabilities. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. 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. Only applicable for connectors with historian capabilities. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields (maxReadInterval, readDelay, startTimeOffset, endTimeOffset) 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. - SouthConnectorOPCUAItemDTO — South connector item DTO for OPC UA. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the item. - `enabled` boolean, required — Whether this item is enabled and should be collected. - `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' - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `group` SouthItemGroupDTO, required — Data Transfer Object for a South item group. Represents a group of items that can share common settings. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `standardSettings` object, required - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `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. Only applicable for connectors with historian capabilities. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. 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. Only applicable for connectors with historian capabilities. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields (maxReadInterval, readDelay, startTimeOffset, endTimeOffset) 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. - SouthConnectorOracleItemDTO — South connector item DTO for Oracle Database. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the item. - `enabled` boolean, required — Whether this item is enabled and should be collected. - `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. - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `group` SouthItemGroupDTO, required — Data Transfer Object for a South item group. Represents a group of items that can share common settings. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `standardSettings` object, required - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `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. Only applicable for connectors with historian capabilities. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. 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. Only applicable for connectors with historian capabilities. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields (maxReadInterval, readDelay, startTimeOffset, endTimeOffset) 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. - SouthConnectorOsisoftPIItemDTO — South connector item DTO for OSIsoft PI System. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the item. - `enabled` boolean, required — Whether this item is enabled and should be collected. - `settings` SouthPIItemSettings, required - `type` 'point-id' | 'point-query', required - `piPoint` string - `piQuery` string - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `group` SouthItemGroupDTO, required — Data Transfer Object for a South item group. Represents a group of items that can share common settings. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `standardSettings` object, required - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `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. Only applicable for connectors with historian capabilities. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. 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. Only applicable for connectors with historian capabilities. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields (maxReadInterval, readDelay, startTimeOffset, endTimeOffset) 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. - SouthConnectorPostgreSQLItemDTO — South connector item DTO for PostgreSQL. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the item. - `enabled` boolean, required — Whether this item is enabled and should be collected. - `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. - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `group` SouthItemGroupDTO, required — Data Transfer Object for a South item group. Represents a group of items that can share common settings. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `standardSettings` object, required - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `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. Only applicable for connectors with historian capabilities. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. 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. Only applicable for connectors with historian capabilities. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields (maxReadInterval, readDelay, startTimeOffset, endTimeOffset) 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. - SouthConnectorRESTItemDTO — South connector item DTO for the REST API. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the item. - `enabled` boolean, required — Whether this item is enabled and should be collected. - `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 - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `group` SouthItemGroupDTO, required — Data Transfer Object for a South item group. Represents a group of items that can share common settings. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `standardSettings` object, required - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `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. Only applicable for connectors with historian capabilities. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. 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. Only applicable for connectors with historian capabilities. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields (maxReadInterval, readDelay, startTimeOffset, endTimeOffset) 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. - SouthConnectorSFTPItemDTO — South connector item DTO for SFTP file transfer. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the item. - `enabled` boolean, required — Whether this item is enabled and should be collected. - `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 - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `group` SouthItemGroupDTO, required — Data Transfer Object for a South item group. Represents a group of items that can share common settings. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `standardSettings` object, required - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `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. Only applicable for connectors with historian capabilities. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. 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. Only applicable for connectors with historian capabilities. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields (maxReadInterval, readDelay, startTimeOffset, endTimeOffset) 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. - SouthConnectorSQLiteItemDTO — South connector item DTO for SQLite. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the item. - `enabled` boolean, required — Whether this item is enabled and should be collected. - `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. - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `group` SouthItemGroupDTO, required — Data Transfer Object for a South item group. Represents a group of items that can share common settings. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `standardSettings` object, required - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `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. Only applicable for connectors with historian capabilities. - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities. - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. 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. Only applicable for connectors with historian capabilities. Negative values extend the window backwards (equivalent to the old overlap behaviour). - `syncWithGroup` boolean, required — Whether this item syncs its historian settings with its group. When true, historian fields (maxReadInterval, readDelay, startTimeOffset, endTimeOffset) 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. --- [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/revisions/fe8fd32c9fdc/schema)