---
title: "Update history query"
method: PUT
path: "/api/history/{historyId}"
tags: ["History Queries"]
---

# Update history query

`PUT /api/history/{historyId}`

Updates an existing history query configuration

## Path parameters

- `historyId` string, required

## Query parameters

- `resetCache` string, required

## Request body

- union
  - 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
      - `readDelay` number, double, required
      - `maxReadInterval` number, double, required
      - `endTime` string, required — Represents an instant in time as an ISO 8601 string.
      - `startTime` string, required — Represents an instant in time as an ISO 8601 string.
    - `caching` object, required
      - `archive` object, required
        - `retentionDuration` number, double, required
        - `enabled` boolean, required
      - `error` object, required
        - `retentionDuration` number, double, required
        - `retryCount` number, double, required
        - `retryInterval` number, double, required
      - `throttling` object, required
        - `maxNumberOfElements` number, double, required
        - `maxSize` number, double, required
        - `runMinDelay` number, double, required
      - `trigger` object, required
        - `numberOfFiles` number, double, required
        - `numberOfElements` number, double, required
        - `scanModeName` string, nullable, required
        - `scanModeId` string, required
    - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required
      - `id` string, required — The id used to match a transformer with options
      - `items` object[], required — The list of items associated to the transformer
        - `enabled` boolean, required — Whether this item is enabled.
        - `name` string, required — The name of the item.
        - `id` string, required — The item ID
      - `transformerId` string, required — The transformer to be applied.
      - `options` RecordStringUnknown, required — Construct a type with a set of properties K of type T
    - `southType` 'ads', required
    - `southSettings` SouthADSSettings, required
      - `netId` string, required
      - `port` number, double, required
      - `routerAddress` string, nullable, required
      - `routerTcpPort` number, double, nullable, required
      - `clientAmsNetId` string, nullable, required
      - `clientAdsPort` number, double, nullable, required
      - `retryInterval` number, double, required
      - `plcName` string, nullable, required
      - `enumAsText` 'text' | 'integer', required
      - `boolAsText` 'text' | 'integer', required
      - `structureFiltering` SouthADSSettingsStructureFiltering[], nullable, required
        - `name` string, required
        - `fields` string, required
    - `items` HistoryQueryADSItemCommandDTO[], required
      - `id` string, nullable, required
      - `name` string, required
      - `enabled` boolean, required
      - `settings` SouthADSItemSettings, required
        - `address` string, required
    - `northType` 'aws-s3', required
    - `northSettings` NorthAmazonS3Settings, required
      - `bucket` string, required
      - `region` string, required
      - `folder` string, required
      - `accessKey` string, required
      - `secretKey` string, nullable, required
      - `useProxy` boolean, required
      - `proxyUrl` string, nullable
      - `proxyUsername` string, nullable
      - `proxyPassword` string, nullable
  - 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
      - `readDelay` number, double, required
      - `maxReadInterval` number, double, required
      - `endTime` string, required — Represents an instant in time as an ISO 8601 string.
      - `startTime` string, required — Represents an instant in time as an ISO 8601 string.
    - `caching` object, required
      - `archive` object, required
        - `retentionDuration` number, double, required
        - `enabled` boolean, required
      - `error` object, required
        - `retentionDuration` number, double, required
        - `retryCount` number, double, required
        - `retryInterval` number, double, required
      - `throttling` object, required
        - `maxNumberOfElements` number, double, required
        - `maxSize` number, double, required
        - `runMinDelay` number, double, required
      - `trigger` object, required
        - `numberOfFiles` number, double, required
        - `numberOfElements` number, double, required
        - `scanModeName` string, nullable, required
        - `scanModeId` string, required
    - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required
      - `id` string, required — The id used to match a transformer with options
      - `items` object[], required — The list of items associated to the transformer
        - `enabled` boolean, required — Whether this item is enabled.
        - `name` string, required — The name of the item.
        - `id` string, required — The item ID
      - `transformerId` string, required — The transformer to be applied.
      - `options` RecordStringUnknown, required — Construct a type with a set of properties K of type T
    - `southType` 'ads', required
    - `southSettings` SouthADSSettings, required
      - `netId` string, required
      - `port` number, double, required
      - `routerAddress` string, nullable, required
      - `routerTcpPort` number, double, nullable, required
      - `clientAmsNetId` string, nullable, required
      - `clientAdsPort` number, double, nullable, required
      - `retryInterval` number, double, required
      - `plcName` string, nullable, required
      - `enumAsText` 'text' | 'integer', required
      - `boolAsText` 'text' | 'integer', required
      - `structureFiltering` SouthADSSettingsStructureFiltering[], nullable, required
        - `name` string, required
        - `fields` string, required
    - `items` HistoryQueryADSItemCommandDTO[], required
      - `id` string, nullable, required
      - `name` string, required
      - `enabled` boolean, required
      - `settings` SouthADSItemSettings, required
        - `address` string, required
    - `northType` 'azure-blob', required
    - `northSettings` NorthAzureBlobSettings, required
      - `useADLS` boolean, required
      - `useCustomUrl` boolean, required
      - `account` string
      - `customUrl` string
      - `container` string, required
      - `path` string, required
      - `authentication` 'access-key' | 'sas-token' | 'aad' | 'external', required
      - `accessKey` string, nullable
      - `sasToken` string, nullable
      - `tenantId` string, nullable
      - `clientId` string, nullable
      - `clientSecret` string, nullable
      - `useProxy` boolean, required
      - `proxyUrl` string
      - `proxyUsername` string, nullable
      - `proxyPassword` string, nullable
  - 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
      - `readDelay` number, double, required
      - `maxReadInterval` number, double, required
      - `endTime` string, required — Represents an instant in time as an ISO 8601 string.
      - `startTime` string, required — Represents an instant in time as an ISO 8601 string.
    - `caching` object, required
      - `archive` object, required
        - `retentionDuration` number, double, required
        - `enabled` boolean, required
      - `error` object, required
        - `retentionDuration` number, double, required
        - `retryCount` number, double, required
        - `retryInterval` number, double, required
      - `throttling` object, required
        - `maxNumberOfElements` number, double, required
        - `maxSize` number, double, required
        - `runMinDelay` number, double, required
      - `trigger` object, required
        - `numberOfFiles` number, double, required
        - `numberOfElements` number, double, required
        - `scanModeName` string, nullable, required
        - `scanModeId` string, required
    - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required
      - `id` string, required — The id used to match a transformer with options
      - `items` object[], required — The list of items associated to the transformer
        - `enabled` boolean, required — Whether this item is enabled.
        - `name` string, required — The name of the item.
        - `id` string, required — The item ID
      - `transformerId` string, required — The transformer to be applied.
      - `options` RecordStringUnknown, required — Construct a type with a set of properties K of type T
    - `southType` 'ads', required
    - `southSettings` SouthADSSettings, required
      - `netId` string, required
      - `port` number, double, required
      - `routerAddress` string, nullable, required
      - `routerTcpPort` number, double, nullable, required
      - `clientAmsNetId` string, nullable, required
      - `clientAdsPort` number, double, nullable, required
      - `retryInterval` number, double, required
      - `plcName` string, nullable, required
      - `enumAsText` 'text' | 'integer', required
      - `boolAsText` 'text' | 'integer', required
      - `structureFiltering` SouthADSSettingsStructureFiltering[], nullable, required
        - `name` string, required
        - `fields` string, required
    - `items` HistoryQueryADSItemCommandDTO[], required
      - `id` string, nullable, required
      - `name` string, required
      - `enabled` boolean, required
      - `settings` SouthADSItemSettings, required
        - `address` string, required
    - `northType` 'console', required
    - `northSettings` NorthConsoleSettings, required
      - `verbose` boolean, 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
      - `readDelay` number, double, required
      - `maxReadInterval` number, double, required
      - `endTime` string, required — Represents an instant in time as an ISO 8601 string.
      - `startTime` string, required — Represents an instant in time as an ISO 8601 string.
    - `caching` object, required
      - `archive` object, required
        - `retentionDuration` number, double, required
        - `enabled` boolean, required
      - `error` object, required
        - `retentionDuration` number, double, required
        - `retryCount` number, double, required
        - `retryInterval` number, double, required
      - `throttling` object, required
        - `maxNumberOfElements` number, double, required
        - `maxSize` number, double, required
        - `runMinDelay` number, double, required
      - `trigger` object, required
        - `numberOfFiles` number, double, required
        - `numberOfElements` number, double, required
        - `scanModeName` string, nullable, required
        - `scanModeId` string, required
    - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required
      - `id` string, required — The id used to match a transformer with options
      - `items` object[], required — The list of items associated to the transformer
        - `enabled` boolean, required — Whether this item is enabled.
        - `name` string, required — The name of the item.
        - `id` string, required — The item ID
      - `transformerId` string, required — The transformer to be applied.
      - `options` RecordStringUnknown, required — Construct a type with a set of properties K of type T
    - `southType` 'ads', required
    - `southSettings` SouthADSSettings, required
      - `netId` string, required
      - `port` number, double, required
      - `routerAddress` string, nullable, required
      - `routerTcpPort` number, double, nullable, required
      - `clientAmsNetId` string, nullable, required
      - `clientAdsPort` number, double, nullable, required
      - `retryInterval` number, double, required
      - `plcName` string, nullable, required
      - `enumAsText` 'text' | 'integer', required
      - `boolAsText` 'text' | 'integer', required
      - `structureFiltering` SouthADSSettingsStructureFiltering[], nullable, required
        - `name` string, required
        - `fields` string, required
    - `items` HistoryQueryADSItemCommandDTO[], required
      - `id` string, nullable, required
      - `name` string, required
      - `enabled` boolean, required
      - `settings` SouthADSItemSettings, required
        - `address` string, required
    - `northType` 'file-writer', required
    - `northSettings` NorthFileWriterSettings, required
      - `outputFolder` string, required
      - `prefix` string, nullable, required
      - `suffix` string, nullable, required
      - `username` string, nullable
      - `password` string, nullable
      - `domain` string, nullable
  - 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
      - `readDelay` number, double, required
      - `maxReadInterval` number, double, required
      - `endTime` string, required — Represents an instant in time as an ISO 8601 string.
      - `startTime` string, required — Represents an instant in time as an ISO 8601 string.
    - `caching` object, required
      - `archive` object, required
        - `retentionDuration` number, double, required
        - `enabled` boolean, required
      - `error` object, required
        - `retentionDuration` number, double, required
        - `retryCount` number, double, required
        - `retryInterval` number, double, required
      - `throttling` object, required
        - `maxNumberOfElements` number, double, required
        - `maxSize` number, double, required
        - `runMinDelay` number, double, required
      - `trigger` object, required
        - `numberOfFiles` number, double, required
        - `numberOfElements` number, double, required
        - `scanModeName` string, nullable, required
        - `scanModeId` string, required
    - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required
      - `id` string, required — The id used to match a transformer with options
      - `items` object[], required — The list of items associated to the transformer
        - `enabled` boolean, required — Whether this item is enabled.
        - `name` string, required — The name of the item.
        - `id` string, required — The item ID
      - `transformerId` string, required — The transformer to be applied.
      - `options` RecordStringUnknown, required — Construct a type with a set of properties K of type T
    - `southType` 'ads', required
    - `southSettings` SouthADSSettings, required
      - `netId` string, required
      - `port` number, double, required
      - `routerAddress` string, nullable, required
      - `routerTcpPort` number, double, nullable, required
      - `clientAmsNetId` string, nullable, required
      - `clientAdsPort` number, double, nullable, required
      - `retryInterval` number, double, required
      - `plcName` string, nullable, required
      - `enumAsText` 'text' | 'integer', required
      - `boolAsText` 'text' | 'integer', required
      - `structureFiltering` SouthADSSettingsStructureFiltering[], nullable, required
        - `name` string, required
        - `fields` string, required
    - `items` HistoryQueryADSItemCommandDTO[], required
      - `id` string, nullable, required
      - `name` string, required
      - `enabled` boolean, required
      - `settings` SouthADSItemSettings, required
        - `address` string, required
    - `northType` 'modbus', required
    - `northSettings` NorthModbusSettings, required
      - `host` string, required
      - `port` number, double, required
      - `connectTimeout` number, double, required
      - `retryInterval` number, double, required
      - `slaveId` number, double, required
      - `addressOffset` 'modbus' | 'jbus', required
      - `endianness` 'big-endian' | 'little-endian', required
      - `swapBytesInWords` boolean, required
      - `swapWordsInDWords` boolean, required
  - 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
      - `readDelay` number, double, required
      - `maxReadInterval` number, double, required
      - `endTime` string, required — Represents an instant in time as an ISO 8601 string.
      - `startTime` string, required — Represents an instant in time as an ISO 8601 string.
    - `caching` object, required
      - `archive` object, required
        - `retentionDuration` number, double, required
        - `enabled` boolean, required
      - `error` object, required
        - `retentionDuration` number, double, required
        - `retryCount` number, double, required
        - `retryInterval` number, double, required
      - `throttling` object, required
        - `maxNumberOfElements` number, double, required
        - `maxSize` number, double, required
        - `runMinDelay` number, double, required
      - `trigger` object, required
        - `numberOfFiles` number, double, required
        - `numberOfElements` number, double, required
        - `scanModeName` string, nullable, required
        - `scanModeId` string, required
    - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required
      - `id` string, required — The id used to match a transformer with options
      - `items` object[], required — The list of items associated to the transformer
        - `enabled` boolean, required — Whether this item is enabled.
        - `name` string, required — The name of the item.
        - `id` string, required — The item ID
      - `transformerId` string, required — The transformer to be applied.
      - `options` RecordStringUnknown, required — Construct a type with a set of properties K of type T
    - `southType` 'ads', required
    - `southSettings` SouthADSSettings, required
      - `netId` string, required
      - `port` number, double, required
      - `routerAddress` string, nullable, required
      - `routerTcpPort` number, double, nullable, required
      - `clientAmsNetId` string, nullable, required
      - `clientAdsPort` number, double, nullable, required
      - `retryInterval` number, double, required
      - `plcName` string, nullable, required
      - `enumAsText` 'text' | 'integer', required
      - `boolAsText` 'text' | 'integer', required
      - `structureFiltering` SouthADSSettingsStructureFiltering[], nullable, required
        - `name` string, required
        - `fields` string, required
    - `items` HistoryQueryADSItemCommandDTO[], required
      - `id` string, nullable, required
      - `name` string, required
      - `enabled` boolean, required
      - `settings` SouthADSItemSettings, required
        - `address` string, required
    - `northType` 'mqtt', required
    - `northSettings` NorthMQTTSettings, required
      - `url` string, required
      - `qos` '0' | '1' | '2', required
      - `persistent` boolean
      - `authentication` NorthMQTTSettingsAuthentication, required
        - `type` 'none' | 'basic' | 'cert', required
        - `username` string
        - `password` string, nullable
        - `certFilePath` string
        - `keyFilePath` string
        - `caFilePath` string
      - `rejectUnauthorized` boolean, required
      - `reconnectPeriod` number, double, required
      - `connectTimeout` number, double, required
  - 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
      - `readDelay` number, double, required
      - `maxReadInterval` number, double, required
      - `endTime` string, required — Represents an instant in time as an ISO 8601 string.
      - `startTime` string, required — Represents an instant in time as an ISO 8601 string.
    - `caching` object, required
      - `archive` object, required
        - `retentionDuration` number, double, required
        - `enabled` boolean, required
      - `error` object, required
        - `retentionDuration` number, double, required
        - `retryCount` number, double, required
        - `retryInterval` number, double, required
      - `throttling` object, required
        - `maxNumberOfElements` number, double, required
        - `maxSize` number, double, required
        - `runMinDelay` number, double, required
      - `trigger` object, required
        - `numberOfFiles` number, double, required
        - `numberOfElements` number, double, required
        - `scanModeName` string, nullable, required
        - `scanModeId` string, required
    - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required
      - `id` string, required — The id used to match a transformer with options
      - `items` object[], required — The list of items associated to the transformer
        - `enabled` boolean, required — Whether this item is enabled.
        - `name` string, required — The name of the item.
        - `id` string, required — The item ID
      - `transformerId` string, required — The transformer to be applied.
      - `options` RecordStringUnknown, required — Construct a type with a set of properties K of type T
    - `southType` 'ads', required
    - `southSettings` SouthADSSettings, required
      - `netId` string, required
      - `port` number, double, required
      - `routerAddress` string, nullable, required
      - `routerTcpPort` number, double, nullable, required
      - `clientAmsNetId` string, nullable, required
      - `clientAdsPort` number, double, nullable, required
      - `retryInterval` number, double, required
      - `plcName` string, nullable, required
      - `enumAsText` 'text' | 'integer', required
      - `boolAsText` 'text' | 'integer', required
      - `structureFiltering` SouthADSSettingsStructureFiltering[], nullable, required
        - `name` string, required
        - `fields` string, required
    - `items` HistoryQueryADSItemCommandDTO[], required
      - `id` string, nullable, required
      - `name` string, required
      - `enabled` boolean, required
      - `settings` SouthADSItemSettings, required
        - `address` string, required
    - `northType` 'oianalytics', required
    - `northSettings` NorthOIAnalyticsSettings, required
      - `useOiaModule` boolean, required
      - `timeout` number, double, required
      - `compress` boolean, required
      - `specificSettings` NorthOIAnalyticsSettingsSpecificSettings
        - `host` string, required
        - `acceptUnauthorized` boolean, required
        - `authentication` 'basic' | 'aad-client-secret' | 'aad-certificate', required
        - `accessKey` string
        - `secretKey` string, nullable
        - `tenantId` string, nullable
        - `clientId` string
        - `clientSecret` string, nullable
        - `certificateId` string, nullable
        - `scope` string, nullable
        - `useProxy` boolean, required
        - `proxyUrl` string
        - `proxyUsername` string, nullable
        - `proxyPassword` string, nullable
  - 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
      - `readDelay` number, double, required
      - `maxReadInterval` number, double, required
      - `endTime` string, required — Represents an instant in time as an ISO 8601 string.
      - `startTime` string, required — Represents an instant in time as an ISO 8601 string.
    - `caching` object, required
      - `archive` object, required
        - `retentionDuration` number, double, required
        - `enabled` boolean, required
      - `error` object, required
        - `retentionDuration` number, double, required
        - `retryCount` number, double, required
        - `retryInterval` number, double, required
      - `throttling` object, required
        - `maxNumberOfElements` number, double, required
        - `maxSize` number, double, required
        - `runMinDelay` number, double, required
      - `trigger` object, required
        - `numberOfFiles` number, double, required
        - `numberOfElements` number, double, required
        - `scanModeName` string, nullable, required
        - `scanModeId` string, required
    - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required
      - `id` string, required — The id used to match a transformer with options
      - `items` object[], required — The list of items associated to the transformer
        - `enabled` boolean, required — Whether this item is enabled.
        - `name` string, required — The name of the item.
        - `id` string, required — The item ID
      - `transformerId` string, required — The transformer to be applied.
      - `options` RecordStringUnknown, required — Construct a type with a set of properties K of type T
    - `southType` 'ads', required
    - `southSettings` SouthADSSettings, required
      - `netId` string, required
      - `port` number, double, required
      - `routerAddress` string, nullable, required
      - `routerTcpPort` number, double, nullable, required
      - `clientAmsNetId` string, nullable, required
      - `clientAdsPort` number, double, nullable, required
      - `retryInterval` number, double, required
      - `plcName` string, nullable, required
      - `enumAsText` 'text' | 'integer', required
      - `boolAsText` 'text' | 'integer', required
      - `structureFiltering` SouthADSSettingsStructureFiltering[], nullable, required
        - `name` string, required
        - `fields` string, required
    - `items` HistoryQueryADSItemCommandDTO[], required
      - `id` string, nullable, required
      - `name` string, required
      - `enabled` boolean, required
      - `settings` SouthADSItemSettings, required
        - `address` string, required
    - `northType` 'opcua', required
    - `northSettings` NorthOPCUASettings, required
      - `url` string, required
      - `keepSessionAlive` boolean, required
      - `retryInterval` number, double, required
      - `securityMode` 'none' | 'sign' | 'sign-and-encrypt', required
      - `securityPolicy` 'none' | 'basic128' | 'basic192' | 'basic256' | 'basic128-rsa15' | 'basic192-rsa15' | 'basic256-rsa15' | 'basic256-sha256' | 'aes128-sha256-rsa-oaep' | 'pub-sub-aes-128-ctr' | 'pub-sub-aes-256-ctr'
      - `authentication` NorthOPCUASettingsAuthentication, required
        - `type` 'none' | 'basic' | 'cert', required
        - `username` string
        - `password` string, nullable
        - `certFilePath` string
        - `keyFilePath` string
  - 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
      - `readDelay` number, double, required
      - `maxReadInterval` number, double, required
      - `endTime` string, required — Represents an instant in time as an ISO 8601 string.
      - `startTime` string, required — Represents an instant in time as an ISO 8601 string.
    - `caching` object, required
      - `archive` object, required
        - `retentionDuration` number, double, required
        - `enabled` boolean, required
      - `error` object, required
        - `retentionDuration` number, double, required
        - `retryCount` number, double, required
        - `retryInterval` number, double, required
      - `throttling` object, required
        - `maxNumberOfElements` number, double, required
        - `maxSize` number, double, required
        - `runMinDelay` number, double, required
      - `trigger` object, required
        - `numberOfFiles` number, double, required
        - `numberOfElements` number, double, required
        - `scanModeName` string, nullable, required
        - `scanModeId` string, required
    - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required
      - `id` string, required — The id used to match a transformer with options
      - `items` object[], required — The list of items associated to the transformer
        - `enabled` boolean, required — Whether this item is enabled.
        - `name` string, required — The name of the item.
        - `id` string, required — The item ID
      - `transformerId` string, required — The transformer to be applied.
      - `options` RecordStringUnknown, required — Construct a type with a set of properties K of type T
    - `southType` 'ads', required
    - `southSettings` SouthADSSettings, required
      - `netId` string, required
      - `port` number, double, required
      - `routerAddress` string, nullable, required
      - `routerTcpPort` number, double, nullable, required
      - `clientAmsNetId` string, nullable, required
      - `clientAdsPort` number, double, nullable, required
      - `retryInterval` number, double, required
      - `plcName` string, nullable, required
      - `enumAsText` 'text' | 'integer', required
      - `boolAsText` 'text' | 'integer', required
      - `structureFiltering` SouthADSSettingsStructureFiltering[], nullable, required
        - `name` string, required
        - `fields` string, required
    - `items` HistoryQueryADSItemCommandDTO[], required
      - `id` string, nullable, required
      - `name` string, required
      - `enabled` boolean, required
      - `settings` SouthADSItemSettings, required
        - `address` string, required
    - `northType` 'rest', required
    - `northSettings` NorthRESTSettings, required
      - `host` string, required
      - `acceptUnauthorized` boolean, required
      - `method` 'POST' | 'PUT' | 'PATCH', required
      - `endpoint` string, required
      - `timeout` number, double, required
      - `sendAs` 'file' | 'body', required
      - `successCode` number, double, required
      - `authentication` NorthRESTSettingsAuthentication, required
        - `type` 'none' | 'basic' | 'bearer' | 'api-key', required
        - `username` string
        - `password` string, nullable
        - `token` string, nullable
        - `apiKey` string
        - `apiValue` string, nullable
        - `addTo` 'header' | 'query-params'
      - `proxy` NorthRESTSettingsProxy, required
        - `useProxy` boolean, required
        - `proxyUrl` string
        - `proxyUsername` string, nullable
        - `proxyPassword` string, nullable
      - `queryParams` NorthRESTSettingsQueryParams[], required
        - `key` string, required
        - `value` string, required
      - `headers` NorthRESTSettingsHeaders[], required
        - `key` string, required
        - `value` string, required
      - `test` NorthRESTSettingsTest, required
        - `testMethod` 'GET' | 'POST' | 'PUT', required
        - `testEndpoint` string, required
        - `body` string, nullable
        - `testSuccessCode` number, double, 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
      - `readDelay` number, double, required
      - `maxReadInterval` number, double, required
      - `endTime` string, required — Represents an instant in time as an ISO 8601 string.
      - `startTime` string, required — Represents an instant in time as an ISO 8601 string.
    - `caching` object, required
      - `archive` object, required
        - `retentionDuration` number, double, required
        - `enabled` boolean, required
      - `error` object, required
        - `retentionDuration` number, double, required
        - `retryCount` number, double, required
        - `retryInterval` number, double, required
      - `throttling` object, required
        - `maxNumberOfElements` number, double, required
        - `maxSize` number, double, required
        - `runMinDelay` number, double, required
      - `trigger` object, required
        - `numberOfFiles` number, double, required
        - `numberOfElements` number, double, required
        - `scanModeName` string, nullable, required
        - `scanModeId` string, required
    - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required
      - `id` string, required — The id used to match a transformer with options
      - `items` object[], required — The list of items associated to the transformer
        - `enabled` boolean, required — Whether this item is enabled.
        - `name` string, required — The name of the item.
        - `id` string, required — The item ID
      - `transformerId` string, required — The transformer to be applied.
      - `options` RecordStringUnknown, required — Construct a type with a set of properties K of type T
    - `southType` 'ads', required
    - `southSettings` SouthADSSettings, required
      - `netId` string, required
      - `port` number, double, required
      - `routerAddress` string, nullable, required
      - `routerTcpPort` number, double, nullable, required
      - `clientAmsNetId` string, nullable, required
      - `clientAdsPort` number, double, nullable, required
      - `retryInterval` number, double, required
      - `plcName` string, nullable, required
      - `enumAsText` 'text' | 'integer', required
      - `boolAsText` 'text' | 'integer', required
      - `structureFiltering` SouthADSSettingsStructureFiltering[], nullable, required
        - `name` string, required
        - `fields` string, required
    - `items` HistoryQueryADSItemCommandDTO[], required
      - `id` string, nullable, required
      - `name` string, required
      - `enabled` boolean, required
      - `settings` SouthADSItemSettings, required
        - `address` string, required
    - `northType` 'sftp', required
    - `northSettings` NorthSFTPSettings, required
      - `host` string, required
      - `port` number, double, required
      - `authentication` 'password' | 'private-key', required
      - `username` string, required
      - `password` string, nullable
      - `privateKey` string
      - `passphrase` string, nullable
      - `remoteFolder` string, required
      - `prefix` string, nullable, required
      - `suffix` string, nullable, 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
      - `readDelay` number, double, required
      - `maxReadInterval` number, double, required
      - `endTime` string, required — Represents an instant in time as an ISO 8601 string.
      - `startTime` string, required — Represents an instant in time as an ISO 8601 string.
    - `caching` object, required
      - `archive` object, required
        - `retentionDuration` number, double, required
        - `enabled` boolean, required
      - `error` object, required
        - `retentionDuration` number, double, required
        - `retryCount` number, double, required
        - `retryInterval` number, double, required
      - `throttling` object, required
        - `maxNumberOfElements` number, double, required
        - `maxSize` number, double, required
        - `runMinDelay` number, double, required
      - `trigger` object, required
        - `numberOfFiles` number, double, required
        - `numberOfElements` number, double, required
        - `scanModeName` string, nullable, required
        - `scanModeId` string, required
    - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required
      - `id` string, required — The id used to match a transformer with options
      - `items` object[], required — The list of items associated to the transformer
        - `enabled` boolean, required — Whether this item is enabled.
        - `name` string, required — The name of the item.
        - `id` string, required — The item ID
      - `transformerId` string, required — The transformer to be applied.
      - `options` RecordStringUnknown, required — Construct a type with a set of properties K of type T
    - `southType` 'folder-scanner', required
    - `southSettings` SouthFolderScannerSettings, required
      - `inputFolder` string, required
      - `compression` boolean, required
      - `username` string, nullable
      - `password` string, nullable
      - `domain` string, nullable
    - `items` HistoryQueryFolderScannerItemCommandDTO[], required
      - `id` string, nullable, required
      - `name` string, required
      - `enabled` boolean, required
      - `settings` SouthFolderScannerItemSettings, required
        - `regex` string, required
        - `minAge` number, double, required
        - `preserveFiles` boolean, required
        - `ignoreModifiedDate` boolean
        - `maxFiles` number, double, required
        - `maxSize` number, double, required
        - `recursive` boolean, required
    - `northType` 'aws-s3', required
    - `northSettings` NorthAmazonS3Settings, required
      - `bucket` string, required
      - `region` string, required
      - `folder` string, required
      - `accessKey` string, required
      - `secretKey` string, nullable, required
      - `useProxy` boolean, required
      - `proxyUrl` string, nullable
      - `proxyUsername` string, nullable
      - `proxyPassword` string, nullable
  - 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
      - `readDelay` number, double, required
      - `maxReadInterval` number, double, required
      - `endTime` string, required — Represents an instant in time as an ISO 8601 string.
      - `startTime` string, required — Represents an instant in time as an ISO 8601 string.
    - `caching` object, required
      - `archive` object, required
        - `retentionDuration` number, double, required
        - `enabled` boolean, required
      - `error` object, required
        - `retentionDuration` number, double, required
        - `retryCount` number, double, required
        - `retryInterval` number, double, required
      - `throttling` object, required
        - `maxNumberOfElements` number, double, required
        - `maxSize` number, double, required
        - `runMinDelay` number, double, required
      - `trigger` object, required
        - `numberOfFiles` number, double, required
        - `numberOfElements` number, double, required
        - `scanModeName` string, nullable, required
        - `scanModeId` string, required
    - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required
      - `id` string, required — The id used to match a transformer with options
      - `items` object[], required — The list of items associated to the transformer
        - `enabled` boolean, required — Whether this item is enabled.
        - `name` string, required — The name of the item.
        - `id` string, required — The item ID
      - `transformerId` string, required — The transformer to be applied.
      - `options` RecordStringUnknown, required — Construct a type with a set of properties K of type T
    - `southType` 'folder-scanner', required
    - `southSettings` SouthFolderScannerSettings, required
      - `inputFolder` string, required
      - `compression` boolean, required
      - `username` string, nullable
      - `password` string, nullable
      - `domain` string, nullable
    - `items` HistoryQueryFolderScannerItemCommandDTO[], required
      - `id` string, nullable, required
      - `name` string, required
      - `enabled` boolean, required
      - `settings` SouthFolderScannerItemSettings, required
        - `regex` string, required
        - `minAge` number, double, required
        - `preserveFiles` boolean, required
        - `ignoreModifiedDate` boolean
        - `maxFiles` number, double, required
        - `maxSize` number, double, required
        - `recursive` boolean, required
    - `northType` 'azure-blob', required
    - `northSettings` NorthAzureBlobSettings, required
      - `useADLS` boolean, required
      - `useCustomUrl` boolean, required
      - `account` string
      - `customUrl` string
      - `container` string, required
      - `path` string, required
      - `authentication` 'access-key' | 'sas-token' | 'aad' | 'external', required
      - `accessKey` string, nullable
      - `sasToken` string, nullable
      - `tenantId` string, nullable
      - `clientId` string, nullable
      - `clientSecret` string, nullable
      - `useProxy` boolean, required
      - `proxyUrl` string
      - `proxyUsername` string, nullable
      - `proxyPassword` string, nullable
  - 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
      - `readDelay` number, double, required
      - `maxReadInterval` number, double, required
      - `endTime` string, required — Represents an instant in time as an ISO 8601 string.
      - `startTime` string, required — Represents an instant in time as an ISO 8601 string.
    - `caching` object, required
      - `archive` object, required
        - `retentionDuration` number, double, required
        - `enabled` boolean, required
      - `error` object, required
        - `retentionDuration` number, double, required
        - `retryCount` number, double, required
        - `retryInterval` number, double, required
      - `throttling` object, required
        - `maxNumberOfElements` number, double, required
        - `maxSize` number, double, required
        - `runMinDelay` number, double, required
      - `trigger` object, required
        - `numberOfFiles` number, double, required
        - `numberOfElements` number, double, required
        - `scanModeName` string, nullable, required
        - `scanModeId` string, required
    - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required
      - `id` string, required — The id used to match a transformer with options
      - `items` object[], required — The list of items associated to the transformer
        - `enabled` boolean, required — Whether this item is enabled.
        - `name` string, required — The name of the item.
        - `id` string, required — The item ID
      - `transformerId` string, required — The transformer to be applied.
      - `options` RecordStringUnknown, required — Construct a type with a set of properties K of type T
    - `southType` 'folder-scanner', required
    - `southSettings` SouthFolderScannerSettings, required
      - `inputFolder` string, required
      - `compression` boolean, required
      - `username` string, nullable
      - `password` string, nullable
      - `domain` string, nullable
    - `items` HistoryQueryFolderScannerItemCommandDTO[], required
      - `id` string, nullable, required
      - `name` string, required
      - `enabled` boolean, required
      - `settings` SouthFolderScannerItemSettings, required
        - `regex` string, required
        - `minAge` number, double, required
        - `preserveFiles` boolean, required
        - `ignoreModifiedDate` boolean
        - `maxFiles` number, double, required
        - `maxSize` number, double, required
        - `recursive` boolean, required
    - `northType` 'console', required
    - `northSettings` NorthConsoleSettings, required
      - `verbose` boolean, 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
      - `readDelay` number, double, required
      - `maxReadInterval` number, double, required
      - `endTime` string, required — Represents an instant in time as an ISO 8601 string.
      - `startTime` string, required — Represents an instant in time as an ISO 8601 string.
    - `caching` object, required
      - `archive` object, required
        - `retentionDuration` number, double, required
        - `enabled` boolean, required
      - `error` object, required
        - `retentionDuration` number, double, required
        - `retryCount` number, double, required
        - `retryInterval` number, double, required
      - `throttling` object, required
        - `maxNumberOfElements` number, double, required
        - `maxSize` number, double, required
        - `runMinDelay` number, double, required
      - `trigger` object, required
        - `numberOfFiles` number, double, required
        - `numberOfElements` number, double, required
        - `scanModeName` string, nullable, required
        - `scanModeId` string, required
    - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required
      - `id` string, required — The id used to match a transformer with options
      - `items` object[], required — The list of items associated to the transformer
        - `enabled` boolean, required — Whether this item is enabled.
        - `name` string, required — The name of the item.
        - `id` string, required — The item ID
      - `transformerId` string, required — The transformer to be applied.
      - `options` RecordStringUnknown, required — Construct a type with a set of properties K of type T
    - `southType` 'folder-scanner', required
    - `southSettings` SouthFolderScannerSettings, required
      - `inputFolder` string, required
      - `compression` boolean, required
      - `username` string, nullable
      - `password` string, nullable
      - `domain` string, nullable
    - `items` HistoryQueryFolderScannerItemCommandDTO[], required
      - `id` string, nullable, required
      - `name` string, required
      - `enabled` boolean, required
      - `settings` SouthFolderScannerItemSettings, required
        - `regex` string, required
        - `minAge` number, double, required
        - `preserveFiles` boolean, required
        - `ignoreModifiedDate` boolean
        - `maxFiles` number, double, required
        - `maxSize` number, double, required
        - `recursive` boolean, required
    - `northType` 'file-writer', required
    - `northSettings` NorthFileWriterSettings, required
      - `outputFolder` string, required
      - `prefix` string, nullable, required
      - `suffix` string, nullable, required
      - `username` string, nullable
      - `password` string, nullable
      - `domain` string, nullable
  - 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
      - `readDelay` number, double, required
      - `maxReadInterval` number, double, required
      - `endTime` string, required — Represents an instant in time as an ISO 8601 string.
      - `startTime` string, required — Represents an instant in time as an ISO 8601 string.
    - `caching` object, required
      - `archive` object, required
        - `retentionDuration` number, double, required
        - `enabled` boolean, required
      - `error` object, required
        - `retentionDuration` number, double, required
        - `retryCount` number, double, required
        - `retryInterval` number, double, required
      - `throttling` object, required
        - `maxNumberOfElements` number, double, required
        - `maxSize` number, double, required
        - `runMinDelay` number, double, required
      - `trigger` object, required
        - `numberOfFiles` number, double, required
        - `numberOfElements` number, double, required
        - `scanModeName` string, nullable, required
        - `scanModeId` string, required
    - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required
      - `id` string, required — The id used to match a transformer with options
      - `items` object[], required — The list of items associated to the transformer
        - `enabled` boolean, required — Whether this item is enabled.
        - `name` string, required — The name of the item.
        - `id` string, required — The item ID
      - `transformerId` string, required — The transformer to be applied.
      - `options` RecordStringUnknown, required — Construct a type with a set of properties K of type T
    - `southType` 'folder-scanner', required
    - `southSettings` SouthFolderScannerSettings, required
      - `inputFolder` string, required
      - `compression` boolean, required
      - `username` string, nullable
      - `password` string, nullable
      - `domain` string, nullable
    - `items` HistoryQueryFolderScannerItemCommandDTO[], required
      - `id` string, nullable, required
      - `name` string, required
      - `enabled` boolean, required
      - `settings` SouthFolderScannerItemSettings, required
        - `regex` string, required
        - `minAge` number, double, required
        - `preserveFiles` boolean, required
        - `ignoreModifiedDate` boolean
        - `maxFiles` number, double, required
        - `maxSize` number, double, required
        - `recursive` boolean, required
    - `northType` 'modbus', required
    - `northSettings` NorthModbusSettings, required
      - `host` string, required
      - `port` number, double, required
      - `connectTimeout` number, double, required
      - `retryInterval` number, double, required
      - `slaveId` number, double, required
      - `addressOffset` 'modbus' | 'jbus', required
      - `endianness` 'big-endian' | 'little-endian', required
      - `swapBytesInWords` boolean, required
      - `swapWordsInDWords` boolean, required
  - 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
      - `readDelay` number, double, required
      - `maxReadInterval` number, double, required
      - `endTime` string, required — Represents an instant in time as an ISO 8601 string.
      - `startTime` string, required — Represents an instant in time as an ISO 8601 string.
    - `caching` object, required
      - `archive` object, required
        - `retentionDuration` number, double, required
        - `enabled` boolean, required
      - `error` object, required
        - `retentionDuration` number, double, required
        - `retryCount` number, double, required
        - `retryInterval` number, double, required
      - `throttling` object, required
        - `maxNumberOfElements` number, double, required
        - `maxSize` number, double, required
        - `runMinDelay` number, double, required
      - `trigger` object, required
        - `numberOfFiles` number, double, required
        - `numberOfElements` number, double, required
        - `scanModeName` string, nullable, required
        - `scanModeId` string, required
    - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required
      - `id` string, required — The id used to match a transformer with options
      - `items` object[], required — The list of items associated to the transformer
        - `enabled` boolean, required — Whether this item is enabled.
        - `name` string, required — The name of the item.
        - `id` string, required — The item ID
      - `transformerId` string, required — The transformer to be applied.
      - `options` RecordStringUnknown, required — Construct a type with a set of properties K of type T
    - `southType` 'folder-scanner', required
    - `southSettings` SouthFolderScannerSettings, required
      - `inputFolder` string, required
      - `compression` boolean, required
      - `username` string, nullable
      - `password` string, nullable
      - `domain` string, nullable
    - `items` HistoryQueryFolderScannerItemCommandDTO[], required
      - `id` string, nullable, required
      - `name` string, required
      - `enabled` boolean, required
      - `settings` SouthFolderScannerItemSettings, required
        - `regex` string, required
        - `minAge` number, double, required
        - `preserveFiles` boolean, required
        - `ignoreModifiedDate` boolean
        - `maxFiles` number, double, required
        - `maxSize` number, double, required
        - `recursive` boolean, required
    - `northType` 'mqtt', required
    - `northSettings` NorthMQTTSettings, required
      - `url` string, required
      - `qos` '0' | '1' | '2', required
      - `persistent` boolean
      - `authentication` NorthMQTTSettingsAuthentication, required
        - `type` 'none' | 'basic' | 'cert', required
        - `username` string
        - `password` string, nullable
        - `certFilePath` string
        - `keyFilePath` string
        - `caFilePath` string
      - `rejectUnauthorized` boolean, required
      - `reconnectPeriod` number, double, required
      - `connectTimeout` number, double, required
  - 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
      - `readDelay` number, double, required
      - `maxReadInterval` number, double, required
      - `endTime` string, required — Represents an instant in time as an ISO 8601 string.
      - `startTime` string, required — Represents an instant in time as an ISO 8601 string.
    - `caching` object, required
      - `archive` object, required
        - `retentionDuration` number, double, required
        - `enabled` boolean, required
      - `error` object, required
        - `retentionDuration` number, double, required
        - `retryCount` number, double, required
        - `retryInterval` number, double, required
      - `throttling` object, required
        - `maxNumberOfElements` number, double, required
        - `maxSize` number, double, required
        - `runMinDelay` number, double, required
      - `trigger` object, required
        - `numberOfFiles` number, double, required
        - `numberOfElements` number, double, required
        - `scanModeName` string, nullable, required
        - `scanModeId` string, required
    - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required
      - `id` string, required — The id used to match a transformer with options
      - `items` object[], required — The list of items associated to the transformer
        - `enabled` boolean, required — Whether this item is enabled.
        - `name` string, required — The name of the item.
        - `id` string, required — The item ID
      - `transformerId` string, required — The transformer to be applied.
      - `options` RecordStringUnknown, required — Construct a type with a set of properties K of type T
    - `southType` 'folder-scanner', required
    - `southSettings` SouthFolderScannerSettings, required
      - `inputFolder` string, required
      - `compression` boolean, required
      - `username` string, nullable
      - `password` string, nullable
      - `domain` string, nullable
    - `items` HistoryQueryFolderScannerItemCommandDTO[], required
      - `id` string, nullable, required
      - `name` string, required
      - `enabled` boolean, required
      - `settings` SouthFolderScannerItemSettings, required
        - `regex` string, required
        - `minAge` number, double, required
        - `preserveFiles` boolean, required
        - `ignoreModifiedDate` boolean
        - `maxFiles` number, double, required
        - `maxSize` number, double, required
        - `recursive` boolean, required
    - `northType` 'oianalytics', required
    - `northSettings` NorthOIAnalyticsSettings, required
      - `useOiaModule` boolean, required
      - `timeout` number, double, required
      - `compress` boolean, required
      - `specificSettings` NorthOIAnalyticsSettingsSpecificSettings
        - `host` string, required
        - `acceptUnauthorized` boolean, required
        - `authentication` 'basic' | 'aad-client-secret' | 'aad-certificate', required
        - `accessKey` string
        - `secretKey` string, nullable
        - `tenantId` string, nullable
        - `clientId` string
        - `clientSecret` string, nullable
        - `certificateId` string, nullable
        - `scope` string, nullable
        - `useProxy` boolean, required
        - `proxyUrl` string
        - `proxyUsername` string, nullable
        - `proxyPassword` string, nullable
  - 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
      - `readDelay` number, double, required
      - `maxReadInterval` number, double, required
      - `endTime` string, required — Represents an instant in time as an ISO 8601 string.
      - `startTime` string, required — Represents an instant in time as an ISO 8601 string.
    - `caching` object, required
      - `archive` object, required
        - `retentionDuration` number, double, required
        - `enabled` boolean, required
      - `error` object, required
        - `retentionDuration` number, double, required
        - `retryCount` number, double, required
        - `retryInterval` number, double, required
      - `throttling` object, required
        - `maxNumberOfElements` number, double, required
        - `maxSize` number, double, required
        - `runMinDelay` number, double, required
      - `trigger` object, required
        - `numberOfFiles` number, double, required
        - `numberOfElements` number, double, required
        - `scanModeName` string, nullable, required
        - `scanModeId` string, required
    - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required
      - `id` string, required — The id used to match a transformer with options
      - `items` object[], required — The list of items associated to the transformer
        - `enabled` boolean, required — Whether this item is enabled.
        - `name` string, required — The name of the item.
        - `id` string, required — The item ID
      - `transformerId` string, required — The transformer to be applied.
      - `options` RecordStringUnknown, required — Construct a type with a set of properties K of type T
    - `southType` 'folder-scanner', required
    - `southSettings` SouthFolderScannerSettings, required
      - `inputFolder` string, required
      - `compression` boolean, required
      - `username` string, nullable
      - `password` string, nullable
      - `domain` string, nullable
    - `items` HistoryQueryFolderScannerItemCommandDTO[], required
      - `id` string, nullable, required
      - `name` string, required
      - `enabled` boolean, required
      - `settings` SouthFolderScannerItemSettings, required
        - `regex` string, required
        - `minAge` number, double, required
        - `preserveFiles` boolean, required
        - `ignoreModifiedDate` boolean
        - `maxFiles` number, double, required
        - `maxSize` number, double, required
        - `recursive` boolean, required
    - `northType` 'opcua', required
    - `northSettings` NorthOPCUASettings, required
      - `url` string, required
      - `keepSessionAlive` boolean, required
      - `retryInterval` number, double, required
      - `securityMode` 'none' | 'sign' | 'sign-and-encrypt', required
      - `securityPolicy` 'none' | 'basic128' | 'basic192' | 'basic256' | 'basic128-rsa15' | 'basic192-rsa15' | 'basic256-rsa15' | 'basic256-sha256' | 'aes128-sha256-rsa-oaep' | 'pub-sub-aes-128-ctr' | 'pub-sub-aes-256-ctr'
      - `authentication` NorthOPCUASettingsAuthentication, required
        - `type` 'none' | 'basic' | 'cert', required
        - `username` string
        - `password` string, nullable
        - `certFilePath` string
        - `keyFilePath` string
  - 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
      - `readDelay` number, double, required
      - `maxReadInterval` number, double, required
      - `endTime` string, required — Represents an instant in time as an ISO 8601 string.
      - `startTime` string, required — Represents an instant in time as an ISO 8601 string.
    - `caching` object, required
      - `archive` object, required
        - `retentionDuration` number, double, required
        - `enabled` boolean, required
      - `error` object, required
        - `retentionDuration` number, double, required
        - `retryCount` number, double, required
        - `retryInterval` number, double, required
      - `throttling` object, required
        - `maxNumberOfElements` number, double, required
        - `maxSize` number, double, required
        - `runMinDelay` number, double, required
      - `trigger` object, required
        - `numberOfFiles` number, double, required
        - `numberOfElements` number, double, required
        - `scanModeName` string, nullable, required
        - `scanModeId` string, required
    - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required
      - `id` string, required — The id used to match a transformer with options
      - `items` object[], required — The list of items associated to the transformer
        - `enabled` boolean, required — Whether this item is enabled.
        - `name` string, required — The name of the item.
        - `id` string, required — The item ID
      - `transformerId` string, required — The transformer to be applied.
      - `options` RecordStringUnknown, required — Construct a type with a set of properties K of type T
    - `southType` 'folder-scanner', required
    - `southSettings` SouthFolderScannerSettings, required
      - `inputFolder` string, required
      - `compression` boolean, required
      - `username` string, nullable
      - `password` string, nullable
      - `domain` string, nullable
    - `items` HistoryQueryFolderScannerItemCommandDTO[], required
      - `id` string, nullable, required
      - `name` string, required
      - `enabled` boolean, required
      - `settings` SouthFolderScannerItemSettings, required
        - `regex` string, required
        - `minAge` number, double, required
        - `preserveFiles` boolean, required
        - `ignoreModifiedDate` boolean
        - `maxFiles` number, double, required
        - `maxSize` number, double, required
        - `recursive` boolean, required
    - `northType` 'rest', required
    - `northSettings` NorthRESTSettings, required
      - `host` string, required
      - `acceptUnauthorized` boolean, required
      - `method` 'POST' | 'PUT' | 'PATCH', required
      - `endpoint` string, required
      - `timeout` number, double, required
      - `sendAs` 'file' | 'body', required
      - `successCode` number, double, required
      - `authentication` NorthRESTSettingsAuthentication, required
        - `type` 'none' | 'basic' | 'bearer' | 'api-key', required
        - `username` string
        - `password` string, nullable
        - `token` string, nullable
        - `apiKey` string
        - `apiValue` string, nullable
        - `addTo` 'header' | 'query-params'
      - `proxy` NorthRESTSettingsProxy, required
        - `useProxy` boolean, required
        - `proxyUrl` string
        - `proxyUsername` string, nullable
        - `proxyPassword` string, nullable
      - `queryParams` NorthRESTSettingsQueryParams[], required
        - `key` string, required
        - `value` string, required
      - `headers` NorthRESTSettingsHeaders[], required
        - `key` string, required
        - `value` string, required
      - `test` NorthRESTSettingsTest, required
        - `testMethod` 'GET' | 'POST' | 'PUT', required
        - `testEndpoint` string, required
        - `body` string, nullable
        - `testSuccessCode` number, double, 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
      - `readDelay` number, double, required
      - `maxReadInterval` number, double, required
      - `endTime` string, required — Represents an instant in time as an ISO 8601 string.
      - `startTime` string, required — Represents an instant in time as an ISO 8601 string.
    - `caching` object, required
      - `archive` object, required
        - `retentionDuration` number, double, required
        - `enabled` boolean, required
      - `error` object, required
        - `retentionDuration` number, double, required
        - `retryCount` number, double, required
        - `retryInterval` number, double, required
      - `throttling` object, required
        - `maxNumberOfElements` number, double, required
        - `maxSize` number, double, required
        - `runMinDelay` number, double, required
      - `trigger` object, required
        - `numberOfFiles` number, double, required
        - `numberOfElements` number, double, required
        - `scanModeName` string, nullable, required
        - `scanModeId` string, required
    - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required
      - `id` string, required — The id used to match a transformer with options
      - `items` object[], required — The list of items associated to the transformer
        - `enabled` boolean, required — Whether this item is enabled.
        - `name` string, required — The name of the item.
        - `id` string, required — The item ID
      - `transformerId` string, required — The transformer to be applied.
      - `options` RecordStringUnknown, required — Construct a type with a set of properties K of type T
    - `southType` 'folder-scanner', required
    - `southSettings` SouthFolderScannerSettings, required
      - `inputFolder` string, required
      - `compression` boolean, required
      - `username` string, nullable
      - `password` string, nullable
      - `domain` string, nullable
    - `items` HistoryQueryFolderScannerItemCommandDTO[], required
      - `id` string, nullable, required
      - `name` string, required
      - `enabled` boolean, required
      - `settings` SouthFolderScannerItemSettings, required
        - `regex` string, required
        - `minAge` number, double, required
        - `preserveFiles` boolean, required
        - `ignoreModifiedDate` boolean
        - `maxFiles` number, double, required
        - `maxSize` number, double, required
        - `recursive` boolean, required
    - `northType` 'sftp', required
    - `northSettings` NorthSFTPSettings, required
      - `host` string, required
      - `port` number, double, required
      - `authentication` 'password' | 'private-key', required
      - `username` string, required
      - `password` string, nullable
      - `privateKey` string
      - `passphrase` string, nullable
      - `remoteFolder` string, required
      - `prefix` string, nullable, required
      - `suffix` string, nullable, 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
      - `readDelay` number, double, required
      - `maxReadInterval` number, double, required
      - `endTime` string, required — Represents an instant in time as an ISO 8601 string.
      - `startTime` string, required — Represents an instant in time as an ISO 8601 string.
    - `caching` object, required
      - `archive` object, required
        - `retentionDuration` number, double, required
        - `enabled` boolean, required
      - `error` object, required
        - `retentionDuration` number, double, required
        - `retryCount` number, double, required
        - `retryInterval` number, double, required
      - `throttling` object, required
        - `maxNumberOfElements` number, double, required
        - `maxSize` number, double, required
        - `runMinDelay` number, double, required
      - `trigger` object, required
        - `numberOfFiles` number, double, required
        - `numberOfElements` number, double, required
        - `scanModeName` string, nullable, required
        - `scanModeId` string, required
    - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required
      - `id` string, required — The id used to match a transformer with options
      - `items` object[], required — The list of items associated to the transformer
        - `enabled` boolean, required — Whether this item is enabled.
        - `name` string, required — The name of the item.
        - `id` string, required — The item ID
      - `transformerId` string, required — The transformer to be applied.
      - `options` RecordStringUnknown, required — Construct a type with a set of properties K of type T
    - `southType` 'ftp', required
    - `southSettings` SouthFTPSettings, required
      - `host` string, required
      - `port` number, double, required
      - `authentication` 'none' | 'password', required
      - `username` string, nullable
      - `password` string, nullable
      - `compression` boolean, required
    - `items` HistoryQueryFTPItemCommandDTO[], required
      - `id` string, nullable, required
      - `name` string, required
      - `enabled` boolean, required
      - `settings` SouthFTPItemSettings, required
        - `remoteFolder` string, required
        - `regex` string, required
        - `minAge` number, double, required
        - `preserveFiles` boolean, required
        - `ignoreModifiedDate` boolean
        - `maxFiles` number, double, required
        - `maxSize` number, double, required
        - `recursive` boolean, required
    - `northType` 'aws-s3', required
    - `northSettings` NorthAmazonS3Settings, required
      - `bucket` string, required
      - `region` string, required
      - `folder` string, required
      - `accessKey` string, required
      - `secretKey` string, nullable, required
      - `useProxy` boolean, required
      - `proxyUrl` string, nullable
      - `proxyUsername` string, nullable
      - `proxyPassword` string, nullable
  - 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
      - `readDelay` number, double, required
      - `maxReadInterval` number, double, required
      - `endTime` string, required — Represents an instant in time as an ISO 8601 string.
      - `startTime` string, required — Represents an instant in time as an ISO 8601 string.
    - `caching` object, required
      - `archive` object, required
        - `retentionDuration` number, double, required
        - `enabled` boolean, required
      - `error` object, required
        - `retentionDuration` number, double, required
        - `retryCount` number, double, required
        - `retryInterval` number, double, required
      - `throttling` object, required
        - `maxNumberOfElements` number, double, required
        - `maxSize` number, double, required
        - `runMinDelay` number, double, required
      - `trigger` object, required
        - `numberOfFiles` number, double, required
        - `numberOfElements` number, double, required
        - `scanModeName` string, nullable, required
        - `scanModeId` string, required
    - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required
      - `id` string, required — The id used to match a transformer with options
      - `items` object[], required — The list of items associated to the transformer
        - `enabled` boolean, required — Whether this item is enabled.
        - `name` string, required — The name of the item.
        - `id` string, required — The item ID
      - `transformerId` string, required — The transformer to be applied.
      - `options` RecordStringUnknown, required — Construct a type with a set of properties K of type T
    - `southType` 'ftp', required
    - `southSettings` SouthFTPSettings, required
      - `host` string, required
      - `port` number, double, required
      - `authentication` 'none' | 'password', required
      - `username` string, nullable
      - `password` string, nullable
      - `compression` boolean, required
    - `items` HistoryQueryFTPItemCommandDTO[], required
      - `id` string, nullable, required
      - `name` string, required
      - `enabled` boolean, required
      - `settings` SouthFTPItemSettings, required
        - `remoteFolder` string, required
        - `regex` string, required
        - `minAge` number, double, required
        - `preserveFiles` boolean, required
        - `ignoreModifiedDate` boolean
        - `maxFiles` number, double, required
        - `maxSize` number, double, required
        - `recursive` boolean, required
    - `northType` 'azure-blob', required
    - `northSettings` NorthAzureBlobSettings, required
      - `useADLS` boolean, required
      - `useCustomUrl` boolean, required
      - `account` string
      - `customUrl` string
      - `container` string, required
      - `path` string, required
      - `authentication` 'access-key' | 'sas-token' | 'aad' | 'external', required
      - `accessKey` string, nullable
      - `sasToken` string, nullable
      - `tenantId` string, nullable
      - `clientId` string, nullable
      - `clientSecret` string, nullable
      - `useProxy` boolean, required
      - `proxyUrl` string
      - `proxyUsername` string, nullable
      - `proxyPassword` string, nullable
  - 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
      - `readDelay` number, double, required
      - `maxReadInterval` number, double, required
      - `endTime` string, required — Represents an instant in time as an ISO 8601 string.
      - `startTime` string, required — Represents an instant in time as an ISO 8601 string.
    - `caching` object, required
      - `archive` object, required
        - `retentionDuration` number, double, required
        - `enabled` boolean, required
      - `error` object, required
        - `retentionDuration` number, double, required
        - `retryCount` number, double, required
        - `retryInterval` number, double, required
      - `throttling` object, required
        - `maxNumberOfElements` number, double, required
        - `maxSize` number, double, required
        - `runMinDelay` number, double, required
      - `trigger` object, required
        - `numberOfFiles` number, double, required
        - `numberOfElements` number, double, required
        - `scanModeName` string, nullable, required
        - `scanModeId` string, required
    - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required
      - `id` string, required — The id used to match a transformer with options
      - `items` object[], required — The list of items associated to the transformer
        - `enabled` boolean, required — Whether this item is enabled.
        - `name` string, required — The name of the item.
        - `id` string, required — The item ID
      - `transformerId` string, required — The transformer to be applied.
      - `options` RecordStringUnknown, required — Construct a type with a set of properties K of type T
    - `southType` 'ftp', required
    - `southSettings` SouthFTPSettings, required
      - `host` string, required
      - `port` number, double, required
      - `authentication` 'none' | 'password', required
      - `username` string, nullable
      - `password` string, nullable
      - `compression` boolean, required
    - `items` HistoryQueryFTPItemCommandDTO[], required
      - `id` string, nullable, required
      - `name` string, required
      - `enabled` boolean, required
      - `settings` SouthFTPItemSettings, required
        - `remoteFolder` string, required
        - `regex` string, required
        - `minAge` number, double, required
        - `preserveFiles` boolean, required
        - `ignoreModifiedDate` boolean
        - `maxFiles` number, double, required
        - `maxSize` number, double, required
        - `recursive` boolean, required
    - `northType` 'console', required
    - `northSettings` NorthConsoleSettings, required
      - `verbose` boolean, 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
      - `readDelay` number, double, required
      - `maxReadInterval` number, double, required
      - `endTime` string, required — Represents an instant in time as an ISO 8601 string.
      - `startTime` string, required — Represents an instant in time as an ISO 8601 string.
    - `caching` object, required
      - `archive` object, required
        - `retentionDuration` number, double, required
        - `enabled` boolean, required
      - `error` object, required
        - `retentionDuration` number, double, required
        - `retryCount` number, double, required
        - `retryInterval` number, double, required
      - `throttling` object, required
        - `maxNumberOfElements` number, double, required
        - `maxSize` number, double, required
        - `runMinDelay` number, double, required
      - `trigger` object, required
        - `numberOfFiles` number, double, required
        - `numberOfElements` number, double, required
        - `scanModeName` string, nullable, required
        - `scanModeId` string, required
    - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required
      - `id` string, required — The id used to match a transformer with options
      - `items` object[], required — The list of items associated to the transformer
        - `enabled` boolean, required — Whether this item is enabled.
        - `name` string, required — The name of the item.
        - `id` string, required — The item ID
      - `transformerId` string, required — The transformer to be applied.
      - `options` RecordStringUnknown, required — Construct a type with a set of properties K of type T
    - `southType` 'ftp', required
    - `southSettings` SouthFTPSettings, required
      - `host` string, required
      - `port` number, double, required
      - `authentication` 'none' | 'password', required
      - `username` string, nullable
      - `password` string, nullable
      - `compression` boolean, required
    - `items` HistoryQueryFTPItemCommandDTO[], required
      - `id` string, nullable, required
      - `name` string, required
      - `enabled` boolean, required
      - `settings` SouthFTPItemSettings, required
        - `remoteFolder` string, required
        - `regex` string, required
        - `minAge` number, double, required
        - `preserveFiles` boolean, required
        - `ignoreModifiedDate` boolean
        - `maxFiles` number, double, required
        - `maxSize` number, double, required
        - `recursive` boolean, required
    - `northType` 'file-writer', required
    - `northSettings` NorthFileWriterSettings, required
      - `outputFolder` string, required
      - `prefix` string, nullable, required
      - `suffix` string, nullable, required
      - `username` string, nullable
      - `password` string, nullable
      - `domain` string, nullable
  - 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
      - `readDelay` number, double, required
      - `maxReadInterval` number, double, required
      - `endTime` string, required — Represents an instant in time as an ISO 8601 string.
      - `startTime` string, required — Represents an instant in time as an ISO 8601 string.
    - `caching` object, required
      - `archive` object, required
        - `retentionDuration` number, double, required
        - `enabled` boolean, required
      - `error` object, required
        - `retentionDuration` number, double, required
        - `retryCount` number, double, required
        - `retryInterval` number, double, required
      - `throttling` object, required
        - `maxNumberOfElements` number, double, required
        - `maxSize` number, double, required
        - `runMinDelay` number, double, required
      - `trigger` object, required
        - `numberOfFiles` number, double, required
        - `numberOfElements` number, double, required
        - `scanModeName` string, nullable, required
        - `scanModeId` string, required
    - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required
      - `id` string, required — The id used to match a transformer with options
      - `items` object[], required — The list of items associated to the transformer
        - `enabled` boolean, required — Whether this item is enabled.
        - `name` string, required — The name of the item.
        - `id` string, required — The item ID
      - `transformerId` string, required — The transformer to be applied.
      - `options` RecordStringUnknown, required — Construct a type with a set of properties K of type T
    - `southType` 'ftp', required
    - `southSettings` SouthFTPSettings, required
      - `host` string, required
      - `port` number, double, required
      - `authentication` 'none' | 'password', required
      - `username` string, nullable
      - `password` string, nullable
      - `compression` boolean, required
    - `items` HistoryQueryFTPItemCommandDTO[], required
      - `id` string, nullable, required
      - `name` string, required
      - `enabled` boolean, required
      - `settings` SouthFTPItemSettings, required
        - `remoteFolder` string, required
        - `regex` string, required
        - `minAge` number, double, required
        - `preserveFiles` boolean, required
        - `ignoreModifiedDate` boolean
        - `maxFiles` number, double, required
        - `maxSize` number, double, required
        - `recursive` boolean, required
    - `northType` 'modbus', required
    - `northSettings` NorthModbusSettings, required
      - `host` string, required
      - `port` number, double, required
      - `connectTimeout` number, double, required
      - `retryInterval` number, double, required
      - `slaveId` number, double, required
      - `addressOffset` 'modbus' | 'jbus', required
      - `endianness` 'big-endian' | 'little-endian', required
      - `swapBytesInWords` boolean, required
      - `swapWordsInDWords` boolean, required
  - 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
      - `readDelay` number, double, required
      - `maxReadInterval` number, double, required
      - `endTime` string, required — Represents an instant in time as an ISO 8601 string.
      - `startTime` string, required — Represents an instant in time as an ISO 8601 string.
    - `caching` object, required
      - `archive` object, required
        - `retentionDuration` number, double, required
        - `enabled` boolean, required
      - `error` object, required
        - `retentionDuration` number, double, required
        - `retryCount` number, double, required
        - `retryInterval` number, double, required
      - `throttling` object, required
        - `maxNumberOfElements` number, double, required
        - `maxSize` number, double, required
        - `runMinDelay` number, double, required
      - `trigger` object, required
        - `numberOfFiles` number, double, required
        - `numberOfElements` number, double, required
        - `scanModeName` string, nullable, required
        - `scanModeId` string, required
    - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required
      - `id` string, required — The id used to match a transformer with options
      - `items` object[], required — The list of items associated to the transformer
        - `enabled` boolean, required — Whether this item is enabled.
        - `name` string, required — The name of the item.
        - `id` string, required — The item ID
      - `transformerId` string, required — The transformer to be applied.
      - `options` RecordStringUnknown, required — Construct a type with a set of properties K of type T
    - `southType` 'ftp', required
    - `southSettings` SouthFTPSettings, required
      - `host` string, required
      - `port` number, double, required
      - `authentication` 'none' | 'password', required
      - `username` string, nullable
      - `password` string, nullable
      - `compression` boolean, required
    - `items` HistoryQueryFTPItemCommandDTO[], required
      - `id` string, nullable, required
      - `name` string, required
      - `enabled` boolean, required
      - `settings` SouthFTPItemSettings, required
        - `remoteFolder` string, required
        - `regex` string, required
        - `minAge` number, double, required
        - `preserveFiles` boolean, required
        - `ignoreModifiedDate` boolean
        - `maxFiles` number, double, required
        - `maxSize` number, double, required
        - `recursive` boolean, required
    - `northType` 'mqtt', required
    - `northSettings` NorthMQTTSettings, required
      - `url` string, required
      - `qos` '0' | '1' | '2', required
      - `persistent` boolean
      - `authentication` NorthMQTTSettingsAuthentication, required
        - `type` 'none' | 'basic' | 'cert', required
        - `username` string
        - `password` string, nullable
        - `certFilePath` string
        - `keyFilePath` string
        - `caFilePath` string
      - `rejectUnauthorized` boolean, required
      - `reconnectPeriod` number, double, required
      - `connectTimeout` number, double, required
  - 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
      - `readDelay` number, double, required
      - `maxReadInterval` number, double, required
      - `endTime` string, required — Represents an instant in time as an ISO 8601 string.
      - `startTime` string, required — Represents an instant in time as an ISO 8601 string.
    - `caching` object, required
      - `archive` object, required
        - `retentionDuration` number, double, required
        - `enabled` boolean, required
      - `error` object, required
        - `retentionDuration` number, double, required
        - `retryCount` number, double, required
        - `retryInterval` number, double, required
      - `throttling` object, required
        - `maxNumberOfElements` number, double, required
        - `maxSize` number, double, required
        - `runMinDelay` number, double, required
      - `trigger` object, required
        - `numberOfFiles` number, double, required
        - `numberOfElements` number, double, required
        - `scanModeName` string, nullable, required
        - `scanModeId` string, required
    - `northTransformers` HistoryTransformerCommandDTOWithOptions[], required
      - `id` string, required — The id used to match a transformer with options
      - `items` object[], required — The list of items associated to the transformer
- … truncated; see the full OpenAPI document linked below

## Response `204`

No Content

---

[API](https://skmtc.net/optimistiksas/apis/oibus-api.md) · [All operations](https://skmtc.net/optimistiksas/apis/oibus-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/optimistiksas/oibus-api/versions/743d1b62f042/schema)