--- title: "Get north connector by ID" method: GET path: "/api/north/{northId}" tags: ["North Connectors"] --- # Get north connector by ID `GET /api/north/{northId}` Retrieves a specific north connector by its unique identifier ## Path parameters - `northId` string, required ## Response `200` The north connector object - union — Data Transfer Object for a North connector. Contains all configuration details of a North connector. - NorthConnectorAmazonS3DTO — North connector configuration for Amazon S3. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the North connector. - `type` 'aws-s3', required — The type of the North connector. - `description` string, required — The description of the North connector. - `enabled` boolean, required — Whether the North connector is enabled. - `settings` NorthAmazonS3Settings, required - `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 - `caching` object, required — The caching configuration for the North connector. - `archive` object, required — The archive configuration for caching. - `retentionDuration` number, double, required — The duration (in ms) to retain archived files. - `enabled` boolean, required — Whether archiving is enabled. - `error` object, required — The error handling configuration for caching. - `retentionDuration` number, double, required — The duration (in ms) to retain error files. - `retryCount` number, double, required — The maximum number of retry attempts. - `retryInterval` number, double, required — The interval (in ms) between retry attempts. - `throttling` object, required — The throttling configuration for caching. - `maxNumberOfElements` number, double, required — The maximum number of elements in the cache before sending. - `maxSize` number, double, required — The maximum size (in bytes) of the cache before sending. - `runMinDelay` number, double, required — The minimum delay (in ms) between runs. - `trigger` object, required — The trigger configuration for caching. - `numberOfFiles` number, double, required — The number of files to trigger a send. - `numberOfElements` number, double, required — The number of elements to trigger a send. - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `transformers` TransformerDTOWithOptions[], required — The list of transformers applied to the data. - `id` string, required — The id used to match a transformer with options - `source` union, required - SourceOriginSouthDTO - `type` 'south', required - `south` SouthConnectorLightDTO, required — Lightweight Data Transfer Object for a South connector. Contains only essential information about a South connector for listing purposes. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the South connector. - `type` 'opcua' | 'mqtt' | 'modbus' | 'oianalytics' | 'ads' | 'folder-scanner' | 'ftp' | 'influxdb' | 'mssql' | 'mysql' | 'odbc' | 'oledb' | 'opc' | 'oracle' | 'osisoft-pi' | 'postgresql' | 'rest' | 'sftp' | 'sqlite', required — Type representing the possible types for a South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector is enabled and active. - `group` SouthItemGroupLightDTO - `id` string, required - `name` string, required — The name of the group. - `items` ItemLightDTO[], required — The list of items associated to the transformer - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the item. - `enabled` boolean, required — Whether this item is enabled. - SourceOriginOIAnalyticsDTO - `type` 'oianalytics-setpoint', required - SourceOriginAPIDTO - `type` 'oibus-api', required - `dataSourceId` string, required - `transformer` union, required — Union type representing either a custom or standard transformer. - CustomTransformerDTO — Data Transfer Object for a custom transformer. Extends the base transformer with custom-specific properties. - `id` string, required — The unique identifier of the transformer. - `type` 'custom', required — The type of the transformer (always 'custom' for this interface). - `inputType` string, required - `outputType` string, required - `manifest` OIBusObjectAttribute, required — Object-type attribute that groups related attributes. Used to create nested form structures. - `type` 'object', required — The type of this attribute (always "object"). - `key` string, required — The unique key/identifier for this attribute. - `translationKey` string, required — Translation key for internationalization. - `validators` OIBusAttributeValidator[], required — Validators to apply to this attribute. - … - `attributes` OIBusAttribute[], required — Child attributes contained within this object. - … - `enablingConditions` OIBusEnablingCondition[], required — Conditions that determine when this object should be enabled. - … - `displayProperties` OIBusObjectDisplayProperties, required — Display properties for object-type form attributes. Controls visibility and styling of object containers. - … - `name` string, required — The name of the custom transformer. - `description` string, required — A description of what the custom transformer does. - `customCode` string, required — The custom JavaScript code that implements the transformation logic. - `language` string, required - `timeout` number, double, required — The maximum execution time for the custom code in milliseconds. - `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. - StandardTransformerDTO — Data Transfer Object for a standard transformer. Extends the base transformer with standard-specific properties. - `id` string, required — The unique identifier of the transformer. - `type` 'standard', required — The type of the transformer (always 'standard' for this interface). - `inputType` string, required - `outputType` string, required - `manifest` OIBusObjectAttribute, required — Object-type attribute that groups related attributes. Used to create nested form structures. - `type` 'object', required — The type of this attribute (always "object"). - `key` string, required — The unique key/identifier for this attribute. - `translationKey` string, required — Translation key for internationalization. - `validators` OIBusAttributeValidator[], required — Validators to apply to this attribute. - … - `attributes` OIBusAttribute[], required — Child attributes contained within this object. - … - `enablingConditions` OIBusEnablingCondition[], required — Conditions that determine when this object should be enabled. - … - `displayProperties` OIBusObjectDisplayProperties, required — Display properties for object-type form attributes. Controls visibility and styling of object containers. - … - `functionName` string, required — The name of the standard function that implements the transformation. - `options` RecordStringUnknown, required — Construct a type with a set of properties K of type T - NorthConnectorAzureBlobDTO — North connector configuration for Azure Blob Storage. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the North connector. - `type` 'azure-blob', required — The type of the North connector. - `description` string, required — The description of the North connector. - `enabled` boolean, required — Whether the North connector is enabled. - `settings` NorthAzureBlobSettings, required - `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 - `caching` object, required — The caching configuration for the North connector. - `archive` object, required — The archive configuration for caching. - `retentionDuration` number, double, required — The duration (in ms) to retain archived files. - `enabled` boolean, required — Whether archiving is enabled. - `error` object, required — The error handling configuration for caching. - `retentionDuration` number, double, required — The duration (in ms) to retain error files. - `retryCount` number, double, required — The maximum number of retry attempts. - `retryInterval` number, double, required — The interval (in ms) between retry attempts. - `throttling` object, required — The throttling configuration for caching. - `maxNumberOfElements` number, double, required — The maximum number of elements in the cache before sending. - `maxSize` number, double, required — The maximum size (in bytes) of the cache before sending. - `runMinDelay` number, double, required — The minimum delay (in ms) between runs. - `trigger` object, required — The trigger configuration for caching. - `numberOfFiles` number, double, required — The number of files to trigger a send. - `numberOfElements` number, double, required — The number of elements to trigger a send. - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `transformers` TransformerDTOWithOptions[], required — The list of transformers applied to the data. - `id` string, required — The id used to match a transformer with options - `source` union, required - SourceOriginSouthDTO - `type` 'south', required - `south` SouthConnectorLightDTO, required — Lightweight Data Transfer Object for a South connector. Contains only essential information about a South connector for listing purposes. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the South connector. - `type` 'opcua' | 'mqtt' | 'modbus' | 'oianalytics' | 'ads' | 'folder-scanner' | 'ftp' | 'influxdb' | 'mssql' | 'mysql' | 'odbc' | 'oledb' | 'opc' | 'oracle' | 'osisoft-pi' | 'postgresql' | 'rest' | 'sftp' | 'sqlite', required — Type representing the possible types for a South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector is enabled and active. - `group` SouthItemGroupLightDTO - `id` string, required - `name` string, required — The name of the group. - `items` ItemLightDTO[], required — The list of items associated to the transformer - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the item. - `enabled` boolean, required — Whether this item is enabled. - SourceOriginOIAnalyticsDTO - `type` 'oianalytics-setpoint', required - SourceOriginAPIDTO - `type` 'oibus-api', required - `dataSourceId` string, required - `transformer` union, required — Union type representing either a custom or standard transformer. - CustomTransformerDTO — Data Transfer Object for a custom transformer. Extends the base transformer with custom-specific properties. - `id` string, required — The unique identifier of the transformer. - `type` 'custom', required — The type of the transformer (always 'custom' for this interface). - `inputType` string, required - `outputType` string, required - `manifest` OIBusObjectAttribute, required — Object-type attribute that groups related attributes. Used to create nested form structures. - `type` 'object', required — The type of this attribute (always "object"). - `key` string, required — The unique key/identifier for this attribute. - `translationKey` string, required — Translation key for internationalization. - `validators` OIBusAttributeValidator[], required — Validators to apply to this attribute. - … - `attributes` OIBusAttribute[], required — Child attributes contained within this object. - … - `enablingConditions` OIBusEnablingCondition[], required — Conditions that determine when this object should be enabled. - … - `displayProperties` OIBusObjectDisplayProperties, required — Display properties for object-type form attributes. Controls visibility and styling of object containers. - … - `name` string, required — The name of the custom transformer. - `description` string, required — A description of what the custom transformer does. - `customCode` string, required — The custom JavaScript code that implements the transformation logic. - `language` string, required - `timeout` number, double, required — The maximum execution time for the custom code in milliseconds. - `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. - StandardTransformerDTO — Data Transfer Object for a standard transformer. Extends the base transformer with standard-specific properties. - `id` string, required — The unique identifier of the transformer. - `type` 'standard', required — The type of the transformer (always 'standard' for this interface). - `inputType` string, required - `outputType` string, required - `manifest` OIBusObjectAttribute, required — Object-type attribute that groups related attributes. Used to create nested form structures. - `type` 'object', required — The type of this attribute (always "object"). - `key` string, required — The unique key/identifier for this attribute. - `translationKey` string, required — Translation key for internationalization. - `validators` OIBusAttributeValidator[], required — Validators to apply to this attribute. - … - `attributes` OIBusAttribute[], required — Child attributes contained within this object. - … - `enablingConditions` OIBusEnablingCondition[], required — Conditions that determine when this object should be enabled. - … - `displayProperties` OIBusObjectDisplayProperties, required — Display properties for object-type form attributes. Controls visibility and styling of object containers. - … - `functionName` string, required — The name of the standard function that implements the transformation. - `options` RecordStringUnknown, required — Construct a type with a set of properties K of type T - NorthConnectorConsoleDTO — North connector configuration for the Console debug output. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the North connector. - `type` 'console', required — The type of the North connector. - `description` string, required — The description of the North connector. - `enabled` boolean, required — Whether the North connector is enabled. - `settings` NorthConsoleSettings, required - `verbose` boolean, required - `caching` object, required — The caching configuration for the North connector. - `archive` object, required — The archive configuration for caching. - `retentionDuration` number, double, required — The duration (in ms) to retain archived files. - `enabled` boolean, required — Whether archiving is enabled. - `error` object, required — The error handling configuration for caching. - `retentionDuration` number, double, required — The duration (in ms) to retain error files. - `retryCount` number, double, required — The maximum number of retry attempts. - `retryInterval` number, double, required — The interval (in ms) between retry attempts. - `throttling` object, required — The throttling configuration for caching. - `maxNumberOfElements` number, double, required — The maximum number of elements in the cache before sending. - `maxSize` number, double, required — The maximum size (in bytes) of the cache before sending. - `runMinDelay` number, double, required — The minimum delay (in ms) between runs. - `trigger` object, required — The trigger configuration for caching. - `numberOfFiles` number, double, required — The number of files to trigger a send. - `numberOfElements` number, double, required — The number of elements to trigger a send. - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `transformers` TransformerDTOWithOptions[], required — The list of transformers applied to the data. - `id` string, required — The id used to match a transformer with options - `source` union, required - SourceOriginSouthDTO - `type` 'south', required - `south` SouthConnectorLightDTO, required — Lightweight Data Transfer Object for a South connector. Contains only essential information about a South connector for listing purposes. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the South connector. - `type` 'opcua' | 'mqtt' | 'modbus' | 'oianalytics' | 'ads' | 'folder-scanner' | 'ftp' | 'influxdb' | 'mssql' | 'mysql' | 'odbc' | 'oledb' | 'opc' | 'oracle' | 'osisoft-pi' | 'postgresql' | 'rest' | 'sftp' | 'sqlite', required — Type representing the possible types for a South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector is enabled and active. - `group` SouthItemGroupLightDTO - `id` string, required - `name` string, required — The name of the group. - `items` ItemLightDTO[], required — The list of items associated to the transformer - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the item. - `enabled` boolean, required — Whether this item is enabled. - SourceOriginOIAnalyticsDTO - `type` 'oianalytics-setpoint', required - SourceOriginAPIDTO - `type` 'oibus-api', required - `dataSourceId` string, required - `transformer` union, required — Union type representing either a custom or standard transformer. - CustomTransformerDTO — Data Transfer Object for a custom transformer. Extends the base transformer with custom-specific properties. - `id` string, required — The unique identifier of the transformer. - `type` 'custom', required — The type of the transformer (always 'custom' for this interface). - `inputType` string, required - `outputType` string, required - `manifest` OIBusObjectAttribute, required — Object-type attribute that groups related attributes. Used to create nested form structures. - `type` 'object', required — The type of this attribute (always "object"). - `key` string, required — The unique key/identifier for this attribute. - `translationKey` string, required — Translation key for internationalization. - `validators` OIBusAttributeValidator[], required — Validators to apply to this attribute. - … - `attributes` OIBusAttribute[], required — Child attributes contained within this object. - … - `enablingConditions` OIBusEnablingCondition[], required — Conditions that determine when this object should be enabled. - … - `displayProperties` OIBusObjectDisplayProperties, required — Display properties for object-type form attributes. Controls visibility and styling of object containers. - … - `name` string, required — The name of the custom transformer. - `description` string, required — A description of what the custom transformer does. - `customCode` string, required — The custom JavaScript code that implements the transformation logic. - `language` string, required - `timeout` number, double, required — The maximum execution time for the custom code in milliseconds. - `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. - StandardTransformerDTO — Data Transfer Object for a standard transformer. Extends the base transformer with standard-specific properties. - `id` string, required — The unique identifier of the transformer. - `type` 'standard', required — The type of the transformer (always 'standard' for this interface). - `inputType` string, required - `outputType` string, required - `manifest` OIBusObjectAttribute, required — Object-type attribute that groups related attributes. Used to create nested form structures. - `type` 'object', required — The type of this attribute (always "object"). - `key` string, required — The unique key/identifier for this attribute. - `translationKey` string, required — Translation key for internationalization. - `validators` OIBusAttributeValidator[], required — Validators to apply to this attribute. - … - `attributes` OIBusAttribute[], required — Child attributes contained within this object. - … - `enablingConditions` OIBusEnablingCondition[], required — Conditions that determine when this object should be enabled. - … - `displayProperties` OIBusObjectDisplayProperties, required — Display properties for object-type form attributes. Controls visibility and styling of object containers. - … - `functionName` string, required — The name of the standard function that implements the transformation. - `options` RecordStringUnknown, required — Construct a type with a set of properties K of type T - NorthConnectorFileWriterDTO — North connector configuration for the File Writer. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the North connector. - `type` 'file-writer', required — The type of the North connector. - `description` string, required — The description of the North connector. - `enabled` boolean, required — Whether the North connector is enabled. - `settings` NorthFileWriterSettings, required - `outputFolder` string, required - `prefix` string, nullable, required - `suffix` string, nullable, required - `username` string, nullable - `password` string, nullable - `domain` string, nullable - `caching` object, required — The caching configuration for the North connector. - `archive` object, required — The archive configuration for caching. - `retentionDuration` number, double, required — The duration (in ms) to retain archived files. - `enabled` boolean, required — Whether archiving is enabled. - `error` object, required — The error handling configuration for caching. - `retentionDuration` number, double, required — The duration (in ms) to retain error files. - `retryCount` number, double, required — The maximum number of retry attempts. - `retryInterval` number, double, required — The interval (in ms) between retry attempts. - `throttling` object, required — The throttling configuration for caching. - `maxNumberOfElements` number, double, required — The maximum number of elements in the cache before sending. - `maxSize` number, double, required — The maximum size (in bytes) of the cache before sending. - `runMinDelay` number, double, required — The minimum delay (in ms) between runs. - `trigger` object, required — The trigger configuration for caching. - `numberOfFiles` number, double, required — The number of files to trigger a send. - `numberOfElements` number, double, required — The number of elements to trigger a send. - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `transformers` TransformerDTOWithOptions[], required — The list of transformers applied to the data. - `id` string, required — The id used to match a transformer with options - `source` union, required - SourceOriginSouthDTO - `type` 'south', required - `south` SouthConnectorLightDTO, required — Lightweight Data Transfer Object for a South connector. Contains only essential information about a South connector for listing purposes. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the South connector. - `type` 'opcua' | 'mqtt' | 'modbus' | 'oianalytics' | 'ads' | 'folder-scanner' | 'ftp' | 'influxdb' | 'mssql' | 'mysql' | 'odbc' | 'oledb' | 'opc' | 'oracle' | 'osisoft-pi' | 'postgresql' | 'rest' | 'sftp' | 'sqlite', required — Type representing the possible types for a South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector is enabled and active. - `group` SouthItemGroupLightDTO - `id` string, required - `name` string, required — The name of the group. - `items` ItemLightDTO[], required — The list of items associated to the transformer - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the item. - `enabled` boolean, required — Whether this item is enabled. - SourceOriginOIAnalyticsDTO - `type` 'oianalytics-setpoint', required - SourceOriginAPIDTO - `type` 'oibus-api', required - `dataSourceId` string, required - `transformer` union, required — Union type representing either a custom or standard transformer. - CustomTransformerDTO — Data Transfer Object for a custom transformer. Extends the base transformer with custom-specific properties. - `id` string, required — The unique identifier of the transformer. - `type` 'custom', required — The type of the transformer (always 'custom' for this interface). - `inputType` string, required - `outputType` string, required - `manifest` OIBusObjectAttribute, required — Object-type attribute that groups related attributes. Used to create nested form structures. - `type` 'object', required — The type of this attribute (always "object"). - `key` string, required — The unique key/identifier for this attribute. - `translationKey` string, required — Translation key for internationalization. - `validators` OIBusAttributeValidator[], required — Validators to apply to this attribute. - … - `attributes` OIBusAttribute[], required — Child attributes contained within this object. - … - `enablingConditions` OIBusEnablingCondition[], required — Conditions that determine when this object should be enabled. - … - `displayProperties` OIBusObjectDisplayProperties, required — Display properties for object-type form attributes. Controls visibility and styling of object containers. - … - `name` string, required — The name of the custom transformer. - `description` string, required — A description of what the custom transformer does. - `customCode` string, required — The custom JavaScript code that implements the transformation logic. - `language` string, required - `timeout` number, double, required — The maximum execution time for the custom code in milliseconds. - `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. - StandardTransformerDTO — Data Transfer Object for a standard transformer. Extends the base transformer with standard-specific properties. - `id` string, required — The unique identifier of the transformer. - `type` 'standard', required — The type of the transformer (always 'standard' for this interface). - `inputType` string, required - `outputType` string, required - `manifest` OIBusObjectAttribute, required — Object-type attribute that groups related attributes. Used to create nested form structures. - `type` 'object', required — The type of this attribute (always "object"). - `key` string, required — The unique key/identifier for this attribute. - `translationKey` string, required — Translation key for internationalization. - `validators` OIBusAttributeValidator[], required — Validators to apply to this attribute. - … - `attributes` OIBusAttribute[], required — Child attributes contained within this object. - … - `enablingConditions` OIBusEnablingCondition[], required — Conditions that determine when this object should be enabled. - … - `displayProperties` OIBusObjectDisplayProperties, required — Display properties for object-type form attributes. Controls visibility and styling of object containers. - … - `functionName` string, required — The name of the standard function that implements the transformation. - `options` RecordStringUnknown, required — Construct a type with a set of properties K of type T - NorthConnectorModbusDTO — North connector configuration for Modbus. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the North connector. - `type` 'modbus', required — The type of the North connector. - `description` string, required — The description of the North connector. - `enabled` boolean, required — Whether the North connector is enabled. - `settings` NorthModbusSettings, required - `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 - `caching` object, required — The caching configuration for the North connector. - `archive` object, required — The archive configuration for caching. - `retentionDuration` number, double, required — The duration (in ms) to retain archived files. - `enabled` boolean, required — Whether archiving is enabled. - `error` object, required — The error handling configuration for caching. - `retentionDuration` number, double, required — The duration (in ms) to retain error files. - `retryCount` number, double, required — The maximum number of retry attempts. - `retryInterval` number, double, required — The interval (in ms) between retry attempts. - `throttling` object, required — The throttling configuration for caching. - `maxNumberOfElements` number, double, required — The maximum number of elements in the cache before sending. - `maxSize` number, double, required — The maximum size (in bytes) of the cache before sending. - `runMinDelay` number, double, required — The minimum delay (in ms) between runs. - `trigger` object, required — The trigger configuration for caching. - `numberOfFiles` number, double, required — The number of files to trigger a send. - `numberOfElements` number, double, required — The number of elements to trigger a send. - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `transformers` TransformerDTOWithOptions[], required — The list of transformers applied to the data. - `id` string, required — The id used to match a transformer with options - `source` union, required - SourceOriginSouthDTO - `type` 'south', required - `south` SouthConnectorLightDTO, required — Lightweight Data Transfer Object for a South connector. Contains only essential information about a South connector for listing purposes. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the South connector. - `type` 'opcua' | 'mqtt' | 'modbus' | 'oianalytics' | 'ads' | 'folder-scanner' | 'ftp' | 'influxdb' | 'mssql' | 'mysql' | 'odbc' | 'oledb' | 'opc' | 'oracle' | 'osisoft-pi' | 'postgresql' | 'rest' | 'sftp' | 'sqlite', required — Type representing the possible types for a South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector is enabled and active. - `group` SouthItemGroupLightDTO - `id` string, required - `name` string, required — The name of the group. - `items` ItemLightDTO[], required — The list of items associated to the transformer - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the item. - `enabled` boolean, required — Whether this item is enabled. - SourceOriginOIAnalyticsDTO - `type` 'oianalytics-setpoint', required - SourceOriginAPIDTO - `type` 'oibus-api', required - `dataSourceId` string, required - `transformer` union, required — Union type representing either a custom or standard transformer. - CustomTransformerDTO — Data Transfer Object for a custom transformer. Extends the base transformer with custom-specific properties. - `id` string, required — The unique identifier of the transformer. - `type` 'custom', required — The type of the transformer (always 'custom' for this interface). - `inputType` string, required - `outputType` string, required - `manifest` OIBusObjectAttribute, required — Object-type attribute that groups related attributes. Used to create nested form structures. - `type` 'object', required — The type of this attribute (always "object"). - `key` string, required — The unique key/identifier for this attribute. - `translationKey` string, required — Translation key for internationalization. - `validators` OIBusAttributeValidator[], required — Validators to apply to this attribute. - … - `attributes` OIBusAttribute[], required — Child attributes contained within this object. - … - `enablingConditions` OIBusEnablingCondition[], required — Conditions that determine when this object should be enabled. - … - `displayProperties` OIBusObjectDisplayProperties, required — Display properties for object-type form attributes. Controls visibility and styling of object containers. - … - `name` string, required — The name of the custom transformer. - `description` string, required — A description of what the custom transformer does. - `customCode` string, required — The custom JavaScript code that implements the transformation logic. - `language` string, required - `timeout` number, double, required — The maximum execution time for the custom code in milliseconds. - `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. - StandardTransformerDTO — Data Transfer Object for a standard transformer. Extends the base transformer with standard-specific properties. - `id` string, required — The unique identifier of the transformer. - `type` 'standard', required — The type of the transformer (always 'standard' for this interface). - `inputType` string, required - `outputType` string, required - `manifest` OIBusObjectAttribute, required — Object-type attribute that groups related attributes. Used to create nested form structures. - `type` 'object', required — The type of this attribute (always "object"). - `key` string, required — The unique key/identifier for this attribute. - `translationKey` string, required — Translation key for internationalization. - `validators` OIBusAttributeValidator[], required — Validators to apply to this attribute. - … - `attributes` OIBusAttribute[], required — Child attributes contained within this object. - … - `enablingConditions` OIBusEnablingCondition[], required — Conditions that determine when this object should be enabled. - … - `displayProperties` OIBusObjectDisplayProperties, required — Display properties for object-type form attributes. Controls visibility and styling of object containers. - … - `functionName` string, required — The name of the standard function that implements the transformation. - `options` RecordStringUnknown, required — Construct a type with a set of properties K of type T - NorthConnectorMQTTDTO — North connector configuration for MQTT. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the North connector. - `type` 'mqtt', required — The type of the North connector. - `description` string, required — The description of the North connector. - `enabled` boolean, required — Whether the North connector is enabled. - `settings` NorthMQTTSettings, required - `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 - `caching` object, required — The caching configuration for the North connector. - `archive` object, required — The archive configuration for caching. - `retentionDuration` number, double, required — The duration (in ms) to retain archived files. - `enabled` boolean, required — Whether archiving is enabled. - `error` object, required — The error handling configuration for caching. - `retentionDuration` number, double, required — The duration (in ms) to retain error files. - `retryCount` number, double, required — The maximum number of retry attempts. - `retryInterval` number, double, required — The interval (in ms) between retry attempts. - `throttling` object, required — The throttling configuration for caching. - `maxNumberOfElements` number, double, required — The maximum number of elements in the cache before sending. - `maxSize` number, double, required — The maximum size (in bytes) of the cache before sending. - `runMinDelay` number, double, required — The minimum delay (in ms) between runs. - `trigger` object, required — The trigger configuration for caching. - `numberOfFiles` number, double, required — The number of files to trigger a send. - `numberOfElements` number, double, required — The number of elements to trigger a send. - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `transformers` TransformerDTOWithOptions[], required — The list of transformers applied to the data. - `id` string, required — The id used to match a transformer with options - `source` union, required - SourceOriginSouthDTO - `type` 'south', required - `south` SouthConnectorLightDTO, required — Lightweight Data Transfer Object for a South connector. Contains only essential information about a South connector for listing purposes. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the South connector. - `type` 'opcua' | 'mqtt' | 'modbus' | 'oianalytics' | 'ads' | 'folder-scanner' | 'ftp' | 'influxdb' | 'mssql' | 'mysql' | 'odbc' | 'oledb' | 'opc' | 'oracle' | 'osisoft-pi' | 'postgresql' | 'rest' | 'sftp' | 'sqlite', required — Type representing the possible types for a South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector is enabled and active. - `group` SouthItemGroupLightDTO - `id` string, required - `name` string, required — The name of the group. - `items` ItemLightDTO[], required — The list of items associated to the transformer - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the item. - `enabled` boolean, required — Whether this item is enabled. - SourceOriginOIAnalyticsDTO - `type` 'oianalytics-setpoint', required - SourceOriginAPIDTO - `type` 'oibus-api', required - `dataSourceId` string, required - `transformer` union, required — Union type representing either a custom or standard transformer. - CustomTransformerDTO — Data Transfer Object for a custom transformer. Extends the base transformer with custom-specific properties. - `id` string, required — The unique identifier of the transformer. - `type` 'custom', required — The type of the transformer (always 'custom' for this interface). - `inputType` string, required - `outputType` string, required - `manifest` OIBusObjectAttribute, required — Object-type attribute that groups related attributes. Used to create nested form structures. - `type` 'object', required — The type of this attribute (always "object"). - `key` string, required — The unique key/identifier for this attribute. - `translationKey` string, required — Translation key for internationalization. - `validators` OIBusAttributeValidator[], required — Validators to apply to this attribute. - … - `attributes` OIBusAttribute[], required — Child attributes contained within this object. - … - `enablingConditions` OIBusEnablingCondition[], required — Conditions that determine when this object should be enabled. - … - `displayProperties` OIBusObjectDisplayProperties, required — Display properties for object-type form attributes. Controls visibility and styling of object containers. - … - `name` string, required — The name of the custom transformer. - `description` string, required — A description of what the custom transformer does. - `customCode` string, required — The custom JavaScript code that implements the transformation logic. - `language` string, required - `timeout` number, double, required — The maximum execution time for the custom code in milliseconds. - `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. - StandardTransformerDTO — Data Transfer Object for a standard transformer. Extends the base transformer with standard-specific properties. - `id` string, required — The unique identifier of the transformer. - `type` 'standard', required — The type of the transformer (always 'standard' for this interface). - `inputType` string, required - `outputType` string, required - `manifest` OIBusObjectAttribute, required — Object-type attribute that groups related attributes. Used to create nested form structures. - `type` 'object', required — The type of this attribute (always "object"). - `key` string, required — The unique key/identifier for this attribute. - `translationKey` string, required — Translation key for internationalization. - `validators` OIBusAttributeValidator[], required — Validators to apply to this attribute. - … - `attributes` OIBusAttribute[], required — Child attributes contained within this object. - … - `enablingConditions` OIBusEnablingCondition[], required — Conditions that determine when this object should be enabled. - … - `displayProperties` OIBusObjectDisplayProperties, required — Display properties for object-type form attributes. Controls visibility and styling of object containers. - … - `functionName` string, required — The name of the standard function that implements the transformation. - `options` RecordStringUnknown, required — Construct a type with a set of properties K of type T - NorthConnectorOIAnalyticsDTO — North connector configuration for OIAnalytics. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the North connector. - `type` 'oianalytics', required — The type of the North connector. - `description` string, required — The description of the North connector. - `enabled` boolean, required — Whether the North connector is enabled. - `settings` NorthOIAnalyticsSettings, required - `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 - `caching` object, required — The caching configuration for the North connector. - `archive` object, required — The archive configuration for caching. - `retentionDuration` number, double, required — The duration (in ms) to retain archived files. - `enabled` boolean, required — Whether archiving is enabled. - `error` object, required — The error handling configuration for caching. - `retentionDuration` number, double, required — The duration (in ms) to retain error files. - `retryCount` number, double, required — The maximum number of retry attempts. - `retryInterval` number, double, required — The interval (in ms) between retry attempts. - `throttling` object, required — The throttling configuration for caching. - `maxNumberOfElements` number, double, required — The maximum number of elements in the cache before sending. - `maxSize` number, double, required — The maximum size (in bytes) of the cache before sending. - `runMinDelay` number, double, required — The minimum delay (in ms) between runs. - `trigger` object, required — The trigger configuration for caching. - `numberOfFiles` number, double, required — The number of files to trigger a send. - `numberOfElements` number, double, required — The number of elements to trigger a send. - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `transformers` TransformerDTOWithOptions[], required — The list of transformers applied to the data. - `id` string, required — The id used to match a transformer with options - `source` union, required - SourceOriginSouthDTO - `type` 'south', required - `south` SouthConnectorLightDTO, required — Lightweight Data Transfer Object for a South connector. Contains only essential information about a South connector for listing purposes. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the South connector. - `type` 'opcua' | 'mqtt' | 'modbus' | 'oianalytics' | 'ads' | 'folder-scanner' | 'ftp' | 'influxdb' | 'mssql' | 'mysql' | 'odbc' | 'oledb' | 'opc' | 'oracle' | 'osisoft-pi' | 'postgresql' | 'rest' | 'sftp' | 'sqlite', required — Type representing the possible types for a South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector is enabled and active. - `group` SouthItemGroupLightDTO - `id` string, required - `name` string, required — The name of the group. - `items` ItemLightDTO[], required — The list of items associated to the transformer - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the item. - `enabled` boolean, required — Whether this item is enabled. - SourceOriginOIAnalyticsDTO - `type` 'oianalytics-setpoint', required - SourceOriginAPIDTO - `type` 'oibus-api', required - `dataSourceId` string, required - `transformer` union, required — Union type representing either a custom or standard transformer. - CustomTransformerDTO — Data Transfer Object for a custom transformer. Extends the base transformer with custom-specific properties. - `id` string, required — The unique identifier of the transformer. - `type` 'custom', required — The type of the transformer (always 'custom' for this interface). - `inputType` string, required - `outputType` string, required - `manifest` OIBusObjectAttribute, required — Object-type attribute that groups related attributes. Used to create nested form structures. - `type` 'object', required — The type of this attribute (always "object"). - `key` string, required — The unique key/identifier for this attribute. - `translationKey` string, required — Translation key for internationalization. - `validators` OIBusAttributeValidator[], required — Validators to apply to this attribute. - … - `attributes` OIBusAttribute[], required — Child attributes contained within this object. - … - `enablingConditions` OIBusEnablingCondition[], required — Conditions that determine when this object should be enabled. - … - `displayProperties` OIBusObjectDisplayProperties, required — Display properties for object-type form attributes. Controls visibility and styling of object containers. - … - `name` string, required — The name of the custom transformer. - `description` string, required — A description of what the custom transformer does. - `customCode` string, required — The custom JavaScript code that implements the transformation logic. - `language` string, required - `timeout` number, double, required — The maximum execution time for the custom code in milliseconds. - `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. - StandardTransformerDTO — Data Transfer Object for a standard transformer. Extends the base transformer with standard-specific properties. - `id` string, required — The unique identifier of the transformer. - `type` 'standard', required — The type of the transformer (always 'standard' for this interface). - `inputType` string, required - `outputType` string, required - `manifest` OIBusObjectAttribute, required — Object-type attribute that groups related attributes. Used to create nested form structures. - `type` 'object', required — The type of this attribute (always "object"). - `key` string, required — The unique key/identifier for this attribute. - `translationKey` string, required — Translation key for internationalization. - `validators` OIBusAttributeValidator[], required — Validators to apply to this attribute. - … - `attributes` OIBusAttribute[], required — Child attributes contained within this object. - … - `enablingConditions` OIBusEnablingCondition[], required — Conditions that determine when this object should be enabled. - … - `displayProperties` OIBusObjectDisplayProperties, required — Display properties for object-type form attributes. Controls visibility and styling of object containers. - … - `functionName` string, required — The name of the standard function that implements the transformation. - `options` RecordStringUnknown, required — Construct a type with a set of properties K of type T - NorthConnectorOPCUADTO — North connector configuration for OPC UA. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the North connector. - `type` 'opcua', required — The type of the North connector. - `description` string, required — The description of the North connector. - `enabled` boolean, required — Whether the North connector is enabled. - `settings` NorthOPCUASettings, required - `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 - `caching` object, required — The caching configuration for the North connector. - `archive` object, required — The archive configuration for caching. - `retentionDuration` number, double, required — The duration (in ms) to retain archived files. - `enabled` boolean, required — Whether archiving is enabled. - `error` object, required — The error handling configuration for caching. - `retentionDuration` number, double, required — The duration (in ms) to retain error files. - `retryCount` number, double, required — The maximum number of retry attempts. - `retryInterval` number, double, required — The interval (in ms) between retry attempts. - `throttling` object, required — The throttling configuration for caching. - `maxNumberOfElements` number, double, required — The maximum number of elements in the cache before sending. - `maxSize` number, double, required — The maximum size (in bytes) of the cache before sending. - `runMinDelay` number, double, required — The minimum delay (in ms) between runs. - `trigger` object, required — The trigger configuration for caching. - `numberOfFiles` number, double, required — The number of files to trigger a send. - `numberOfElements` number, double, required — The number of elements to trigger a send. - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `transformers` TransformerDTOWithOptions[], required — The list of transformers applied to the data. - `id` string, required — The id used to match a transformer with options - `source` union, required - SourceOriginSouthDTO - `type` 'south', required - `south` SouthConnectorLightDTO, required — Lightweight Data Transfer Object for a South connector. Contains only essential information about a South connector for listing purposes. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the South connector. - `type` 'opcua' | 'mqtt' | 'modbus' | 'oianalytics' | 'ads' | 'folder-scanner' | 'ftp' | 'influxdb' | 'mssql' | 'mysql' | 'odbc' | 'oledb' | 'opc' | 'oracle' | 'osisoft-pi' | 'postgresql' | 'rest' | 'sftp' | 'sqlite', required — Type representing the possible types for a South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector is enabled and active. - `group` SouthItemGroupLightDTO - `id` string, required - `name` string, required — The name of the group. - `items` ItemLightDTO[], required — The list of items associated to the transformer - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the item. - `enabled` boolean, required — Whether this item is enabled. - SourceOriginOIAnalyticsDTO - `type` 'oianalytics-setpoint', required - SourceOriginAPIDTO - `type` 'oibus-api', required - `dataSourceId` string, required - `transformer` union, required — Union type representing either a custom or standard transformer. - CustomTransformerDTO — Data Transfer Object for a custom transformer. Extends the base transformer with custom-specific properties. - `id` string, required — The unique identifier of the transformer. - `type` 'custom', required — The type of the transformer (always 'custom' for this interface). - `inputType` string, required - `outputType` string, required - `manifest` OIBusObjectAttribute, required — Object-type attribute that groups related attributes. Used to create nested form structures. - `type` 'object', required — The type of this attribute (always "object"). - `key` string, required — The unique key/identifier for this attribute. - `translationKey` string, required — Translation key for internationalization. - `validators` OIBusAttributeValidator[], required — Validators to apply to this attribute. - … - `attributes` OIBusAttribute[], required — Child attributes contained within this object. - … - `enablingConditions` OIBusEnablingCondition[], required — Conditions that determine when this object should be enabled. - … - `displayProperties` OIBusObjectDisplayProperties, required — Display properties for object-type form attributes. Controls visibility and styling of object containers. - … - `name` string, required — The name of the custom transformer. - `description` string, required — A description of what the custom transformer does. - `customCode` string, required — The custom JavaScript code that implements the transformation logic. - `language` string, required - `timeout` number, double, required — The maximum execution time for the custom code in milliseconds. - `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. - StandardTransformerDTO — Data Transfer Object for a standard transformer. Extends the base transformer with standard-specific properties. - `id` string, required — The unique identifier of the transformer. - `type` 'standard', required — The type of the transformer (always 'standard' for this interface). - `inputType` string, required - `outputType` string, required - `manifest` OIBusObjectAttribute, required — Object-type attribute that groups related attributes. Used to create nested form structures. - `type` 'object', required — The type of this attribute (always "object"). - `key` string, required — The unique key/identifier for this attribute. - `translationKey` string, required — Translation key for internationalization. - `validators` OIBusAttributeValidator[], required — Validators to apply to this attribute. - … - `attributes` OIBusAttribute[], required — Child attributes contained within this object. - … - `enablingConditions` OIBusEnablingCondition[], required — Conditions that determine when this object should be enabled. - … - `displayProperties` OIBusObjectDisplayProperties, required — Display properties for object-type form attributes. Controls visibility and styling of object containers. - … - `functionName` string, required — The name of the standard function that implements the transformation. - `options` RecordStringUnknown, required — Construct a type with a set of properties K of type T - NorthConnectorRESTDTO — North connector configuration for the REST API. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the North connector. - `type` 'rest', required — The type of the North connector. - `description` string, required — The description of the North connector. - `enabled` boolean, required — Whether the North connector is enabled. - `settings` NorthRESTSettings, required - `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 - `caching` object, required — The caching configuration for the North connector. - `archive` object, required — The archive configuration for caching. - `retentionDuration` number, double, required — The duration (in ms) to retain archived files. - `enabled` boolean, required — Whether archiving is enabled. - `error` object, required — The error handling configuration for caching. - `retentionDuration` number, double, required — The duration (in ms) to retain error files. - `retryCount` number, double, required — The maximum number of retry attempts. - `retryInterval` number, double, required — The interval (in ms) between retry attempts. - `throttling` object, required — The throttling configuration for caching. - `maxNumberOfElements` number, double, required — The maximum number of elements in the cache before sending. - `maxSize` number, double, required — The maximum size (in bytes) of the cache before sending. - `runMinDelay` number, double, required — The minimum delay (in ms) between runs. - `trigger` object, required — The trigger configuration for caching. - `numberOfFiles` number, double, required — The number of files to trigger a send. - `numberOfElements` number, double, required — The number of elements to trigger a send. - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `transformers` TransformerDTOWithOptions[], required — The list of transformers applied to the data. - `id` string, required — The id used to match a transformer with options - `source` union, required - SourceOriginSouthDTO - `type` 'south', required - `south` SouthConnectorLightDTO, required — Lightweight Data Transfer Object for a South connector. Contains only essential information about a South connector for listing purposes. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the South connector. - `type` 'opcua' | 'mqtt' | 'modbus' | 'oianalytics' | 'ads' | 'folder-scanner' | 'ftp' | 'influxdb' | 'mssql' | 'mysql' | 'odbc' | 'oledb' | 'opc' | 'oracle' | 'osisoft-pi' | 'postgresql' | 'rest' | 'sftp' | 'sqlite', required — Type representing the possible types for a South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector is enabled and active. - `group` SouthItemGroupLightDTO - `id` string, required - `name` string, required — The name of the group. - `items` ItemLightDTO[], required — The list of items associated to the transformer - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the item. - `enabled` boolean, required — Whether this item is enabled. - SourceOriginOIAnalyticsDTO - `type` 'oianalytics-setpoint', required - SourceOriginAPIDTO - `type` 'oibus-api', required - `dataSourceId` string, required - `transformer` union, required — Union type representing either a custom or standard transformer. - CustomTransformerDTO — Data Transfer Object for a custom transformer. Extends the base transformer with custom-specific properties. - `id` string, required — The unique identifier of the transformer. - `type` 'custom', required — The type of the transformer (always 'custom' for this interface). - `inputType` string, required - `outputType` string, required - `manifest` OIBusObjectAttribute, required — Object-type attribute that groups related attributes. Used to create nested form structures. - `type` 'object', required — The type of this attribute (always "object"). - `key` string, required — The unique key/identifier for this attribute. - `translationKey` string, required — Translation key for internationalization. - `validators` OIBusAttributeValidator[], required — Validators to apply to this attribute. - … - `attributes` OIBusAttribute[], required — Child attributes contained within this object. - … - `enablingConditions` OIBusEnablingCondition[], required — Conditions that determine when this object should be enabled. - … - `displayProperties` OIBusObjectDisplayProperties, required — Display properties for object-type form attributes. Controls visibility and styling of object containers. - … - `name` string, required — The name of the custom transformer. - `description` string, required — A description of what the custom transformer does. - `customCode` string, required — The custom JavaScript code that implements the transformation logic. - `language` string, required - `timeout` number, double, required — The maximum execution time for the custom code in milliseconds. - `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. - StandardTransformerDTO — Data Transfer Object for a standard transformer. Extends the base transformer with standard-specific properties. - `id` string, required — The unique identifier of the transformer. - `type` 'standard', required — The type of the transformer (always 'standard' for this interface). - `inputType` string, required - `outputType` string, required - `manifest` OIBusObjectAttribute, required — Object-type attribute that groups related attributes. Used to create nested form structures. - `type` 'object', required — The type of this attribute (always "object"). - `key` string, required — The unique key/identifier for this attribute. - `translationKey` string, required — Translation key for internationalization. - `validators` OIBusAttributeValidator[], required — Validators to apply to this attribute. - … - `attributes` OIBusAttribute[], required — Child attributes contained within this object. - … - `enablingConditions` OIBusEnablingCondition[], required — Conditions that determine when this object should be enabled. - … - `displayProperties` OIBusObjectDisplayProperties, required — Display properties for object-type form attributes. Controls visibility and styling of object containers. - … - `functionName` string, required — The name of the standard function that implements the transformation. - `options` RecordStringUnknown, required — Construct a type with a set of properties K of type T - NorthConnectorSFTPDTO — North connector configuration for SFTP file transfer. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the North connector. - `type` 'sftp', required — The type of the North connector. - `description` string, required — The description of the North connector. - `enabled` boolean, required — Whether the North connector is enabled. - `settings` NorthSFTPSettings, required - `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 - `caching` object, required — The caching configuration for the North connector. - `archive` object, required — The archive configuration for caching. - `retentionDuration` number, double, required — The duration (in ms) to retain archived files. - `enabled` boolean, required — Whether archiving is enabled. - `error` object, required — The error handling configuration for caching. - `retentionDuration` number, double, required — The duration (in ms) to retain error files. - `retryCount` number, double, required — The maximum number of retry attempts. - `retryInterval` number, double, required — The interval (in ms) between retry attempts. - `throttling` object, required — The throttling configuration for caching. - `maxNumberOfElements` number, double, required — The maximum number of elements in the cache before sending. - `maxSize` number, double, required — The maximum size (in bytes) of the cache before sending. - `runMinDelay` number, double, required — The minimum delay (in ms) between runs. - `trigger` object, required — The trigger configuration for caching. - `numberOfFiles` number, double, required — The number of files to trigger a send. - `numberOfElements` number, double, required — The number of elements to trigger a send. - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - `id` string, required — The unique identifier of the user. - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users. - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the scan mode. - `description` string, required — A description of the scan mode's purpose or behavior. - `cron` string, required — A cron expression defining the scan schedule. - `transformers` TransformerDTOWithOptions[], required — The list of transformers applied to the data. - `id` string, required — The id used to match a transformer with options - `source` union, required - SourceOriginSouthDTO - `type` 'south', required - `south` SouthConnectorLightDTO, required — Lightweight Data Transfer Object for a South connector. Contains only essential information about a South connector for listing purposes. - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the South connector. - `type` 'opcua' | 'mqtt' | 'modbus' | 'oianalytics' | 'ads' | 'folder-scanner' | 'ftp' | 'influxdb' | 'mssql' | 'mysql' | 'odbc' | 'oledb' | 'opc' | 'oracle' | 'osisoft-pi' | 'postgresql' | 'rest' | 'sftp' | 'sqlite', required — Type representing the possible types for a South connector. - `description` string, required — Description of the South connector's purpose. - `enabled` boolean, required — Whether the South connector is enabled and active. - `group` SouthItemGroupLightDTO - `id` string, required - `name` string, required — The name of the group. - `items` ItemLightDTO[], required — The list of items associated to the transformer - `id` string, required — The unique identifier of the entity. - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name. - … - `createdAt` string, required — Represents an instant in time as an ISO 8601 string. - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string. - `name` string, required — The name of the item. - `enabled` boolean, required — Whether this item is enabled. - SourceOriginOIAnalyticsDTO - `type` 'oianalytics-setpoint', required - SourceOriginAPIDTO - `type` 'oibus-api', required - `dataSourceId` string, required - `transformer` union, required — Union type representing either a custom or standard transformer. - CustomTransformerDTO — Data Transfer Object for a custom transformer. Extends the base transformer with custom-specific properties. - `id` string, required — The unique identifier of the transformer. - `type` 'custom', required — The type of the transformer (always 'custom' for this interface). - `inputType` string, required - `outputType` string, required - `manifest` OIBusObjectAttribute, required — Object-type attribute that groups related attributes. Used to create nested form structures. - `type` 'object', required — The type of this attribute (always "object"). - `key` string, required — The unique key/identifier for this attribute. - `translationKey` string, required — Translation key for internationalization. - `validators` OIBusAttributeValidator[], required — Validators to apply to this attribute. - … - `attributes` OIBusAttribute[], required — Child attributes contained within this object. - … - `enablingConditions` OIBusEnablingCondition[], required — Conditions that determine when this object should be enabled. - … - `displayProperties` OIBusObjectDisplayProperties, required — Display properties for object-type form attributes. Controls visibility and styling of object containers. - … - `name` string, required — The name of the custom transformer. - `description` string, required — A description of what the custom transformer does. - `customCode` string, required — The custom JavaScript code that implements the transformation logic. - `language` string, required - `timeout` number, double, required — The maximum execution time for the custom code in milliseconds. - `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. - StandardTransformerDTO — Data Transfer Object for a standard transformer. Extends the base transformer with standard-specific properties. - `id` string, required — The unique identifier of the transformer. - `type` 'standard', required — The type of the transformer (always 'standard' for this interface). - `inputType` string, required - `outputType` string, required - `manifest` OIBusObjectAttribute, required — Object-type attribute that groups related attributes. Used to create nested form structures. - `type` 'object', required — The type of this attribute (always "object"). - `key` string, required — The unique key/identifier for this attribute. - `translationKey` string, required — Translation key for internationalization. - `validators` OIBusAttributeValidator[], required — Validators to apply to this attribute. - … - `attributes` OIBusAttribute[], required — Child attributes contained within this object. - … - `enablingConditions` OIBusEnablingCondition[], required — Conditions that determine when this object should be enabled. - … - `displayProperties` OIBusObjectDisplayProperties, required — Display properties for object-type form attributes. Controls visibility and styling of object containers. - … - `functionName` string, required — The name of the standard function that implements the transformation. - `options` RecordStringUnknown, required — Construct a type with a set of properties K of type T --- [API](https://skmtc.net/optimistiksas/apis/oibus-api.md) · [All operations](https://skmtc.net/optimistiksas/apis/oibus-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/optimistiksas/oibus-api/revisions/fe8fd32c9fdc/schema)