--- title: "Search OIAnalytics commands" method: GET path: "/api/oianalytics/commands/search" tags: ["OIAnalytics Commands"] --- # Search OIAnalytics commands `GET /api/oianalytics/commands/search` Searches OIAnalytics commands with optional filtering by type, status, and time range. ## Query parameters - `types` string, required - `status` string, required - `start` string, required — Represents an instant in time as an ISO 8601 string. - `end` string, required — Represents an instant in time as an ISO 8601 string. - `ack` boolean, required - `page` number, double ## Response `200` Paginated list of commands - PageOIBusCommandDTO — Represents a paginated response containing an array of elements. - `content` OIBusCommandDTO[], required — The content of the page - an array of elements. - union — Union type representing all possible OIBus command DTOs. - OIBusUpdateVersionCommandDTO — Command DTO for updating the OIBus version. - `id` string, required — The unique identifier of the command. - `type` 'update-version', required — The type of the command. - `status` 'RETRIEVED' | 'RUNNING' | 'ERRORED' | 'CANCELLED' | 'COMPLETED', required — Type representing an OIBus command status. - `ack` boolean, required — Whether the command has been acknowledged. - `retrievedDate` string, required — Represents an instant in time as an ISO 8601 string. - `completedDate` string, required — Represents an instant in time as an ISO 8601 string. - `result` string, nullable, required — The result of the command execution. - `commandContent` object, required — The content of the command, including version details and update options. - `backupFolders` string, required — The folders to back up before updating. - `updateLauncher` boolean, required — Whether to update the launcher. - `assetId` string, required — The asset ID for the update. - `version` string, required — The version to update to. - OIBusRegenerateCipherKeysCommandDTO — Command DTO for regenerating cipher keys. - `id` string, required — The unique identifier of the command. - `type` 'regenerate-cipher-keys', required — The type of the command. - `status` 'RETRIEVED' | 'RUNNING' | 'ERRORED' | 'CANCELLED' | 'COMPLETED', required — Type representing an OIBus command status. - `ack` boolean, required — Whether the command has been acknowledged. - `retrievedDate` string, required — Represents an instant in time as an ISO 8601 string. - `completedDate` string, required — Represents an instant in time as an ISO 8601 string. - `result` string, nullable, required — The result of the command execution. - `targetVersion` string, required — The target version for the command. - OIBusRestartEngineCommandDTO — Command DTO for restarting the engine. - `id` string, required — The unique identifier of the command. - `type` 'restart-engine', required — The type of the command. - `status` 'RETRIEVED' | 'RUNNING' | 'ERRORED' | 'CANCELLED' | 'COMPLETED', required — Type representing an OIBus command status. - `ack` boolean, required — Whether the command has been acknowledged. - `retrievedDate` string, required — Represents an instant in time as an ISO 8601 string. - `completedDate` string, required — Represents an instant in time as an ISO 8601 string. - `result` string, nullable, required — The result of the command execution. - `targetVersion` string, required — The target version for the command. - OIBusUpdateEngineGeneralCommandDTO — Command DTO for updating only the engine's general settings (name). - `id` string, required — The unique identifier of the command. - `type` 'update-engine-general', required — The type of the command. - `status` 'RETRIEVED' | 'RUNNING' | 'ERRORED' | 'CANCELLED' | 'COMPLETED', required — Type representing an OIBus command status. - `ack` boolean, required — Whether the command has been acknowledged. - `retrievedDate` string, required — Represents an instant in time as an ISO 8601 string. - `completedDate` string, required — Represents an instant in time as an ISO 8601 string. - `result` string, nullable, required — The result of the command execution. - `targetVersion` string, required — The target version for the command. - `commandContent` EngineNameCommandDTO, required — Engine name command Data Transfer Object. Used as the request body for updating only the engine name. - `name` string, required — The name of the engine. - OIBusUpdateEngineWebServerCommandDTO — Command DTO for updating only the web server settings. - `id` string, required — The unique identifier of the command. - `type` 'update-engine-web-server', required — The type of the command. - `status` 'RETRIEVED' | 'RUNNING' | 'ERRORED' | 'CANCELLED' | 'COMPLETED', required — Type representing an OIBus command status. - `ack` boolean, required — Whether the command has been acknowledged. - `retrievedDate` string, required — Represents an instant in time as an ISO 8601 string. - `completedDate` string, required — Represents an instant in time as an ISO 8601 string. - `result` string, nullable, required — The result of the command execution. - `targetVersion` string, required — The target version for the command. - `commandContent` EngineWebServerCommandDTO, required — Engine web server command Data Transfer Object. Used as the request body for updating only the web server port and authentication token duration. - `port` number, double, required — The port on which the engine listens. - `authTokenDuration` '1h' | '1d' | '6h' | '3d' | '7d' | '14d' | '30d', required — Type representing an allowed authentication token duration. - OIBusUpdateEngineProxyCommandDTO — Command DTO for updating only the proxy settings. - `id` string, required — The unique identifier of the command. - `type` 'update-engine-proxy', required — The type of the command. - `status` 'RETRIEVED' | 'RUNNING' | 'ERRORED' | 'CANCELLED' | 'COMPLETED', required — Type representing an OIBus command status. - `ack` boolean, required — Whether the command has been acknowledged. - `retrievedDate` string, required — Represents an instant in time as an ISO 8601 string. - `completedDate` string, required — Represents an instant in time as an ISO 8601 string. - `result` string, nullable, required — The result of the command execution. - `targetVersion` string, required — The target version for the command. - `commandContent` EngineProxyCommandDTO, required — Engine proxy command Data Transfer Object. Used as the request body for updating only the proxy settings. - `enabled` boolean, required — Whether the proxy is enabled. - `port` number, double, nullable — The port for the proxy, if enabled. - `username` string, nullable — The username for proxy server authentication. - `password` string, nullable — The password for proxy server authentication. - `forward` object — Upstream forward proxy settings. - `password` string, nullable — The password for upstream proxy authentication. - `username` string, nullable — The username for upstream proxy authentication. - `url` string, nullable — The URL of the upstream proxy to forward requests through. - `enabled` boolean, required — Whether forwarding to an upstream proxy is enabled. - OIBusUpdateEngineLoggerCommandDTO — Command DTO for updating only the logging parameters. - `id` string, required — The unique identifier of the command. - `type` 'update-engine-logger', required — The type of the command. - `status` 'RETRIEVED' | 'RUNNING' | 'ERRORED' | 'CANCELLED' | 'COMPLETED', required — Type representing an OIBus command status. - `ack` boolean, required — Whether the command has been acknowledged. - `retrievedDate` string, required — Represents an instant in time as an ISO 8601 string. - `completedDate` string, required — Represents an instant in time as an ISO 8601 string. - `result` string, nullable, required — The result of the command execution. - `targetVersion` string, required — The target version for the command. - `commandContent` EngineLoggerCommandDTO, required — Engine logger command Data Transfer Object. Used as the request body for updating only the logging parameters. The log category objects are top-level (no wrapper key). - `console` object, required — Console logging configuration. - `level` 'silent' | 'error' | 'warn' | 'info' | 'debug' | 'trace', required — Type representing a log level. - `file` object, required — File logging configuration. - `numberOfFiles` number, double — The number of log files to keep. - `maxFileSize` number, double — The maximum size of a log file in bytes. - `level` 'silent' | 'error' | 'warn' | 'info' | 'debug' | 'trace', required — Type representing a log level. - `database` object, required — Database logging configuration. - `maxNumberOfLogs` number, double — The maximum number of logs to keep in the database. - `level` 'silent' | 'error' | 'warn' | 'info' | 'debug' | 'trace', required — Type representing a log level. - `loki` object, required — Loki logging configuration. - `password` string — The password for Loki authentication. - `username` string — The username for Loki authentication. - `address` string — The address of the Loki server. - `interval` number, double — The interval in seconds for sending logs to Loki. - `level` 'silent' | 'error' | 'warn' | 'info' | 'debug' | 'trace', required — Type representing a log level. - `oia` object, required — OIA logging configuration. - `interval` number, double — The interval in seconds for sending logs to OIA. - `level` 'silent' | 'error' | 'warn' | 'info' | 'debug' | 'trace', required — Type representing a log level. - `syslog` object, required — Syslog logging configuration. - `protocol` 'udp4' | 'tcp' — The transport protocol. - `port` number, double — The port of the syslog server. - `host` string — The hostname or IP of the syslog server. Empty string disables the transport. - `level` 'silent' | 'error' | 'warn' | 'info' | 'debug' | 'trace', required — Type representing a log level. - OIBusUpdateRegistrationSettingsCommandDTO — Command DTO for updating registration settings. - `id` string, required — The unique identifier of the command. - `type` 'update-registration-settings', required — The type of the command. - `status` 'RETRIEVED' | 'RUNNING' | 'ERRORED' | 'CANCELLED' | 'COMPLETED', required — Type representing an OIBus command status. - `ack` boolean, required — Whether the command has been acknowledged. - `retrievedDate` string, required — Represents an instant in time as an ISO 8601 string. - `completedDate` string, required — Represents an instant in time as an ISO 8601 string. - `result` string, nullable, required — The result of the command execution. - `targetVersion` string, required — The target version for the command. - `commandContent` object, required — The content of the command, including registration settings. - `messageRetryInterval` number, double, required — The interval in seconds for retrying messages. - `commandRetryInterval` number, double, required — The interval in seconds for retrying commands. - `commandRefreshInterval` number, double, required — The interval in seconds for refreshing commands. - OIBusCreateScanModeCommandDTO — Command DTO for creating a scan mode. - `id` string, required — The unique identifier of the command. - `type` 'create-scan-mode', required — The type of the command. - `status` 'RETRIEVED' | 'RUNNING' | 'ERRORED' | 'CANCELLED' | 'COMPLETED', required — Type representing an OIBus command status. - `ack` boolean, required — Whether the command has been acknowledged. - `retrievedDate` string, required — Represents an instant in time as an ISO 8601 string. - `completedDate` string, required — Represents an instant in time as an ISO 8601 string. - `result` string, nullable, required — The result of the command execution. - `targetVersion` string, required — The target version for the command. - `commandContent` ScanModeCommandDTO, required — Command DTO for creating or updating a scan mode. Used as the request body for scan mode creation/update endpoints. - `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. - OIBusUpdateScanModeCommandDTO — Command DTO for updating a scan mode. - `id` string, required — The unique identifier of the command. - `type` 'update-scan-mode', required — The type of the command. - `status` 'RETRIEVED' | 'RUNNING' | 'ERRORED' | 'CANCELLED' | 'COMPLETED', required — Type representing an OIBus command status. - `ack` boolean, required — Whether the command has been acknowledged. - `retrievedDate` string, required — Represents an instant in time as an ISO 8601 string. - `completedDate` string, required — Represents an instant in time as an ISO 8601 string. - `result` string, nullable, required — The result of the command execution. - `targetVersion` string, required — The target version for the command. - `scanModeId` string, required — The ID of the scan mode to update. - `commandContent` ScanModeCommandDTO, required — Command DTO for creating or updating a scan mode. Used as the request body for scan mode creation/update endpoints. - `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. - OIBusDeleteScanModeCommandDTO — Command DTO for deleting a scan mode. - `id` string, required — The unique identifier of the command. - `type` 'delete-scan-mode', required — The type of the command. - `status` 'RETRIEVED' | 'RUNNING' | 'ERRORED' | 'CANCELLED' | 'COMPLETED', required — Type representing an OIBus command status. - `ack` boolean, required — Whether the command has been acknowledged. - `retrievedDate` string, required — Represents an instant in time as an ISO 8601 string. - `completedDate` string, required — Represents an instant in time as an ISO 8601 string. - `result` string, nullable, required — The result of the command execution. - `targetVersion` string, required — The target version for the command. - `scanModeId` string, required — The ID of the scan mode to delete. - OIBusCreateIPFilterCommandDTO — Command DTO for creating an IP filter. - `id` string, required — The unique identifier of the command. - `type` 'create-ip-filter', required — The type of the command. - `status` 'RETRIEVED' | 'RUNNING' | 'ERRORED' | 'CANCELLED' | 'COMPLETED', required — Type representing an OIBus command status. - `ack` boolean, required — Whether the command has been acknowledged. - `retrievedDate` string, required — Represents an instant in time as an ISO 8601 string. - `completedDate` string, required — Represents an instant in time as an ISO 8601 string. - `result` string, nullable, required — The result of the command execution. - `targetVersion` string, required — The target version for the command. - `commandContent` IPFilterCommandDTO, required — Command DTO for creating or updating an IP filter. Used as the request body for IP filter creation/update endpoints. - `address` string, required — A regex pattern matched against the remote client's IP address. A plain IP address (e.g. `192.168.1.1`) is treated as a literal pattern. Use `*` to allow all addresses, or a regex prefix like `192\.168\.` to allow an entire subnet. Both IPv4 and IPv6 addresses (including IPv4-mapped IPv6) are supported. - `description` string, required — A description of the purpose or reason for this IP filter. - OIBusUpdateIPFilterCommandDTO — Command DTO for updating an IP filter. - `id` string, required — The unique identifier of the command. - `type` 'update-ip-filter', required — The type of the command. - `status` 'RETRIEVED' | 'RUNNING' | 'ERRORED' | 'CANCELLED' | 'COMPLETED', required — Type representing an OIBus command status. - `ack` boolean, required — Whether the command has been acknowledged. - `retrievedDate` string, required — Represents an instant in time as an ISO 8601 string. - `completedDate` string, required — Represents an instant in time as an ISO 8601 string. - `result` string, nullable, required — The result of the command execution. - `targetVersion` string, required — The target version for the command. - `ipFilterId` string, required — The ID of the IP filter to update. - `commandContent` IPFilterCommandDTO, required — Command DTO for creating or updating an IP filter. Used as the request body for IP filter creation/update endpoints. - `address` string, required — A regex pattern matched against the remote client's IP address. A plain IP address (e.g. `192.168.1.1`) is treated as a literal pattern. Use `*` to allow all addresses, or a regex prefix like `192\.168\.` to allow an entire subnet. Both IPv4 and IPv6 addresses (including IPv4-mapped IPv6) are supported. - `description` string, required — A description of the purpose or reason for this IP filter. - OIBusDeleteIPFilterCommandDTO — Command DTO for deleting an IP filter. - `id` string, required — The unique identifier of the command. - `type` 'delete-ip-filter', required — The type of the command. - `status` 'RETRIEVED' | 'RUNNING' | 'ERRORED' | 'CANCELLED' | 'COMPLETED', required — Type representing an OIBus command status. - `ack` boolean, required — Whether the command has been acknowledged. - `retrievedDate` string, required — Represents an instant in time as an ISO 8601 string. - `completedDate` string, required — Represents an instant in time as an ISO 8601 string. - `result` string, nullable, required — The result of the command execution. - `targetVersion` string, required — The target version for the command. - `ipFilterId` string, required — The ID of the IP filter to delete. - OIBusCreateCertificateCommandDTO — Command DTO for creating a certificate. - `id` string, required — The unique identifier of the command. - `type` 'create-certificate', required — The type of the command. - `status` 'RETRIEVED' | 'RUNNING' | 'ERRORED' | 'CANCELLED' | 'COMPLETED', required — Type representing an OIBus command status. - `ack` boolean, required — Whether the command has been acknowledged. - `retrievedDate` string, required — Represents an instant in time as an ISO 8601 string. - `completedDate` string, required — Represents an instant in time as an ISO 8601 string. - `result` string, nullable, required — The result of the command execution. - `targetVersion` string, required — The target version for the command. - `commandContent` CertificateCommandDTO, required — Command DTO for creating or updating a certificate. Used as the request body for certificate creation/update endpoints. - `name` string, required — The name of the certificate. - `description` string, required — A description of the certificate's purpose or usage. - `regenerateCertificate` boolean, required — Whether to regenerate the certificate. - `options` CertificateOptions, required — Options for generating a certificate. Used to specify details for certificate generation. - `commonName` string, required — The common name (e.g., domain name) for the certificate. - `countryName` string, required — The country name for the certificate. - `stateOrProvinceName` string, required — The state or province name for the certificate. - `localityName` string, required — The locality (e.g., city) name for the certificate. - `organizationName` string, required — The organization name for the certificate. - `keySize` number, double, required — The key size in bits for the certificate. - `daysBeforeExpiry` number, double, required — The number of days before the certificate expires. - OIBusUpdateCertificateCommandDTO — Command DTO for updating a certificate. - `id` string, required — The unique identifier of the command. - `type` 'update-certificate', required — The type of the command. - `status` 'RETRIEVED' | 'RUNNING' | 'ERRORED' | 'CANCELLED' | 'COMPLETED', required — Type representing an OIBus command status. - `ack` boolean, required — Whether the command has been acknowledged. - `retrievedDate` string, required — Represents an instant in time as an ISO 8601 string. - `completedDate` string, required — Represents an instant in time as an ISO 8601 string. - `result` string, nullable, required — The result of the command execution. - `targetVersion` string, required — The target version for the command. - `certificateId` string, required — The ID of the certificate to update. - `commandContent` CertificateCommandDTO, required — Command DTO for creating or updating a certificate. Used as the request body for certificate creation/update endpoints. - `name` string, required — The name of the certificate. - `description` string, required — A description of the certificate's purpose or usage. - `regenerateCertificate` boolean, required — Whether to regenerate the certificate. - `options` CertificateOptions, required — Options for generating a certificate. Used to specify details for certificate generation. - `commonName` string, required — The common name (e.g., domain name) for the certificate. - `countryName` string, required — The country name for the certificate. - `stateOrProvinceName` string, required — The state or province name for the certificate. - `localityName` string, required — The locality (e.g., city) name for the certificate. - `organizationName` string, required — The organization name for the certificate. - `keySize` number, double, required — The key size in bits for the certificate. - `daysBeforeExpiry` number, double, required — The number of days before the certificate expires. - OIBusDeleteCertificateCommandDTO — Command DTO for deleting a certificate. - `id` string, required — The unique identifier of the command. - `type` 'delete-certificate', required — The type of the command. - `status` 'RETRIEVED' | 'RUNNING' | 'ERRORED' | 'CANCELLED' | 'COMPLETED', required — Type representing an OIBus command status. - `ack` boolean, required — Whether the command has been acknowledged. - `retrievedDate` string, required — Represents an instant in time as an ISO 8601 string. - `completedDate` string, required — Represents an instant in time as an ISO 8601 string. - `result` string, nullable, required — The result of the command execution. - `targetVersion` string, required — The target version for the command. - `certificateId` string, required — The ID of the certificate to delete. - OIBusCreateSouthConnectorCommandDTO — Command DTO for creating a south connector. - `id` string, required — The unique identifier of the command. - `type` 'create-south', required — The type of the command. - `status` 'RETRIEVED' | 'RUNNING' | 'ERRORED' | 'CANCELLED' | 'COMPLETED', required — Type representing an OIBus command status. - `ack` boolean, required — Whether the command has been acknowledged. - `retrievedDate` string, required — Represents an instant in time as an ISO 8601 string. - `completedDate` string, required — Represents an instant in time as an ISO 8601 string. - `result` string, nullable, required — The result of the command execution. - `targetVersion` string, required — The target version for the command. - `commandContent` union, required — Command Data Transfer Object for creating or updating a South connector. Used as the request body for South connector creation/update endpoints. - SouthConnectorADSCommandDTO — South connector command for Beckhoff ADS. - `name` string, required — The name of the South connector. - `type` 'ads', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthADSSettings, required - … - `items` SouthConnectorADSItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - SouthConnectorFolderScannerCommandDTO — South connector command for the Folder Scanner. - `name` string, required — The name of the South connector. - `type` 'folder-scanner', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthFolderScannerSettings, required - … - `items` SouthConnectorFolderScannerItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - SouthConnectorFTPCommandDTO — South connector command for FTP file transfer. - `name` string, required — The name of the South connector. - `type` 'ftp', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthFTPSettings, required - … - `items` SouthConnectorFTPItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - SouthConnectorInfluxDBCommandDTO — South connector command for InfluxDB time series database. - `name` string, required — The name of the South connector. - `type` 'influxdb', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthInfluxDBSettings, required - … - `items` SouthConnectorInfluxDBItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - SouthConnectorModbusCommandDTO — South connector command for Modbus. - `name` string, required — The name of the South connector. - `type` 'modbus', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthModbusSettings, required - … - `items` SouthConnectorModbusItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - SouthConnectorMQTTCommandDTO — South connector command for MQTT. - `name` string, required — The name of the South connector. - `type` 'mqtt', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthMQTTSettings, required - … - `items` SouthConnectorMQTTItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - SouthConnectorMSSQLCommandDTO — South connector command for Microsoft SQL Server. - `name` string, required — The name of the South connector. - `type` 'mssql', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthMSSQLSettings, required - … - `items` SouthConnectorMSSQLItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - SouthConnectorMySQLCommandDTO — South connector command for MySQL. - `name` string, required — The name of the South connector. - `type` 'mysql', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthMySQLSettings, required - … - `items` SouthConnectorMySQLItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - SouthConnectorODBCCommandDTO — South connector command for ODBC. - `name` string, required — The name of the South connector. - `type` 'odbc', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthODBCSettings, required - … - `items` SouthConnectorODBCItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - SouthConnectorOIAnalyticsCommandDTO — South connector command for OIAnalytics. - `name` string, required — The name of the South connector. - `type` 'oianalytics', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthOIAnalyticsSettings, required - … - `items` SouthConnectorOIAnalyticsItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - SouthConnectorOLEDBCommandDTO — South connector command for OLE DB. - `name` string, required — The name of the South connector. - `type` 'oledb', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthOLEDBSettings, required - … - `items` SouthConnectorOLEDBItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - SouthConnectorOPCCommandDTO — South connector command for classic OPC (OLE for Process Control). - `name` string, required — The name of the South connector. - `type` 'opc', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthOPCSettings, required - … - `items` SouthConnectorOPCItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - SouthConnectorOPCUACommandDTO — South connector command for OPC UA. - `name` string, required — The name of the South connector. - `type` 'opcua', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthOPCUASettings, required - … - `items` SouthConnectorOPCUAItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - SouthConnectorOracleCommandDTO — South connector command for Oracle Database. - `name` string, required — The name of the South connector. - `type` 'oracle', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthOracleSettings, required - … - `items` SouthConnectorOracleItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - SouthConnectorOsisoftPICommandDTO — South connector command for OSIsoft PI System. - `name` string, required — The name of the South connector. - `type` 'osisoft-pi', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthPISettings, required - … - `items` SouthConnectorOsisoftPIItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - SouthConnectorPostgreSQLCommandDTO — South connector command for PostgreSQL. - `name` string, required — The name of the South connector. - `type` 'postgresql', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthPostgreSQLSettings, required - … - `items` SouthConnectorPostgreSQLItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - SouthConnectorRESTCommandDTO — South connector command for the REST API. - `name` string, required — The name of the South connector. - `type` 'rest', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthRestSettings, required - … - `items` SouthConnectorRESTItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - SouthConnectorSFTPCommandDTO — South connector command for SFTP file transfer. - `name` string, required — The name of the South connector. - `type` 'sftp', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthSFTPSettings, required - … - `items` SouthConnectorSFTPItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - SouthConnectorSQLiteCommandDTO — South connector command for SQLite. - `name` string, required — The name of the South connector. - `type` 'sqlite', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthSQLiteSettings, required - … - `items` SouthConnectorSQLiteItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - OIBusUpdateSouthConnectorCommandDTO — Command DTO for updating a south connector. - `id` string, required — The unique identifier of the command. - `type` 'update-south', required — The type of the command. - `status` 'RETRIEVED' | 'RUNNING' | 'ERRORED' | 'CANCELLED' | 'COMPLETED', required — Type representing an OIBus command status. - `ack` boolean, required — Whether the command has been acknowledged. - `retrievedDate` string, required — Represents an instant in time as an ISO 8601 string. - `completedDate` string, required — Represents an instant in time as an ISO 8601 string. - `result` string, nullable, required — The result of the command execution. - `targetVersion` string, required — The target version for the command. - `southConnectorId` string, required — The ID of the south connector to update. - `commandContent` union, required — Command Data Transfer Object for creating or updating a South connector. Used as the request body for South connector creation/update endpoints. - SouthConnectorADSCommandDTO — South connector command for Beckhoff ADS. - `name` string, required — The name of the South connector. - `type` 'ads', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthADSSettings, required - … - `items` SouthConnectorADSItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - SouthConnectorFolderScannerCommandDTO — South connector command for the Folder Scanner. - `name` string, required — The name of the South connector. - `type` 'folder-scanner', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthFolderScannerSettings, required - … - `items` SouthConnectorFolderScannerItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - SouthConnectorFTPCommandDTO — South connector command for FTP file transfer. - `name` string, required — The name of the South connector. - `type` 'ftp', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthFTPSettings, required - … - `items` SouthConnectorFTPItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - SouthConnectorInfluxDBCommandDTO — South connector command for InfluxDB time series database. - `name` string, required — The name of the South connector. - `type` 'influxdb', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthInfluxDBSettings, required - … - `items` SouthConnectorInfluxDBItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - SouthConnectorModbusCommandDTO — South connector command for Modbus. - `name` string, required — The name of the South connector. - `type` 'modbus', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthModbusSettings, required - … - `items` SouthConnectorModbusItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - SouthConnectorMQTTCommandDTO — South connector command for MQTT. - `name` string, required — The name of the South connector. - `type` 'mqtt', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthMQTTSettings, required - … - `items` SouthConnectorMQTTItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - SouthConnectorMSSQLCommandDTO — South connector command for Microsoft SQL Server. - `name` string, required — The name of the South connector. - `type` 'mssql', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthMSSQLSettings, required - … - `items` SouthConnectorMSSQLItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - SouthConnectorMySQLCommandDTO — South connector command for MySQL. - `name` string, required — The name of the South connector. - `type` 'mysql', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthMySQLSettings, required - … - `items` SouthConnectorMySQLItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - SouthConnectorODBCCommandDTO — South connector command for ODBC. - `name` string, required — The name of the South connector. - `type` 'odbc', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthODBCSettings, required - … - `items` SouthConnectorODBCItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - SouthConnectorOIAnalyticsCommandDTO — South connector command for OIAnalytics. - `name` string, required — The name of the South connector. - `type` 'oianalytics', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthOIAnalyticsSettings, required - … - `items` SouthConnectorOIAnalyticsItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - SouthConnectorOLEDBCommandDTO — South connector command for OLE DB. - `name` string, required — The name of the South connector. - `type` 'oledb', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthOLEDBSettings, required - … - `items` SouthConnectorOLEDBItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - SouthConnectorOPCCommandDTO — South connector command for classic OPC (OLE for Process Control). - `name` string, required — The name of the South connector. - `type` 'opc', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthOPCSettings, required - … - `items` SouthConnectorOPCItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - SouthConnectorOPCUACommandDTO — South connector command for OPC UA. - `name` string, required — The name of the South connector. - `type` 'opcua', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthOPCUASettings, required - … - `items` SouthConnectorOPCUAItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - SouthConnectorOracleCommandDTO — South connector command for Oracle Database. - `name` string, required — The name of the South connector. - `type` 'oracle', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthOracleSettings, required - … - `items` SouthConnectorOracleItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - SouthConnectorOsisoftPICommandDTO — South connector command for OSIsoft PI System. - `name` string, required — The name of the South connector. - `type` 'osisoft-pi', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthPISettings, required - … - `items` SouthConnectorOsisoftPIItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - SouthConnectorPostgreSQLCommandDTO — South connector command for PostgreSQL. - `name` string, required — The name of the South connector. - `type` 'postgresql', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthPostgreSQLSettings, required - … - `items` SouthConnectorPostgreSQLItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - SouthConnectorRESTCommandDTO — South connector command for the REST API. - `name` string, required — The name of the South connector. - `type` 'rest', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthRestSettings, required - … - `items` SouthConnectorRESTItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - SouthConnectorSFTPCommandDTO — South connector command for SFTP file transfer. - `name` string, required — The name of the South connector. - `type` 'sftp', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthSFTPSettings, required - … - `items` SouthConnectorSFTPItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - SouthConnectorSQLiteCommandDTO — South connector command for SQLite. - `name` string, required — The name of the South connector. - `type` 'sqlite', required — The type of the South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector should be enabled. - `settings` SouthSQLiteSettings, required - … - `items` SouthConnectorSQLiteItemCommandDTO[], required — List of items (data points) to configure for this connector. - … - `groups` SouthItemGroupCommandDTO[], required — List of groups used to gather items - … - OIBusDeleteSouthConnectorCommandDTO — Command DTO for deleting a south connector. - `id` string, required — The unique identifier of the command. - `type` 'delete-south', required — The type of the command. - `status` 'RETRIEVED' | 'RUNNING' | 'ERRORED' | 'CANCELLED' | 'COMPLETED', required — Type representing an OIBus command status. - `ack` boolean, required — Whether the command has been acknowledged. - `retrievedDate` string, required — Represents an instant in time as an ISO 8601 string. - `completedDate` string, required — Represents an instant in time as an ISO 8601 string. - `result` string, nullable, required — The result of the command execution. - `targetVersion` string, required — The target version for the command. - `southConnectorId` string, required — The ID of the south connector to delete. - OIBusTestSouthConnectorCommandDTO — Command DTO for testing a south connector connection. - `id` string, required — The unique identifier of the command. - `type` 'test-south-connection', required — The type of the command. - `status` 'RETRIEVED' | 'RUNNING' | 'ERRORED' | 'CANCELLED' | 'COMPLETED', required — Type representing an OIBus command status. - `ack` boolean, required — Whether the command has been acknowledged. - `retrievedDate` string, required — Represents an instant in time as an ISO 8601 string. - `completedDate` string, required — Represents an instant in time as an ISO 8601 string. - `result` string, nullable, required — The result of the command execution. - `targetVersion` string, required — The target version for the command. - `southConnectorId` string, required — The ID of the south connector to test. - OIBusTestSouthConnectorItemCommandDTO — Command DTO for testing a south connector item. - `id` string, required — The unique identifier of the command. - `type` 'test-south-item', required — The type of the command. - `status` 'RETRIEVED' | 'RUNNING' | 'ERRORED' | 'CANCELLED' | 'COMPLETED', required — Type representing an OIBus command status. - `ack` boolean, required — Whether the command has been acknowledged. - `retrievedDate` string, required — Represents an instant in time as an ISO 8601 string. - `completedDate` string, required — Represents an instant in time as an ISO 8601 string. - `result` string, nullable, required — The result of the command execution. - `targetVersion` string, required — The target version for the command. - `southConnectorId` string, required — The ID of the south connector. - `itemId` string, required — The ID of the item to test. - OIBusCreateNorthConnectorCommandDTO — Command DTO for creating a north connector. - `id` string, required — The unique identifier of the command. - `type` 'create-north', required — The type of the command. - `status` 'RETRIEVED' | 'RUNNING' | 'ERRORED' | 'CANCELLED' | 'COMPLETED', required — Type representing an OIBus command status. - `ack` boolean, required — Whether the command has been acknowledged. - `retrievedDate` string, required — Represents an instant in time as an ISO 8601 string. - `completedDate` string, required — Represents an instant in time as an ISO 8601 string. - `result` string, nullable, required — The result of the command execution. - `targetVersion` string, required — The target version for the command. - `commandContent` union, required — Command Data Transfer Object for creating or updating a North connector. Used as the request body for North connector creation/update endpoints. - NorthConnectorAmazonS3CommandDTO — North connector command for Amazon S3. - `name` string, required — The name of the North connector. - `type` 'aws-s3', required — The type of the North connector. - `description` string, required — The description of the North connector. - `enabled` boolean, required — Whether the North connector is enabled. - `settings` NorthAmazonS3Settings, required - … - `caching` object, required — The caching configuration for the North connector. - … - `transformers` TransformerCommandDTOWithOptions[], required — The list of transformers to apply to the data. - … - NorthConnectorAzureBlobCommandDTO — North connector command for Azure Blob Storage. - `name` string, required — The name of the North connector. - `type` 'azure-blob', required — The type of the North connector. - `description` string, required — The description of the North connector. - `enabled` boolean, required — Whether the North connector is enabled. - `settings` NorthAzureBlobSettings, required - … - `caching` object, required — The caching configuration for the North connector. - … - `transformers` TransformerCommandDTOWithOptions[], required — The list of transformers to apply to the data. - … - NorthConnectorConsoleCommandDTO — North connector command for the Console debug output. - `name` string, required — The name of the North connector. - `type` 'console', required — The type of the North connector. - `description` string, required — The description of the North connector. - `enabled` boolean, required — Whether the North connector is enabled. - `settings` NorthConsoleSettings, required - … - `caching` object, required — The caching configuration for the North connector. - … - `transformers` TransformerCommandDTOWithOptions[], required — The list of transformers to apply to the data. - … - NorthConnectorFileWriterCommandDTO — North connector command for the File Writer. - `name` string, required — The name of the North connector. - `type` 'file-writer', required — The type of the North connector. - `description` string, required — The description of the North connector. - `enabled` boolean, required — Whether the North connector is enabled. - `settings` NorthFileWriterSettings, required - … - `caching` object, required — The caching configuration for the North connector. - … - `transformers` TransformerCommandDTOWithOptions[], required — The list of transformers to apply to the data. - … - NorthConnectorModbusCommandDTO — North connector command for Modbus. - `name` string, required — The name of the North connector. - `type` 'modbus', required — The type of the North connector. - `description` string, required — The description of the North connector. - `enabled` boolean, required — Whether the North connector is enabled. - `settings` NorthModbusSettings, required - … - `caching` object, required — The caching configuration for the North connector. - … - `transformers` TransformerCommandDTOWithOptions[], required — The list of transformers to apply to the data. - … - NorthConnectorMQTTCommandDTO — North connector command for MQTT. - `name` string, required — The name of the North connector. - `type` 'mqtt', required — The type of the North connector. - `description` string, required — The description of the North connector. - `enabled` boolean, required — Whether the North connector is enabled. - `settings` NorthMQTTSettings, required - … - `caching` object, required — The caching configuration for the North connector. - … - `transformers` TransformerCommandDTOWithOptions[], required — The list of transformers to apply to the data. - … - NorthConnectorOIAnalyticsCommandDTO — North connector command for OIAnalytics. - `name` string, required — The name of the North connector. - `type` 'oianalytics', required — The type of the North connector. - `description` string, required — The description of the North connector. - `enabled` boolean, required — Whether the North connector is enabled. - `settings` NorthOIAnalyticsSettings, required - … - `caching` object, required — The caching configuration for the North connector. - … - `transformers` TransformerCommandDTOWithOptions[], required — The list of transformers to apply to the data. - … - NorthConnectorOPCUACommandDTO — North connector command for OPC UA. - `name` string, required — The name of the North connector. - `type` 'opcua', required — The type of the North connector. - `description` string, required — The description of the North connector. - `enabled` boolean, required — Whether the North connector is enabled. - `settings` NorthOPCUASettings, required - … - `caching` object, required — The caching configuration for the North connector. - … - `transformers` TransformerCommandDTOWithOptions[], required — The list of transformers to apply to the data. - … - NorthConnectorRESTCommandDTO — North connector command for the REST API. - `name` string, required — The name of the North connector. - `type` 'rest', required — The type of the North connector. - `description` string, required — The description of the North connector. - `enabled` boolean, required — Whether the North connector is enabled. - `settings` NorthRESTSettings, required - … - `caching` object, required — The caching configuration for the North connector. - … - `transformers` TransformerCommandDTOWithOptions[], required — The list of transformers to apply to the data. - … - NorthConnectorSFTPCommandDTO — North connector command for SFTP file transfer. - `name` string, required — The name of the North connector. - `type` 'sftp', required — The type of the North connector. - `description` string, required — The description of the North connector. - `enabled` boolean, required — Whether the North connector is enabled. - `settings` NorthSFTPSettings, required - … - `caching` object, required — The caching configuration for the North connector. - … - `transformers` TransformerCommandDTOWithOptions[], required — The list of transformers to apply to the data. - … - OIBusUpdateNorthConnectorCommandDTO — Command DTO for updating a north connector. - `id` string, required — The unique identifier of the command. - `type` 'update-north', required — The type of the command. - `status` 'RETRIEVED' | 'RUNNING' | 'ERRORED' | 'CANCELLED' | 'COMPLETED', required — Type representing an OIBus command status. - `ack` boolean, required — Whether the command has been acknowledged. - `retrievedDate` string, required — Represents an instant in time as an ISO 8601 string. - `completedDate` string, required — Represents an instant in time as an ISO 8601 string. - `result` string, nullable, required — The result of the command execution. - `targetVersion` string, required — The target version for the command. - `northConnectorId` string, required — The ID of the north connector to update. - `commandContent` union, required — Command Data Transfer Object for creating or updating a North connector. Used as the request body for North connector creation/update endpoints. - NorthConnectorAmazonS3CommandDTO — North connector command for Amazon S3. - `name` string, required — The name of the North connector. - `type` 'aws-s3', required — The type of the North connector. - `description` string, required — The description of the North connector. - `enabled` boolean, required — Whether the North connector is enabled. - `settings` NorthAmazonS3Settings, required - … - `caching` object, required — The caching configuration for the North connector. - … - `transformers` TransformerCommandDTOWithOptions[], required — The list of transformers to apply to the data. - … - NorthConnectorAzureBlobCommandDTO — North connector command for Azure Blob Storage. - `name` string, required — The name of the North connector. - `type` 'azure-blob', required — The type of the North connector. - `description` string, required — The description of the North connector. - `enabled` boolean, required — Whether the North connector is enabled. - `settings` NorthAzureBlobSettings, required - … - `caching` object, required — The caching configuration for the North connector. - … - `transformers` TransformerCommandDTOWithOptions[], required — The list of transformers to apply to the data. - … - NorthConnectorConsoleCommandDTO — North connector command for the Console debug output. - `name` string, required — The name of the North connector. - `type` 'console', required — The type of the North connector. - `description` string, required — The description of the North connector. - `enabled` boolean, required — Whether the North connector is enabled. - `settings` NorthConsoleSettings, required - … - `caching` object, required — The caching configuration for the North connector. - … - `transformers` TransformerCommandDTOWithOptions[], required — The list of transformers to apply to the data. - … - NorthConnectorFileWriterCommandDTO — North connector command for the File Writer. - `name` string, required — The name of the North connector. - `type` 'file-writer', required — The type of the North connector. - `description` string, required — The description of the North connector. - `enabled` boolean, required — Whether the North connector is enabled. - `settings` NorthFileWriterSettings, required - … - `caching` object, required — The caching configuration for the North connector. - … - `transformers` TransformerCommandDTOWithOptions[], required — The list of transformers to apply to the data. - … - NorthConnectorModbusCommandDTO — North connector command for Modbus. - `name` string, required — The name of the North connector. - `type` 'modbus', required — The type of the North connector. - `description` string, required — The description of the North connector. - `enabled` boolean, required — Whether the North connector is enabled. - `settings` NorthModbusSettings, required - … - `caching` object, required — The caching configuration for the North connector. - … - `transformers` TransformerCommandDTOWithOptions[], required — The list of transformers to apply to the data. - … - NorthConnectorMQTTCommandDTO — North connector command for MQTT. - `name` string, required — The name of the North connector. - `type` 'mqtt', required — The type of the North connector. - `description` string, required — The description of the North connector. - `enabled` boolean, required — Whether the North connector is enabled. - `settings` NorthMQTTSettings, required - … - `caching` object, required — The caching configuration for the North connector. - … - `transformers` TransformerCommandDTOWithOptions[], required — The list of transformers to apply to the data. - … - NorthConnectorOIAnalyticsCommandDTO — North connector command for OIAnalytics. - `name` string, required — The name of the North connector. - `type` 'oianalytics', required — The type of the North connector. - `description` string, required — The description of the North connector. - `enabled` boolean, required — Whether the North connector is enabled. - `settings` NorthOIAnalyticsSettings, required - … - `caching` object, required — The caching configuration for the North connector. - … - `transformers` TransformerCommandDTOWithOptions[], required — The list of transformers to apply to the data. - … - NorthConnectorOPCUACommandDTO — North connector command for OPC UA. - `name` string, required — The name of the North connector. - `type` 'opcua', required — The type of the North connector. - `description` string, required — The description of the North connector. - `enabled` boolean, required — Whether the North connector is enabled. - `settings` NorthOPCUASettings, required - … - `caching` object, required — The caching configuration for the North connector. - … - `transformers` TransformerCommandDTOWithOptions[], required — The list of transformers to apply to the data. - … - NorthConnectorRESTCommandDTO — North connector command for the REST API. - `name` string, required — The name of the North connector. - `type` 'rest', required — The type of the North connector. - `description` string, required — The description of the North connector. - `enabled` boolean, required — Whether the North connector is enabled. - `settings` NorthRESTSettings, required - … - `caching` object, required — The caching configuration for the North connector. - … - `transformers` TransformerCommandDTOWithOptions[], required — The list of transformers to apply to the data. - … - NorthConnectorSFTPCommandDTO — North connector command for SFTP file transfer. - `name` string, required — The name of the North connector. - `type` 'sftp', required — The type of the North connector. - `description` string, required — The description of the North connector. - `enabled` boolean, required — Whether the North connector is enabled. - `settings` NorthSFTPSettings, required - … - `caching` object, required — The caching configuration for the North connector. - … - `transformers` TransformerCommandDTOWithOptions[], required — The list of transformers to apply to the data. - … - OIBusDeleteNorthConnectorCommandDTO — Command DTO for deleting a north connector. - `id` string, required — The unique identifier of the command. - `type` 'delete-north', required — The type of the command. - `status` 'RETRIEVED' | 'RUNNING' | 'ERRORED' | 'CANCELLED' | 'COMPLETED', required — Type representing an OIBus command status. - `ack` boolean, required — Whether the command has been acknowledged. - `retrievedDate` string, required — Represents an instant in time as an ISO 8601 string. - `completedDate` string, required — Represents an instant in time as an ISO 8601 string. - `result` string, nullable, required — The result of the command execution. - `targetVersion` string, required — The target version for the command. - `northConnectorId` string, required — The ID of the north connector to delete. - OIBusTestNorthConnectorCommandDTO — Command DTO for testing a north connector connection. - `id` string, required — The unique identifier of the command. - `type` 'test-north-connection', required — The type of the command. - `status` 'RETRIEVED' | 'RUNNING' | 'ERRORED' | 'CANCELLED' | 'COMPLETED', required — Type representing an OIBus command status. - `ack` boolean, required — Whether the command has been acknowledged. - `retrievedDate` string, required — Represents an instant in time as an ISO 8601 string. - `completedDate` string, required — Represents an instant in time as an ISO 8601 string. - `result` string, nullable, required — The result of the command execution. - `targetVersion` string, required — The target version for the command. - `northConnectorId` string, required — The ID of the north connector to test. - OIBusCreateOrUpdateSouthConnectorItemsFromCSVCommandDTO — Command DTO for creating or updating south connector items from CSV. - `id` string, required — The unique identifier of the command. - `type` 'create-or-update-south-items-from-csv', required — The type of the command. - `status` 'RETRIEVED' | 'RUNNING' | 'ERRORED' | 'CANCELLED' | 'COMPLETED', required — Type representing an OIBus command status. - `ack` boolean, required — Whether the command has been acknowledged. - `retrievedDate` string, required — Represents an instant in time as an ISO 8601 string. - `completedDate` string, required — Represents an instant in time as an ISO 8601 string. - `result` string, nullable, required — The result of the command execution. - `targetVersion` string, required — The target version for the command. - `southConnectorId` string, required — The ID of the south connector. - `commandContent` object, required — The content of the command, including CSV content and options. - `delimiter` string, required — The delimiter used in the CSV. - `csvContent` string, required — The CSV content to import. - `deleteItemsNotPresent` boolean, required — Whether to delete items not present in the CSV. - OIBusCreateHistoryQueryCommandDTO — Command DTO for creating a history query. - `id` string, required — The unique identifier of the command. - `type` 'create-history-query', required — The type of the command. - `status` 'RETRIEVED' | 'RUNNING' | 'ERRORED' | 'CANCELLED' | 'COMPLETED', required — Type representing an OIBus command status. - `ack` boolean, required — Whether the command has been acknowledged. - `retrievedDate` string, required — Represents an instant in time as an ISO 8601 string. - `completedDate` string, required — Represents an instant in time as an ISO 8601 string. - `result` string, nullable, required — The result of the command execution. - `targetVersion` string, required — The target version for the command. - `commandContent` union, required - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'ads', required - `southSettings` SouthADSSettings, required - … - `items` HistoryQueryADSItemCommandDTO[], required - … - `northType` 'aws-s3', required - `northSettings` NorthAmazonS3Settings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'ads', required - `southSettings` SouthADSSettings, required - … - `items` HistoryQueryADSItemCommandDTO[], required - … - `northType` 'azure-blob', required - `northSettings` NorthAzureBlobSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'ads', required - `southSettings` SouthADSSettings, required - … - `items` HistoryQueryADSItemCommandDTO[], required - … - `northType` 'console', required - `northSettings` NorthConsoleSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'ads', required - `southSettings` SouthADSSettings, required - … - `items` HistoryQueryADSItemCommandDTO[], required - … - `northType` 'file-writer', required - `northSettings` NorthFileWriterSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'ads', required - `southSettings` SouthADSSettings, required - … - `items` HistoryQueryADSItemCommandDTO[], required - … - `northType` 'modbus', required - `northSettings` NorthModbusSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'ads', required - `southSettings` SouthADSSettings, required - … - `items` HistoryQueryADSItemCommandDTO[], required - … - `northType` 'mqtt', required - `northSettings` NorthMQTTSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'ads', required - `southSettings` SouthADSSettings, required - … - `items` HistoryQueryADSItemCommandDTO[], required - … - `northType` 'oianalytics', required - `northSettings` NorthOIAnalyticsSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'ads', required - `southSettings` SouthADSSettings, required - … - `items` HistoryQueryADSItemCommandDTO[], required - … - `northType` 'opcua', required - `northSettings` NorthOPCUASettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'ads', required - `southSettings` SouthADSSettings, required - … - `items` HistoryQueryADSItemCommandDTO[], required - … - `northType` 'rest', required - `northSettings` NorthRESTSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'ads', required - `southSettings` SouthADSSettings, required - … - `items` HistoryQueryADSItemCommandDTO[], required - … - `northType` 'sftp', required - `northSettings` NorthSFTPSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'folder-scanner', required - `southSettings` SouthFolderScannerSettings, required - … - `items` HistoryQueryFolderScannerItemCommandDTO[], required - … - `northType` 'aws-s3', required - `northSettings` NorthAmazonS3Settings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'folder-scanner', required - `southSettings` SouthFolderScannerSettings, required - … - `items` HistoryQueryFolderScannerItemCommandDTO[], required - … - `northType` 'azure-blob', required - `northSettings` NorthAzureBlobSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'folder-scanner', required - `southSettings` SouthFolderScannerSettings, required - … - `items` HistoryQueryFolderScannerItemCommandDTO[], required - … - `northType` 'console', required - `northSettings` NorthConsoleSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'folder-scanner', required - `southSettings` SouthFolderScannerSettings, required - … - `items` HistoryQueryFolderScannerItemCommandDTO[], required - … - `northType` 'file-writer', required - `northSettings` NorthFileWriterSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'folder-scanner', required - `southSettings` SouthFolderScannerSettings, required - … - `items` HistoryQueryFolderScannerItemCommandDTO[], required - … - `northType` 'modbus', required - `northSettings` NorthModbusSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'folder-scanner', required - `southSettings` SouthFolderScannerSettings, required - … - `items` HistoryQueryFolderScannerItemCommandDTO[], required - … - `northType` 'mqtt', required - `northSettings` NorthMQTTSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'folder-scanner', required - `southSettings` SouthFolderScannerSettings, required - … - `items` HistoryQueryFolderScannerItemCommandDTO[], required - … - `northType` 'oianalytics', required - `northSettings` NorthOIAnalyticsSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'folder-scanner', required - `southSettings` SouthFolderScannerSettings, required - … - `items` HistoryQueryFolderScannerItemCommandDTO[], required - … - `northType` 'opcua', required - `northSettings` NorthOPCUASettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'folder-scanner', required - `southSettings` SouthFolderScannerSettings, required - … - `items` HistoryQueryFolderScannerItemCommandDTO[], required - … - `northType` 'rest', required - `northSettings` NorthRESTSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'folder-scanner', required - `southSettings` SouthFolderScannerSettings, required - … - `items` HistoryQueryFolderScannerItemCommandDTO[], required - … - `northType` 'sftp', required - `northSettings` NorthSFTPSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'ftp', required - `southSettings` SouthFTPSettings, required - … - `items` HistoryQueryFTPItemCommandDTO[], required - … - `northType` 'aws-s3', required - `northSettings` NorthAmazonS3Settings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'ftp', required - `southSettings` SouthFTPSettings, required - … - `items` HistoryQueryFTPItemCommandDTO[], required - … - `northType` 'azure-blob', required - `northSettings` NorthAzureBlobSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'ftp', required - `southSettings` SouthFTPSettings, required - … - `items` HistoryQueryFTPItemCommandDTO[], required - … - `northType` 'console', required - `northSettings` NorthConsoleSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'ftp', required - `southSettings` SouthFTPSettings, required - … - `items` HistoryQueryFTPItemCommandDTO[], required - … - `northType` 'file-writer', required - `northSettings` NorthFileWriterSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'ftp', required - `southSettings` SouthFTPSettings, required - … - `items` HistoryQueryFTPItemCommandDTO[], required - … - `northType` 'modbus', required - `northSettings` NorthModbusSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'ftp', required - `southSettings` SouthFTPSettings, required - … - `items` HistoryQueryFTPItemCommandDTO[], required - … - `northType` 'mqtt', required - `northSettings` NorthMQTTSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'ftp', required - `southSettings` SouthFTPSettings, required - … - `items` HistoryQueryFTPItemCommandDTO[], required - … - `northType` 'oianalytics', required - `northSettings` NorthOIAnalyticsSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'ftp', required - `southSettings` SouthFTPSettings, required - … - `items` HistoryQueryFTPItemCommandDTO[], required - … - `northType` 'opcua', required - `northSettings` NorthOPCUASettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'ftp', required - `southSettings` SouthFTPSettings, required - … - `items` HistoryQueryFTPItemCommandDTO[], required - … - `northType` 'rest', required - `northSettings` NorthRESTSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'ftp', required - `southSettings` SouthFTPSettings, required - … - `items` HistoryQueryFTPItemCommandDTO[], required - … - `northType` 'sftp', required - `northSettings` NorthSFTPSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'influxdb', required - `southSettings` SouthInfluxDBSettings, required - … - `items` HistoryQueryInfluxDBItemCommandDTO[], required - … - `northType` 'aws-s3', required - `northSettings` NorthAmazonS3Settings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'influxdb', required - `southSettings` SouthInfluxDBSettings, required - … - `items` HistoryQueryInfluxDBItemCommandDTO[], required - … - `northType` 'azure-blob', required - `northSettings` NorthAzureBlobSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'influxdb', required - `southSettings` SouthInfluxDBSettings, required - … - `items` HistoryQueryInfluxDBItemCommandDTO[], required - … - `northType` 'console', required - `northSettings` NorthConsoleSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'influxdb', required - `southSettings` SouthInfluxDBSettings, required - … - `items` HistoryQueryInfluxDBItemCommandDTO[], required - … - `northType` 'file-writer', required - `northSettings` NorthFileWriterSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'influxdb', required - `southSettings` SouthInfluxDBSettings, required - … - `items` HistoryQueryInfluxDBItemCommandDTO[], required - … - `northType` 'modbus', required - `northSettings` NorthModbusSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'influxdb', required - `southSettings` SouthInfluxDBSettings, required - … - `items` HistoryQueryInfluxDBItemCommandDTO[], required - … - `northType` 'mqtt', required - `northSettings` NorthMQTTSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'influxdb', required - `southSettings` SouthInfluxDBSettings, required - … - `items` HistoryQueryInfluxDBItemCommandDTO[], required - … - `northType` 'oianalytics', required - `northSettings` NorthOIAnalyticsSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'influxdb', required - `southSettings` SouthInfluxDBSettings, required - … - `items` HistoryQueryInfluxDBItemCommandDTO[], required - … - `northType` 'opcua', required - `northSettings` NorthOPCUASettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'influxdb', required - `southSettings` SouthInfluxDBSettings, required - … - `items` HistoryQueryInfluxDBItemCommandDTO[], required - … - `northType` 'rest', required - `northSettings` NorthRESTSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'influxdb', required - `southSettings` SouthInfluxDBSettings, required - … - `items` HistoryQueryInfluxDBItemCommandDTO[], required - … - `northType` 'sftp', required - `northSettings` NorthSFTPSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'modbus', required - `southSettings` SouthModbusSettings, required - … - `items` HistoryQueryModbusItemCommandDTO[], required - … - `northType` 'aws-s3', required - `northSettings` NorthAmazonS3Settings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'modbus', required - `southSettings` SouthModbusSettings, required - … - `items` HistoryQueryModbusItemCommandDTO[], required - … - `northType` 'azure-blob', required - `northSettings` NorthAzureBlobSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'modbus', required - `southSettings` SouthModbusSettings, required - … - `items` HistoryQueryModbusItemCommandDTO[], required - … - `northType` 'console', required - `northSettings` NorthConsoleSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'modbus', required - `southSettings` SouthModbusSettings, required - … - `items` HistoryQueryModbusItemCommandDTO[], required - … - `northType` 'file-writer', required - `northSettings` NorthFileWriterSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'modbus', required - `southSettings` SouthModbusSettings, required - … - `items` HistoryQueryModbusItemCommandDTO[], required - … - `northType` 'modbus', required - `northSettings` NorthModbusSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'modbus', required - `southSettings` SouthModbusSettings, required - … - `items` HistoryQueryModbusItemCommandDTO[], required - … - `northType` 'mqtt', required - `northSettings` NorthMQTTSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'modbus', required - `southSettings` SouthModbusSettings, required - … - `items` HistoryQueryModbusItemCommandDTO[], required - … - `northType` 'oianalytics', required - `northSettings` NorthOIAnalyticsSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'modbus', required - `southSettings` SouthModbusSettings, required - … - `items` HistoryQueryModbusItemCommandDTO[], required - … - `northType` 'opcua', required - `northSettings` NorthOPCUASettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'modbus', required - `southSettings` SouthModbusSettings, required - … - `items` HistoryQueryModbusItemCommandDTO[], required - … - `northType` 'rest', required - `northSettings` NorthRESTSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'modbus', required - `southSettings` SouthModbusSettings, required - … - `items` HistoryQueryModbusItemCommandDTO[], required - … - `northType` 'sftp', required - `northSettings` NorthSFTPSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'mqtt', required - `southSettings` SouthMQTTSettings, required - … - `items` HistoryQueryMQTTItemCommandDTO[], required - … - `northType` 'aws-s3', required - `northSettings` NorthAmazonS3Settings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'mqtt', required - `southSettings` SouthMQTTSettings, required - … - `items` HistoryQueryMQTTItemCommandDTO[], required - … - `northType` 'azure-blob', required - `northSettings` NorthAzureBlobSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'mqtt', required - `southSettings` SouthMQTTSettings, required - … - `items` HistoryQueryMQTTItemCommandDTO[], required - … - `northType` 'console', required - `northSettings` NorthConsoleSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'mqtt', required - `southSettings` SouthMQTTSettings, required - … - `items` HistoryQueryMQTTItemCommandDTO[], required - … - `northType` 'file-writer', required - `northSettings` NorthFileWriterSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'mqtt', required - `southSettings` SouthMQTTSettings, required - … - `items` HistoryQueryMQTTItemCommandDTO[], required - … - `northType` 'modbus', required - `northSettings` NorthModbusSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'mqtt', required - `southSettings` SouthMQTTSettings, required - … - `items` HistoryQueryMQTTItemCommandDTO[], required - … - `northType` 'mqtt', required - `northSettings` NorthMQTTSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'mqtt', required - `southSettings` SouthMQTTSettings, required - … - `items` HistoryQueryMQTTItemCommandDTO[], required - … - `northType` 'oianalytics', required - `northSettings` NorthOIAnalyticsSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'mqtt', required - `southSettings` SouthMQTTSettings, required - … - `items` HistoryQueryMQTTItemCommandDTO[], required - … - `northType` 'opcua', required - `northSettings` NorthOPCUASettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'mqtt', required - `southSettings` SouthMQTTSettings, required - … - `items` HistoryQueryMQTTItemCommandDTO[], required - … - `northType` 'rest', required - `northSettings` NorthRESTSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'mqtt', required - `southSettings` SouthMQTTSettings, required - … - `items` HistoryQueryMQTTItemCommandDTO[], required - … - `northType` 'sftp', required - `northSettings` NorthSFTPSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'mssql', required - `southSettings` SouthMSSQLSettings, required - … - `items` HistoryQueryMSSQLItemCommandDTO[], required - … - `northType` 'aws-s3', required - `northSettings` NorthAmazonS3Settings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'mssql', required - `southSettings` SouthMSSQLSettings, required - … - `items` HistoryQueryMSSQLItemCommandDTO[], required - … - `northType` 'azure-blob', required - `northSettings` NorthAzureBlobSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'mssql', required - `southSettings` SouthMSSQLSettings, required - … - `items` HistoryQueryMSSQLItemCommandDTO[], required - … - `northType` 'console', required - `northSettings` NorthConsoleSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'mssql', required - `southSettings` SouthMSSQLSettings, required - … - `items` HistoryQueryMSSQLItemCommandDTO[], required - … - `northType` 'file-writer', required - `northSettings` NorthFileWriterSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'mssql', required - `southSettings` SouthMSSQLSettings, required - … - `items` HistoryQueryMSSQLItemCommandDTO[], required - … - `northType` 'modbus', required - `northSettings` NorthModbusSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'mssql', required - `southSettings` SouthMSSQLSettings, required - … - `items` HistoryQueryMSSQLItemCommandDTO[], required - … - `northType` 'mqtt', required - `northSettings` NorthMQTTSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'mssql', required - `southSettings` SouthMSSQLSettings, required - … - `items` HistoryQueryMSSQLItemCommandDTO[], required - … - `northType` 'oianalytics', required - `northSettings` NorthOIAnalyticsSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'mssql', required - `southSettings` SouthMSSQLSettings, required - … - `items` HistoryQueryMSSQLItemCommandDTO[], required - … - `northType` 'opcua', required - `northSettings` NorthOPCUASettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'mssql', required - `southSettings` SouthMSSQLSettings, required - … - `items` HistoryQueryMSSQLItemCommandDTO[], required - … - `northType` 'rest', required - `northSettings` NorthRESTSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'mssql', required - `southSettings` SouthMSSQLSettings, required - … - `items` HistoryQueryMSSQLItemCommandDTO[], required - … - `northType` 'sftp', required - `northSettings` NorthSFTPSettings, required - … - object — Command Data Transfer Object for creating or updating a history query. Used as the request body for history query creation/update endpoints. - `name` string, required - `description` string, required - `queryTimeRange` object, required - … - `caching` object, required - … - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required - … - `southType` 'mysql', required - `southSettings` SouthMySQLSettings, required - … - … truncated; see the full OpenAPI document linked below --- [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)