--- title: "Search history query items" method: GET path: "/api/history/{historyId}/items/search" tags: ["History Queries"] --- # Search history query items `GET /api/history/{historyId}/items/search` Searches for items in a history query with optional filtering ## Path parameters - `historyId` string, required ## Query parameters - `name` string, required - `enabled` boolean, required - `page` number, double ## Response `200` Paginated list of items - PageHistoryQueryItemDTO — Represents a paginated response containing an array of elements. - `content` HistoryQueryItemDTO[], required — The content of the page - an array of elements. - union — Data Transfer Object for a history query item. Represents an individual data point to be queried. - HistoryQueryADSItemDTO — History query item DTO for Beckhoff ADS. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required - `enabled` boolean, required - `settings` SouthADSItemSettings, required - `address` string, required - HistoryQueryFolderScannerItemDTO — History query item DTO for the Folder Scanner. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required - `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 - HistoryQueryFTPItemDTO — History query item DTO for FTP file transfer. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required - `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 - HistoryQueryInfluxDBItemDTO — History query item DTO for InfluxDB time series database. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required - `enabled` boolean, required - `settings` SouthInfluxDBItemSettings, required - `query` string, required - `requestTimeout` number, double, required - HistoryQueryModbusItemDTO — History query item DTO for Modbus. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required - `enabled` boolean, required - `settings` SouthModbusItemSettings, required - `address` string, required - `modbusType` 'coil' | 'discrete-input' | 'input-register' | 'holding-register', required - `data` SouthModbusItemSettingsData - `dataType` 'uint16' | 'int16' | 'uint32' | 'int32' | 'big-uint64' | 'big-int64' | 'float' | 'double' | 'bit', required - `bitIndex` number, double - `multiplierCoefficient` number, double, required - HistoryQueryMQTTItemDTO — History query item DTO for MQTT. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required - `enabled` boolean, required - `settings` SouthMQTTItemSettings, required - `topic` string, required - HistoryQueryMSSQLItemDTO — History query item DTO for Microsoft SQL Server. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required - `enabled` boolean, required - `settings` SouthMSSQLItemSettings, required - `query` string, required - `dateTimeFields` SouthMSSQLItemSettingsDateTimeFields[], nullable, required - `fieldName` string, required - `useAsReference` boolean, required - `type` 'string' | 'date' | 'date-time' | 'date-time-2' | 'date-time-offset' | 'small-date-time' | 'iso-string' | 'unix-epoch' | 'unix-epoch-ms', required - `timezone` string — Represents a timezone as an IANA timezone string. - `format` string - `locale` string - `serialization` SouthMSSQLItemSettingsSerialization, required - `type` 'csv', required - `filename` string, required - `delimiter` 'DOT' | 'SEMI_COLON' | 'COLON' | 'COMMA' | 'NON_BREAKING_SPACE' | 'SLASH' | 'TAB' | 'PIPE', required - `compression` boolean, required - `outputTimestampFormat` string, required - `outputTimezone` string, required — Represents a timezone as an IANA timezone string. - HistoryQueryMySQLItemDTO — History query item DTO for MySQL. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required - `enabled` boolean, required - `settings` SouthMySQLItemSettings, required - `query` string, required - `requestTimeout` number, double, required - `dateTimeFields` SouthMySQLItemSettingsDateTimeFields[], nullable, required - `fieldName` string, required - `useAsReference` boolean, required - `type` 'string' | 'date-time' | 'iso-string' | 'unix-epoch' | 'unix-epoch-ms', required - `timezone` string — Represents a timezone as an IANA timezone string. - `format` string - `locale` string - `serialization` SouthMySQLItemSettingsSerialization, required - `type` 'csv', required - `filename` string, required - `delimiter` 'DOT' | 'SEMI_COLON' | 'COLON' | 'COMMA' | 'NON_BREAKING_SPACE' | 'SLASH' | 'TAB' | 'PIPE', required - `compression` boolean, required - `outputTimestampFormat` string, required - `outputTimezone` string, required — Represents a timezone as an IANA timezone string. - HistoryQueryODBCItemDTO — History query item DTO for ODBC. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required - `enabled` boolean, required - `settings` SouthODBCItemSettings, required - `query` string, required - `dateTimeFields` SouthODBCItemSettingsDateTimeFields[], nullable, required - `fieldName` string, required - `useAsReference` boolean, required - `type` 'string' | 'iso-string' | 'unix-epoch' | 'unix-epoch-ms', required - `timezone` string — Represents a timezone as an IANA timezone string. - `format` string - `locale` string - `serialization` SouthODBCItemSettingsSerialization, required - `type` 'csv', required - `filename` string, required - `delimiter` 'DOT' | 'SEMI_COLON' | 'COLON' | 'COMMA' | 'NON_BREAKING_SPACE' | 'SLASH' | 'TAB' | 'PIPE', required - `compression` boolean, required - `outputTimestampFormat` string, required - `outputTimezone` string, required — Represents a timezone as an IANA timezone string. - HistoryQueryOIAnalyticsItemDTO — History query item DTO for OIAnalytics. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required - `enabled` boolean, required - `settings` SouthOIAnalyticsItemSettings, required - `endpoint` string, required - `queryParams` SouthOIAnalyticsItemSettingsQueryParams[], required - `key` string, required - `value` string, required - `serialization` SouthOIAnalyticsItemSettingsSerialization, required - `type` 'csv', required - `filename` string, required - `delimiter` 'DOT' | 'SEMI_COLON' | 'COLON' | 'COMMA' | 'NON_BREAKING_SPACE' | 'SLASH' | 'TAB' | 'PIPE', required - `compression` boolean, required - `outputTimestampFormat` string, required - `outputTimezone` string, required — Represents a timezone as an IANA timezone string. - HistoryQueryOLEDBItemDTO — History query item DTO for OLE DB. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required - `enabled` boolean, required - `settings` SouthOLEDBItemSettings, required - `query` string, required - `dateTimeFields` SouthOLEDBItemSettingsDateTimeFields[], nullable, required - `fieldName` string, required - `useAsReference` boolean, required - `type` 'string' | 'iso-string' | 'unix-epoch' | 'unix-epoch-ms', required - `timezone` string — Represents a timezone as an IANA timezone string. - `format` string - `locale` string - `serialization` SouthOLEDBItemSettingsSerialization, required - `type` 'csv', required - `filename` string, required - `delimiter` 'DOT' | 'SEMI_COLON' | 'COLON' | 'COMMA' | 'NON_BREAKING_SPACE' | 'SLASH' | 'TAB' | 'PIPE', required - `compression` boolean, required - `outputTimestampFormat` string, required - `outputTimezone` string, required — Represents a timezone as an IANA timezone string. - HistoryQueryOPCItemDTO — History query item DTO for classic OPC (OLE for Process Control). - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required - `enabled` boolean, required - `settings` SouthOPCItemSettings, required - `nodeId` string, required - `aggregate` 'raw' | 'interpolative' | 'total' | 'average' | 'time-average' | 'count' | 'stdev' | 'minimum-actual-time' | 'minimum' | 'maximum-actual-time' | 'maximum' | 'start' | 'end' | 'delta' | 'reg-slope' | 'reg-const' | 'reg-dev' | 'variance' | 'range' | 'duration-good' | 'duration-bad' | 'percent-good' | 'percent-bad' | 'worst-quality' | 'annotations', required - `resampling` 'none' | '1s' | '10s' | '30s' | '1min' | '1h' | '1d' - HistoryQueryOPCUAItemDTO — History query item DTO for OPC UA. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required - `enabled` boolean, required - `settings` SouthOPCUAItemSettings, required - `nodeId` string, required - `mode` 'da' | 'ha', required - `haMode` SouthOPCUAItemSettingsHaMode - `aggregate` 'raw' | 'average' | 'count' | 'minimum' | 'maximum', required - `resampling` 'none' | '1s' | '10s' | '30s' | '1min' | '1h' | '1d' - `timestampOrigin` 'oibus' | 'point' | 'server' - HistoryQueryOracleItemDTO — History query item DTO for Oracle Database. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required - `enabled` boolean, required - `settings` SouthOracleItemSettings, required - `query` string, required - `requestTimeout` number, double, required - `dateTimeFields` SouthOracleItemSettingsDateTimeFields[], nullable, required - `fieldName` string, required - `useAsReference` boolean, required - `type` 'string' | 'date-time' | 'iso-string' | 'unix-epoch' | 'unix-epoch-ms', required - `timezone` string — Represents a timezone as an IANA timezone string. - `format` string - `locale` string - `serialization` SouthOracleItemSettingsSerialization, required - `type` 'csv', required - `filename` string, required - `delimiter` 'DOT' | 'SEMI_COLON' | 'COLON' | 'COMMA' | 'NON_BREAKING_SPACE' | 'SLASH' | 'TAB' | 'PIPE', required - `compression` boolean, required - `outputTimestampFormat` string, required - `outputTimezone` string, required — Represents a timezone as an IANA timezone string. - HistoryQueryOsisoftPIItemDTO — History query item DTO for OSIsoft PI System. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required - `enabled` boolean, required - `settings` SouthPIItemSettings, required - `type` 'point-id' | 'point-query', required - `piPoint` string - `piQuery` string - HistoryQueryPostgreSQLItemDTO — History query item DTO for PostgreSQL. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required - `enabled` boolean, required - `settings` SouthPostgreSQLItemSettings, required - `query` string, required - `dateTimeFields` SouthPostgreSQLItemSettingsDateTimeFields[], nullable, required - `fieldName` string, required - `useAsReference` boolean, required - `type` 'string' | 'iso-string' | 'unix-epoch' | 'unix-epoch-ms' | 'timestamp' | 'timestamptz', required - `timezone` string — Represents a timezone as an IANA timezone string. - `format` string - `locale` string - `serialization` SouthPostgreSQLItemSettingsSerialization, required - `type` 'csv', required - `filename` string, required - `delimiter` 'DOT' | 'SEMI_COLON' | 'COLON' | 'COMMA' | 'NON_BREAKING_SPACE' | 'SLASH' | 'TAB' | 'PIPE', required - `compression` boolean, required - `outputTimestampFormat` string, required - `outputTimezone` string, required — Represents a timezone as an IANA timezone string. - HistoryQueryRESTItemDTO — History query item DTO for the REST API. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required - `enabled` boolean, required - `settings` SouthRestItemSettings, required - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE', required - `endpoint` string, required - `returnType` 'file' | 'body', required - `queryParams` SouthRestItemSettingsQueryParams[], required - `key` string, required - `value` string, required - `dateTimeInput` SouthRestItemSettingsQueryParamsDateTimeInput - … - `headers` SouthRestItemSettingsHeaders[], required - `key` string, required - `value` string, required - `dateTimeInput` SouthRestItemSettingsHeadersDateTimeInput - … - `body` SouthRestItemSettingsBody - `content` string, nullable, required - `dateTimeInput` SouthRestItemSettingsBodyDateTimeInput - … - `trackingInstant` SouthRestItemSettingsTrackingInstant - `trackInstant` boolean, required - `jsonPath` string - `dateTimeInput` SouthRestItemSettingsTrackingInstantDateTimeInput - … - HistoryQuerySFTPItemDTO — History query item DTO for SFTP file transfer. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required - `enabled` boolean, required - `settings` SouthSFTPItemSettings, required - `remoteFolder` string, required - `regex` string, required - `minAge` number, double, required - `preserveFiles` boolean, required - `ignoreModifiedDate` boolean - `maxFiles` number, double, required - `maxSize` number, double, required - `recursive` boolean, required - HistoryQuerySQLiteItemDTO — History query item DTO for SQLite. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required - `enabled` boolean, required - `settings` SouthSQLiteItemSettings, required - `query` string, required - `dateTimeFields` SouthSQLiteItemSettingsDateTimeFields[], nullable, required - `fieldName` string, required - `useAsReference` boolean, required - `type` 'string' | 'iso-string' | 'unix-epoch' | 'unix-epoch-ms', required - `timezone` string — Represents a timezone as an IANA timezone string. - `format` string - `locale` string - `serialization` SouthSQLiteItemSettingsSerialization, required - `type` 'csv', required - `filename` string, required - `delimiter` 'DOT' | 'SEMI_COLON' | 'COLON' | 'COMMA' | 'NON_BREAKING_SPACE' | 'SLASH' | 'TAB' | 'PIPE', required - `compression` boolean, required - `outputTimestampFormat` string, required - `outputTimezone` string, required — Represents a timezone as an IANA timezone string. - `totalElements` number, double, required — The total number of elements across all pages. - `size` number, double, required — The size of the page, i.e., the maximum number of elements per page. - `number` number, double, required — The number of the current page, starting at 0. - `totalPages` number, double, required — The total number of pages (which can be 0 if there are no elements). --- [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/743d1b62f042/schema)