> For the complete documentation index, see [llms.txt](https://developer.vario-software.de/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.vario-software.de/api-reference/import-rule-set.md).

# Import Rule Set

Manage VARIO Cloud import rule sets via API, including mappings, field and format settings, scripts, CSV/JSON/XML, parallel runs and workflow controls.

Import rule sets.

## GET /cmn/data-import/rule-sets/{id}

> Find an existing Resource by identifier

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"ImportRuleSet","description":"Import rule sets."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/data-import/rule-sets/{id}":{"get":{"tags":["ImportRuleSet"],"summary":"Find an existing Resource by identifier","operationId":"getById_136","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-data_import-ImportMappingRuleSet"}}}},"404":{"description":"Resource with given ID was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-data_import-ImportMappingRuleSet":{"description":"Rule set for the import run.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"mode":{"type":"string","description":"Mode.","enum":["SCRIPT","IMPORT","EXPORT"]},"label":{"type":"string","description":"Unique label."},"root":{"type":"string","description":"For JSON and XML import: at which path do the import data start?"},"rules":{"type":"array","description":"Mapping rules.","items":{"$ref":"#/components/schemas/common-data_import-ImportMappingRule"}},"importModuleKey":{"type":"string","description":"Which import this rule set applies to."},"dataFrom":{"type":"integer","format":"int64","description":"First record index (1-based) - all preceding ones are ignored."},"dataTo":{"type":"integer","format":"int64","description":"Last record index (1-based) - all following ones are ignored."},"headerIndex":{"type":"integer","format":"int64","description":"If present: header row index (1-based)."},"columnSeparator":{"type":"string","description":"CSV only: separator within a row."},"fixedWidthColumnDefinitions":{"type":"array","description":"Column definitions used to split fixed-width rows","items":{"$ref":"#/components/schemas/common-data_import-FixedWidthColumnDefinition"}},"charSet":{"type":"string","description":"For CSV and JSON: the character set used.","enum":["UTF_8","ASCII","LATIN_1","AUTO_DETECT"]},"quotingChar":{"type":"string","description":"CSV only: character used to quote a text field (usually ' or \")."},"targetFieldRules":{"type":"array","description":"Indicates how target fields and sub-objects are handled.","items":{"$ref":"#/components/schemas/common-data_import-TargetFieldRule"}},"createRulesForEavGroup":{"type":"string","description":"Indicates that rules should be generated for an EAV group on execution."},"defaultDateFormatDirective":{"$ref":"#/components/schemas/common-data_import-FormatDirective"},"defaultDateTimeFormatDirective":{"$ref":"#/components/schemas/common-data_import-FormatDirective"},"defaultNumberFormatDirective":{"$ref":"#/components/schemas/common-data_import-FormatDirective"},"defaultBooleanFormatDirective":{"$ref":"#/components/schemas/common-data_import-FormatDirective"},"script":{"type":"string","description":"When mode == SCRIPT: the script to execute. Only the script or the script module may be set."},"scriptModuleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"parameters":{"type":"array","description":"Script parameters.","items":{"$ref":"#/components/schemas/common-data_import-ImportMappingRuleSetParameter"}},"parallelExecutionAllowed":{"type":"boolean","default":true,"description":"Is splitting into several tasks executed in parallel allowed?"},"advancedUi":{"type":"boolean","default":false,"description":"Use the advanced representation in the UI?"},"ignoreEmptyData":{"type":"boolean","default":false,"description":"For JSON import: ignore an empty data set?"},"exportSetting":{"$ref":"#/components/schemas/common-data_import-ExportSetting"},"suppressWebhooks":{"type":"boolean","default":false,"description":"Should webhooks be disabled during the execution?"},"suppressWorkflows":{"type":"boolean","default":false,"description":"Should workflows be disabled during the execution?"},"createMissingHeadersFromRuleSet":{"type":"boolean","default":false,"description":"JSON and XML only: generate missing headers automatically from the columns referenced in the rule set?"}},"required":["mode"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-data_import-ImportMappingRule":{"description":"Mapping rules.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"transformation":{"$ref":"#/components/schemas/common-data_import-Transformation"}},"required":["transformation"]},"common-data_import-Transformation":{"description":"Indicates how the value for target is produced.","properties":{"type":{"type":"string","description":"Transformation type.","enum":["DIRECT","CONCAT","TRIM","UPPER_CASE","LOWER_CASE","REPLACE","REGEX_REPLACE","FIXED_VALUE","COALESCE","ROW_INDEX","GET_AT_INDEX","ITERATE","GROUP_TO_OBJECT","MODULE_SPECIFIC"]},"children":{"type":"array","description":"Sub-transformations as input for the transformation.","items":{"$ref":"#/components/schemas/common-data_import-Transformation"}},"columnName":{"type":"string","description":"For DIRECT, GET_AT_INDEX and ITERATE: the column the data are taken from."},"fixedValue":{"type":"string","description":"For FIXED_VALUE: the value."},"replacements":{"type":"array","description":"For REPLACE: the replacements.","items":{"$ref":"#/components/schemas/common-data_import-Transformation.Replacement"}},"matchWholeFieldsOnly":{"type":"boolean","description":"For REPLACE: replace only when the whole value matches, no substrings."},"regexSearch":{"type":"string","description":"For REGEX_REPLACE: the regular expression to search for."},"regexReplacement":{"type":"string","description":"For REGEX_REPLACE: the replacement applied for the regular expression."},"caseSensitive":{"type":"boolean","description":"For (REGEX_)REPLACE: replace only when the case matches?"},"useDefaultValueForReplacement":{"type":"boolean","default":false,"description":"For REPLACE with matchWholeFieldsOnly: should the default value be used when no expression matches?"},"defaultValue":{"type":"string","description":"For REPLACE with matchWholeFieldsOnly: the replacement when no expression matches."},"index":{"type":"integer","format":"int32","description":"For GET_AT_INDEX: which array element is wanted (0-based index)?"},"target":{"type":"string","description":"Target the transformation result is written to."},"formatDirective":{"$ref":"#/components/schemas/common-data_import-FormatDirective"},"moduleSpecificTransformationKey":{"type":"string","description":"Key for special transformations."},"suppressFailures":{"type":"boolean","description":"For special transformations: ignore an error and use null instead?"},"auxiliaryTransformation":{"type":"boolean","default":false,"description":"Is this an auxiliary transformation without a real mapping target?"},"dataType":{"type":"string","description":"For auxiliary transformations: the data type."}},"required":["type"]},"common-data_import-Transformation.Replacement":{"description":"For REPLACE: the replacements.","properties":{"from":{"type":"string","description":"String to replace.","minLength":1},"to":{"type":"string","description":"Replacement for the string."}},"required":["from"]},"common-data_import-FormatDirective":{"description":"Default format for boolean values.","properties":{"formatType":{"type":"string","description":"Which data type this formatting is intended for.","enum":["NUMERIC","DATE","DATETIME","BOOLEAN"]},"patternString":{"type":"string","description":"For DATE and DATETIME: a pattern for parsing."},"groupingSign":{"type":"string","description":"Thousands separator for numeric values."},"decimalSign":{"type":"string","description":"Decimal separator for numeric values."},"representationForTrue":{"type":"string","description":"Text representing the boolean value true (for example 'J')."},"representationForFalse":{"type":"string","description":"Text representing the boolean value false (for example 'N')."}},"required":["formatType"]},"common-data_import-FixedWidthColumnDefinition":{"description":"Column definitions used to split fixed-width rows","properties":{"startPosition":{"type":"integer","format":"int32","description":"Column starting position","minimum":1},"padChar":{"type":"string","description":"will be removed if found at the beginning or end of the column","maxLength":1,"minLength":1}},"required":["startPosition"]},"common-data_import-TargetFieldRule":{"description":"Indicates how target fields and sub-objects are handled.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"path":{"type":"string","description":"Path to the sub-object or field."},"lookupFields":{"type":"array","description":"Which fields identify the object? Only for LOAD_OR_INSERT, UPDATE and UPSERT.","items":{"type":"string","description":"Which fields identify the object? Only for LOAD_OR_INSERT, UPDATE and UPSERT."}},"policy":{"type":"string","description":"How should sub-objects be handled?","enum":["LOAD","INSERT","INSERT_FACTORY","UPSERT","UPDATE","LOAD_OR_INSERT","LOAD_OR_IGNORE"]},"nullValueHandlingStrategy":{"type":"string","description":"How should a null value be handled?","enum":["IGNORE","OVERRIDE"]},"ignoreRules":{"type":"array","description":"Conditions under which the object to import should be ignored.","items":{"$ref":"#/components/schemas/common-data_import-IgnoreRule"}}},"required":["path"]},"common-data_import-IgnoreRule":{"description":"Conditions under which the object to import should be ignored.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"comparisonType":{"type":"string","description":"Comparison operator.","enum":["IS_NULL","IS_NOT_NULL","EQUALS","NOT_EQUALS","STARTS_WITH","ENDS_WITH","CONTAINS","NOT_CONTAINS","GREATER_THAN","GREATER_THAN_EQUALS","LESS_THAN","LESS_THAN_EQUALS"]},"matchingType":{"type":"string","description":"Does a single match already fail or must all values match?","enum":["ANY_MATCH","ALL_MATCH"]},"comparisonValue":{"type":"string","description":"Value that leads to exclusion."},"fieldToCompare":{"type":"string","description":"Which field's value is compared?"}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"common-data_import-ImportMappingRuleSetParameter":{"description":"Import rule set parameter.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Parameter name.","maxLength":255,"minLength":0},"requiredValueType":{"type":"string","description":"Parameter type, if it was predefined e.g. by a script module.","maxLength":255,"minLength":0,"readOnly":true},"fixedValue":{"type":"string","description":"Fixed value (only in combination with fixedValueType).","maxLength":255,"minLength":0},"fixedValueType":{"type":"string","description":"Fixed value data type (only in combination with fixedValue).","maxLength":255,"minLength":0},"queryPresetRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"variableMapping":{"type":"object","additionalProperties":{"type":"string","description":"Mapping from a query variable (key) to attribute paths in the import data (value)."},"description":"Mapping from a query variable (key) to attribute paths in the import data (value)."},"attributePath":{"type":"string","description":"Path to an attribute within the query from queryPresetRef."}},"required":["name"]},"common-data_import-ExportSetting":{"description":"When a file export module was selected: the export settings.","properties":{"fileName":{"type":"string","description":"File name without the file extension.","minLength":1},"charset":{"type":"string","default":"UTF_8_BOM","description":"Character set.","enum":["UTF_8","UTF_8_BOM","ASCII","LATIN_1"]},"csvSetting":{"$ref":"#/components/schemas/common-data_import-CsvExportSetting"},"jsonSetting":{"$ref":"#/components/schemas/common-data_import-JsonExportSetting"},"xmlSetting":{"$ref":"#/components/schemas/common-data_import-XmlExportSetting"}},"required":["charset","fileName"]},"common-data_import-CsvExportSetting":{"description":"Settings for the CSV export.","properties":{"targetFieldDefinitions":{"type":"array","description":"Column definitions (in the correct order).","items":{"type":"string","description":"Column definitions (in the correct order)."},"minItems":1},"columnSeparator":{"type":"string","default":";","description":"Column separator.","maxLength":1,"minLength":1},"quotingChar":{"type":"string","default":"\"","description":"Quoting character.","maxLength":1,"minLength":1},"writeHeaderLine":{"type":"boolean","default":true,"description":"Write a header row?"},"linebreakType":{"type":"string","default":"CR_LF","description":"Line break type.","enum":["CR_LF","CR","LF"]}},"required":["columnSeparator","linebreakType","quotingChar","targetFieldDefinitions"]},"common-data_import-JsonExportSetting":{"description":"Settings for the JSON export.","properties":{"rootFieldDefinitions":{"type":"array","description":"JSON field definitions.","items":{"$ref":"#/components/schemas/common-data_import-JsonExportSetting.FieldDefinition"},"minItems":1},"prettyPrint":{"type":"boolean","default":false,"description":"Should the JSON be pretty printed (uses more memory)?"},"linebreakType":{"type":"string","default":"CR_LF","description":"Line break type.","enum":["CR_LF","CR","LF"]}},"required":["rootFieldDefinitions"]},"common-data_import-JsonExportSetting.FieldDefinition":{"description":"JSON field definitions.","properties":{"name":{"type":"string","description":"Field name.","minLength":1},"type":{"type":"string","description":"Field data type.","enum":["TEXT","NUMBER","BOOLEAN","DATE","DATE_TIME","OBJECT"]},"children":{"type":"array","description":"For objects: the fields within the object.","items":{"$ref":"#/components/schemas/common-data_import-JsonExportSetting.FieldDefinition"}},"array":{"type":"boolean","default":false,"description":"Is the field an array?"}},"required":["name","type"]},"common-data_import-XmlExportSetting":{"description":"Settings for the XML export.","properties":{"rootTagName":{"type":"string","description":"XML root element."},"entryRootDefinition":{"$ref":"#/components/schemas/common-data_import-XmlExportSetting.FieldDefinition"},"prettyPrint":{"type":"boolean","default":false,"description":"Should the XML be pretty printed (uses more memory)?"},"writeXmlDeclaration":{"type":"boolean","default":true,"description":"Insert the XML declaration at the beginning of the file."}},"required":["entryRootDefinition","rootTagName"]},"common-data_import-XmlExportSetting.FieldDefinition":{"description":"Individual record structure.","properties":{"name":{"type":"string","description":"XML tag name.","minLength":1},"attributes":{"type":"array","description":"Attributes within the tag.","items":{"type":"string","description":"Attributes within the tag."}},"childTags":{"type":"array","description":"Optional: tags within this tag.","items":{"$ref":"#/components/schemas/common-data_import-XmlExportSetting.FieldDefinition"}}},"required":["name"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation  (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Search dialogs to use.","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Search dialogs to use.","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Key for the search dialog result.","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}}}}}
```

## PUT /cmn/data-import/rule-sets/{id}

> Update existing Resource&#x20;

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"ImportRuleSet","description":"Import rule sets."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/data-import/rule-sets/{id}":{"put":{"tags":["ImportRuleSet"],"summary":"Update existing Resource ","operationId":"update_140","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-data_import-ImportMappingRuleSet"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-data_import-ImportMappingRuleSet"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-data_import-ImportMappingRuleSet":{"description":"Rule set for the import run.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"mode":{"type":"string","description":"Mode.","enum":["SCRIPT","IMPORT","EXPORT"]},"label":{"type":"string","description":"Unique label."},"root":{"type":"string","description":"For JSON and XML import: at which path do the import data start?"},"rules":{"type":"array","description":"Mapping rules.","items":{"$ref":"#/components/schemas/common-data_import-ImportMappingRule"}},"importModuleKey":{"type":"string","description":"Which import this rule set applies to."},"dataFrom":{"type":"integer","format":"int64","description":"First record index (1-based) - all preceding ones are ignored."},"dataTo":{"type":"integer","format":"int64","description":"Last record index (1-based) - all following ones are ignored."},"headerIndex":{"type":"integer","format":"int64","description":"If present: header row index (1-based)."},"columnSeparator":{"type":"string","description":"CSV only: separator within a row."},"fixedWidthColumnDefinitions":{"type":"array","description":"Column definitions used to split fixed-width rows","items":{"$ref":"#/components/schemas/common-data_import-FixedWidthColumnDefinition"}},"charSet":{"type":"string","description":"For CSV and JSON: the character set used.","enum":["UTF_8","ASCII","LATIN_1","AUTO_DETECT"]},"quotingChar":{"type":"string","description":"CSV only: character used to quote a text field (usually ' or \")."},"targetFieldRules":{"type":"array","description":"Indicates how target fields and sub-objects are handled.","items":{"$ref":"#/components/schemas/common-data_import-TargetFieldRule"}},"createRulesForEavGroup":{"type":"string","description":"Indicates that rules should be generated for an EAV group on execution."},"defaultDateFormatDirective":{"$ref":"#/components/schemas/common-data_import-FormatDirective"},"defaultDateTimeFormatDirective":{"$ref":"#/components/schemas/common-data_import-FormatDirective"},"defaultNumberFormatDirective":{"$ref":"#/components/schemas/common-data_import-FormatDirective"},"defaultBooleanFormatDirective":{"$ref":"#/components/schemas/common-data_import-FormatDirective"},"script":{"type":"string","description":"When mode == SCRIPT: the script to execute. Only the script or the script module may be set."},"scriptModuleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"parameters":{"type":"array","description":"Script parameters.","items":{"$ref":"#/components/schemas/common-data_import-ImportMappingRuleSetParameter"}},"parallelExecutionAllowed":{"type":"boolean","default":true,"description":"Is splitting into several tasks executed in parallel allowed?"},"advancedUi":{"type":"boolean","default":false,"description":"Use the advanced representation in the UI?"},"ignoreEmptyData":{"type":"boolean","default":false,"description":"For JSON import: ignore an empty data set?"},"exportSetting":{"$ref":"#/components/schemas/common-data_import-ExportSetting"},"suppressWebhooks":{"type":"boolean","default":false,"description":"Should webhooks be disabled during the execution?"},"suppressWorkflows":{"type":"boolean","default":false,"description":"Should workflows be disabled during the execution?"},"createMissingHeadersFromRuleSet":{"type":"boolean","default":false,"description":"JSON and XML only: generate missing headers automatically from the columns referenced in the rule set?"}},"required":["mode"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-data_import-ImportMappingRule":{"description":"Mapping rules.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"transformation":{"$ref":"#/components/schemas/common-data_import-Transformation"}},"required":["transformation"]},"common-data_import-Transformation":{"description":"Indicates how the value for target is produced.","properties":{"type":{"type":"string","description":"Transformation type.","enum":["DIRECT","CONCAT","TRIM","UPPER_CASE","LOWER_CASE","REPLACE","REGEX_REPLACE","FIXED_VALUE","COALESCE","ROW_INDEX","GET_AT_INDEX","ITERATE","GROUP_TO_OBJECT","MODULE_SPECIFIC"]},"children":{"type":"array","description":"Sub-transformations as input for the transformation.","items":{"$ref":"#/components/schemas/common-data_import-Transformation"}},"columnName":{"type":"string","description":"For DIRECT, GET_AT_INDEX and ITERATE: the column the data are taken from."},"fixedValue":{"type":"string","description":"For FIXED_VALUE: the value."},"replacements":{"type":"array","description":"For REPLACE: the replacements.","items":{"$ref":"#/components/schemas/common-data_import-Transformation.Replacement"}},"matchWholeFieldsOnly":{"type":"boolean","description":"For REPLACE: replace only when the whole value matches, no substrings."},"regexSearch":{"type":"string","description":"For REGEX_REPLACE: the regular expression to search for."},"regexReplacement":{"type":"string","description":"For REGEX_REPLACE: the replacement applied for the regular expression."},"caseSensitive":{"type":"boolean","description":"For (REGEX_)REPLACE: replace only when the case matches?"},"useDefaultValueForReplacement":{"type":"boolean","default":false,"description":"For REPLACE with matchWholeFieldsOnly: should the default value be used when no expression matches?"},"defaultValue":{"type":"string","description":"For REPLACE with matchWholeFieldsOnly: the replacement when no expression matches."},"index":{"type":"integer","format":"int32","description":"For GET_AT_INDEX: which array element is wanted (0-based index)?"},"target":{"type":"string","description":"Target the transformation result is written to."},"formatDirective":{"$ref":"#/components/schemas/common-data_import-FormatDirective"},"moduleSpecificTransformationKey":{"type":"string","description":"Key for special transformations."},"suppressFailures":{"type":"boolean","description":"For special transformations: ignore an error and use null instead?"},"auxiliaryTransformation":{"type":"boolean","default":false,"description":"Is this an auxiliary transformation without a real mapping target?"},"dataType":{"type":"string","description":"For auxiliary transformations: the data type."}},"required":["type"]},"common-data_import-Transformation.Replacement":{"description":"For REPLACE: the replacements.","properties":{"from":{"type":"string","description":"String to replace.","minLength":1},"to":{"type":"string","description":"Replacement for the string."}},"required":["from"]},"common-data_import-FormatDirective":{"description":"Default format for boolean values.","properties":{"formatType":{"type":"string","description":"Which data type this formatting is intended for.","enum":["NUMERIC","DATE","DATETIME","BOOLEAN"]},"patternString":{"type":"string","description":"For DATE and DATETIME: a pattern for parsing."},"groupingSign":{"type":"string","description":"Thousands separator for numeric values."},"decimalSign":{"type":"string","description":"Decimal separator for numeric values."},"representationForTrue":{"type":"string","description":"Text representing the boolean value true (for example 'J')."},"representationForFalse":{"type":"string","description":"Text representing the boolean value false (for example 'N')."}},"required":["formatType"]},"common-data_import-FixedWidthColumnDefinition":{"description":"Column definitions used to split fixed-width rows","properties":{"startPosition":{"type":"integer","format":"int32","description":"Column starting position","minimum":1},"padChar":{"type":"string","description":"will be removed if found at the beginning or end of the column","maxLength":1,"minLength":1}},"required":["startPosition"]},"common-data_import-TargetFieldRule":{"description":"Indicates how target fields and sub-objects are handled.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"path":{"type":"string","description":"Path to the sub-object or field."},"lookupFields":{"type":"array","description":"Which fields identify the object? Only for LOAD_OR_INSERT, UPDATE and UPSERT.","items":{"type":"string","description":"Which fields identify the object? Only for LOAD_OR_INSERT, UPDATE and UPSERT."}},"policy":{"type":"string","description":"How should sub-objects be handled?","enum":["LOAD","INSERT","INSERT_FACTORY","UPSERT","UPDATE","LOAD_OR_INSERT","LOAD_OR_IGNORE"]},"nullValueHandlingStrategy":{"type":"string","description":"How should a null value be handled?","enum":["IGNORE","OVERRIDE"]},"ignoreRules":{"type":"array","description":"Conditions under which the object to import should be ignored.","items":{"$ref":"#/components/schemas/common-data_import-IgnoreRule"}}},"required":["path"]},"common-data_import-IgnoreRule":{"description":"Conditions under which the object to import should be ignored.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"comparisonType":{"type":"string","description":"Comparison operator.","enum":["IS_NULL","IS_NOT_NULL","EQUALS","NOT_EQUALS","STARTS_WITH","ENDS_WITH","CONTAINS","NOT_CONTAINS","GREATER_THAN","GREATER_THAN_EQUALS","LESS_THAN","LESS_THAN_EQUALS"]},"matchingType":{"type":"string","description":"Does a single match already fail or must all values match?","enum":["ANY_MATCH","ALL_MATCH"]},"comparisonValue":{"type":"string","description":"Value that leads to exclusion."},"fieldToCompare":{"type":"string","description":"Which field's value is compared?"}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"common-data_import-ImportMappingRuleSetParameter":{"description":"Import rule set parameter.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Parameter name.","maxLength":255,"minLength":0},"requiredValueType":{"type":"string","description":"Parameter type, if it was predefined e.g. by a script module.","maxLength":255,"minLength":0,"readOnly":true},"fixedValue":{"type":"string","description":"Fixed value (only in combination with fixedValueType).","maxLength":255,"minLength":0},"fixedValueType":{"type":"string","description":"Fixed value data type (only in combination with fixedValue).","maxLength":255,"minLength":0},"queryPresetRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"variableMapping":{"type":"object","additionalProperties":{"type":"string","description":"Mapping from a query variable (key) to attribute paths in the import data (value)."},"description":"Mapping from a query variable (key) to attribute paths in the import data (value)."},"attributePath":{"type":"string","description":"Path to an attribute within the query from queryPresetRef."}},"required":["name"]},"common-data_import-ExportSetting":{"description":"When a file export module was selected: the export settings.","properties":{"fileName":{"type":"string","description":"File name without the file extension.","minLength":1},"charset":{"type":"string","default":"UTF_8_BOM","description":"Character set.","enum":["UTF_8","UTF_8_BOM","ASCII","LATIN_1"]},"csvSetting":{"$ref":"#/components/schemas/common-data_import-CsvExportSetting"},"jsonSetting":{"$ref":"#/components/schemas/common-data_import-JsonExportSetting"},"xmlSetting":{"$ref":"#/components/schemas/common-data_import-XmlExportSetting"}},"required":["charset","fileName"]},"common-data_import-CsvExportSetting":{"description":"Settings for the CSV export.","properties":{"targetFieldDefinitions":{"type":"array","description":"Column definitions (in the correct order).","items":{"type":"string","description":"Column definitions (in the correct order)."},"minItems":1},"columnSeparator":{"type":"string","default":";","description":"Column separator.","maxLength":1,"minLength":1},"quotingChar":{"type":"string","default":"\"","description":"Quoting character.","maxLength":1,"minLength":1},"writeHeaderLine":{"type":"boolean","default":true,"description":"Write a header row?"},"linebreakType":{"type":"string","default":"CR_LF","description":"Line break type.","enum":["CR_LF","CR","LF"]}},"required":["columnSeparator","linebreakType","quotingChar","targetFieldDefinitions"]},"common-data_import-JsonExportSetting":{"description":"Settings for the JSON export.","properties":{"rootFieldDefinitions":{"type":"array","description":"JSON field definitions.","items":{"$ref":"#/components/schemas/common-data_import-JsonExportSetting.FieldDefinition"},"minItems":1},"prettyPrint":{"type":"boolean","default":false,"description":"Should the JSON be pretty printed (uses more memory)?"},"linebreakType":{"type":"string","default":"CR_LF","description":"Line break type.","enum":["CR_LF","CR","LF"]}},"required":["rootFieldDefinitions"]},"common-data_import-JsonExportSetting.FieldDefinition":{"description":"JSON field definitions.","properties":{"name":{"type":"string","description":"Field name.","minLength":1},"type":{"type":"string","description":"Field data type.","enum":["TEXT","NUMBER","BOOLEAN","DATE","DATE_TIME","OBJECT"]},"children":{"type":"array","description":"For objects: the fields within the object.","items":{"$ref":"#/components/schemas/common-data_import-JsonExportSetting.FieldDefinition"}},"array":{"type":"boolean","default":false,"description":"Is the field an array?"}},"required":["name","type"]},"common-data_import-XmlExportSetting":{"description":"Settings for the XML export.","properties":{"rootTagName":{"type":"string","description":"XML root element."},"entryRootDefinition":{"$ref":"#/components/schemas/common-data_import-XmlExportSetting.FieldDefinition"},"prettyPrint":{"type":"boolean","default":false,"description":"Should the XML be pretty printed (uses more memory)?"},"writeXmlDeclaration":{"type":"boolean","default":true,"description":"Insert the XML declaration at the beginning of the file."}},"required":["entryRootDefinition","rootTagName"]},"common-data_import-XmlExportSetting.FieldDefinition":{"description":"Individual record structure.","properties":{"name":{"type":"string","description":"XML tag name.","minLength":1},"attributes":{"type":"array","description":"Attributes within the tag.","items":{"type":"string","description":"Attributes within the tag."}},"childTags":{"type":"array","description":"Optional: tags within this tag.","items":{"$ref":"#/components/schemas/common-data_import-XmlExportSetting.FieldDefinition"}}},"required":["name"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation  (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Search dialogs to use.","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Search dialogs to use.","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Key for the search dialog result.","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}}}}}
```

## DELETE /cmn/data-import/rule-sets/{id}

> Delete an existing Resource

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"ImportRuleSet","description":"Import rule sets."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/data-import/rule-sets/{id}":{"delete":{"tags":["ImportRuleSet"],"summary":"Delete an existing Resource","operationId":"delete_125","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation  (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Search dialogs to use.","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Search dialogs to use.","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Key for the search dialog result.","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}}}}}
```

## POST /cmn/data-import/rule-sets

> Create new Resource

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"ImportRuleSet","description":"Import rule sets."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/data-import/rule-sets":{"post":{"tags":["ImportRuleSet"],"summary":"Create new Resource","operationId":"create_129","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-data_import-ImportMappingRuleSet"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-data_import-ImportMappingRuleSet"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-data_import-ImportMappingRuleSet":{"description":"Rule set for the import run.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"mode":{"type":"string","description":"Mode.","enum":["SCRIPT","IMPORT","EXPORT"]},"label":{"type":"string","description":"Unique label."},"root":{"type":"string","description":"For JSON and XML import: at which path do the import data start?"},"rules":{"type":"array","description":"Mapping rules.","items":{"$ref":"#/components/schemas/common-data_import-ImportMappingRule"}},"importModuleKey":{"type":"string","description":"Which import this rule set applies to."},"dataFrom":{"type":"integer","format":"int64","description":"First record index (1-based) - all preceding ones are ignored."},"dataTo":{"type":"integer","format":"int64","description":"Last record index (1-based) - all following ones are ignored."},"headerIndex":{"type":"integer","format":"int64","description":"If present: header row index (1-based)."},"columnSeparator":{"type":"string","description":"CSV only: separator within a row."},"fixedWidthColumnDefinitions":{"type":"array","description":"Column definitions used to split fixed-width rows","items":{"$ref":"#/components/schemas/common-data_import-FixedWidthColumnDefinition"}},"charSet":{"type":"string","description":"For CSV and JSON: the character set used.","enum":["UTF_8","ASCII","LATIN_1","AUTO_DETECT"]},"quotingChar":{"type":"string","description":"CSV only: character used to quote a text field (usually ' or \")."},"targetFieldRules":{"type":"array","description":"Indicates how target fields and sub-objects are handled.","items":{"$ref":"#/components/schemas/common-data_import-TargetFieldRule"}},"createRulesForEavGroup":{"type":"string","description":"Indicates that rules should be generated for an EAV group on execution."},"defaultDateFormatDirective":{"$ref":"#/components/schemas/common-data_import-FormatDirective"},"defaultDateTimeFormatDirective":{"$ref":"#/components/schemas/common-data_import-FormatDirective"},"defaultNumberFormatDirective":{"$ref":"#/components/schemas/common-data_import-FormatDirective"},"defaultBooleanFormatDirective":{"$ref":"#/components/schemas/common-data_import-FormatDirective"},"script":{"type":"string","description":"When mode == SCRIPT: the script to execute. Only the script or the script module may be set."},"scriptModuleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"parameters":{"type":"array","description":"Script parameters.","items":{"$ref":"#/components/schemas/common-data_import-ImportMappingRuleSetParameter"}},"parallelExecutionAllowed":{"type":"boolean","default":true,"description":"Is splitting into several tasks executed in parallel allowed?"},"advancedUi":{"type":"boolean","default":false,"description":"Use the advanced representation in the UI?"},"ignoreEmptyData":{"type":"boolean","default":false,"description":"For JSON import: ignore an empty data set?"},"exportSetting":{"$ref":"#/components/schemas/common-data_import-ExportSetting"},"suppressWebhooks":{"type":"boolean","default":false,"description":"Should webhooks be disabled during the execution?"},"suppressWorkflows":{"type":"boolean","default":false,"description":"Should workflows be disabled during the execution?"},"createMissingHeadersFromRuleSet":{"type":"boolean","default":false,"description":"JSON and XML only: generate missing headers automatically from the columns referenced in the rule set?"}},"required":["mode"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-data_import-ImportMappingRule":{"description":"Mapping rules.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"transformation":{"$ref":"#/components/schemas/common-data_import-Transformation"}},"required":["transformation"]},"common-data_import-Transformation":{"description":"Indicates how the value for target is produced.","properties":{"type":{"type":"string","description":"Transformation type.","enum":["DIRECT","CONCAT","TRIM","UPPER_CASE","LOWER_CASE","REPLACE","REGEX_REPLACE","FIXED_VALUE","COALESCE","ROW_INDEX","GET_AT_INDEX","ITERATE","GROUP_TO_OBJECT","MODULE_SPECIFIC"]},"children":{"type":"array","description":"Sub-transformations as input for the transformation.","items":{"$ref":"#/components/schemas/common-data_import-Transformation"}},"columnName":{"type":"string","description":"For DIRECT, GET_AT_INDEX and ITERATE: the column the data are taken from."},"fixedValue":{"type":"string","description":"For FIXED_VALUE: the value."},"replacements":{"type":"array","description":"For REPLACE: the replacements.","items":{"$ref":"#/components/schemas/common-data_import-Transformation.Replacement"}},"matchWholeFieldsOnly":{"type":"boolean","description":"For REPLACE: replace only when the whole value matches, no substrings."},"regexSearch":{"type":"string","description":"For REGEX_REPLACE: the regular expression to search for."},"regexReplacement":{"type":"string","description":"For REGEX_REPLACE: the replacement applied for the regular expression."},"caseSensitive":{"type":"boolean","description":"For (REGEX_)REPLACE: replace only when the case matches?"},"useDefaultValueForReplacement":{"type":"boolean","default":false,"description":"For REPLACE with matchWholeFieldsOnly: should the default value be used when no expression matches?"},"defaultValue":{"type":"string","description":"For REPLACE with matchWholeFieldsOnly: the replacement when no expression matches."},"index":{"type":"integer","format":"int32","description":"For GET_AT_INDEX: which array element is wanted (0-based index)?"},"target":{"type":"string","description":"Target the transformation result is written to."},"formatDirective":{"$ref":"#/components/schemas/common-data_import-FormatDirective"},"moduleSpecificTransformationKey":{"type":"string","description":"Key for special transformations."},"suppressFailures":{"type":"boolean","description":"For special transformations: ignore an error and use null instead?"},"auxiliaryTransformation":{"type":"boolean","default":false,"description":"Is this an auxiliary transformation without a real mapping target?"},"dataType":{"type":"string","description":"For auxiliary transformations: the data type."}},"required":["type"]},"common-data_import-Transformation.Replacement":{"description":"For REPLACE: the replacements.","properties":{"from":{"type":"string","description":"String to replace.","minLength":1},"to":{"type":"string","description":"Replacement for the string."}},"required":["from"]},"common-data_import-FormatDirective":{"description":"Default format for boolean values.","properties":{"formatType":{"type":"string","description":"Which data type this formatting is intended for.","enum":["NUMERIC","DATE","DATETIME","BOOLEAN"]},"patternString":{"type":"string","description":"For DATE and DATETIME: a pattern for parsing."},"groupingSign":{"type":"string","description":"Thousands separator for numeric values."},"decimalSign":{"type":"string","description":"Decimal separator for numeric values."},"representationForTrue":{"type":"string","description":"Text representing the boolean value true (for example 'J')."},"representationForFalse":{"type":"string","description":"Text representing the boolean value false (for example 'N')."}},"required":["formatType"]},"common-data_import-FixedWidthColumnDefinition":{"description":"Column definitions used to split fixed-width rows","properties":{"startPosition":{"type":"integer","format":"int32","description":"Column starting position","minimum":1},"padChar":{"type":"string","description":"will be removed if found at the beginning or end of the column","maxLength":1,"minLength":1}},"required":["startPosition"]},"common-data_import-TargetFieldRule":{"description":"Indicates how target fields and sub-objects are handled.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"path":{"type":"string","description":"Path to the sub-object or field."},"lookupFields":{"type":"array","description":"Which fields identify the object? Only for LOAD_OR_INSERT, UPDATE and UPSERT.","items":{"type":"string","description":"Which fields identify the object? Only for LOAD_OR_INSERT, UPDATE and UPSERT."}},"policy":{"type":"string","description":"How should sub-objects be handled?","enum":["LOAD","INSERT","INSERT_FACTORY","UPSERT","UPDATE","LOAD_OR_INSERT","LOAD_OR_IGNORE"]},"nullValueHandlingStrategy":{"type":"string","description":"How should a null value be handled?","enum":["IGNORE","OVERRIDE"]},"ignoreRules":{"type":"array","description":"Conditions under which the object to import should be ignored.","items":{"$ref":"#/components/schemas/common-data_import-IgnoreRule"}}},"required":["path"]},"common-data_import-IgnoreRule":{"description":"Conditions under which the object to import should be ignored.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"comparisonType":{"type":"string","description":"Comparison operator.","enum":["IS_NULL","IS_NOT_NULL","EQUALS","NOT_EQUALS","STARTS_WITH","ENDS_WITH","CONTAINS","NOT_CONTAINS","GREATER_THAN","GREATER_THAN_EQUALS","LESS_THAN","LESS_THAN_EQUALS"]},"matchingType":{"type":"string","description":"Does a single match already fail or must all values match?","enum":["ANY_MATCH","ALL_MATCH"]},"comparisonValue":{"type":"string","description":"Value that leads to exclusion."},"fieldToCompare":{"type":"string","description":"Which field's value is compared?"}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"common-data_import-ImportMappingRuleSetParameter":{"description":"Import rule set parameter.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Parameter name.","maxLength":255,"minLength":0},"requiredValueType":{"type":"string","description":"Parameter type, if it was predefined e.g. by a script module.","maxLength":255,"minLength":0,"readOnly":true},"fixedValue":{"type":"string","description":"Fixed value (only in combination with fixedValueType).","maxLength":255,"minLength":0},"fixedValueType":{"type":"string","description":"Fixed value data type (only in combination with fixedValue).","maxLength":255,"minLength":0},"queryPresetRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"variableMapping":{"type":"object","additionalProperties":{"type":"string","description":"Mapping from a query variable (key) to attribute paths in the import data (value)."},"description":"Mapping from a query variable (key) to attribute paths in the import data (value)."},"attributePath":{"type":"string","description":"Path to an attribute within the query from queryPresetRef."}},"required":["name"]},"common-data_import-ExportSetting":{"description":"When a file export module was selected: the export settings.","properties":{"fileName":{"type":"string","description":"File name without the file extension.","minLength":1},"charset":{"type":"string","default":"UTF_8_BOM","description":"Character set.","enum":["UTF_8","UTF_8_BOM","ASCII","LATIN_1"]},"csvSetting":{"$ref":"#/components/schemas/common-data_import-CsvExportSetting"},"jsonSetting":{"$ref":"#/components/schemas/common-data_import-JsonExportSetting"},"xmlSetting":{"$ref":"#/components/schemas/common-data_import-XmlExportSetting"}},"required":["charset","fileName"]},"common-data_import-CsvExportSetting":{"description":"Settings for the CSV export.","properties":{"targetFieldDefinitions":{"type":"array","description":"Column definitions (in the correct order).","items":{"type":"string","description":"Column definitions (in the correct order)."},"minItems":1},"columnSeparator":{"type":"string","default":";","description":"Column separator.","maxLength":1,"minLength":1},"quotingChar":{"type":"string","default":"\"","description":"Quoting character.","maxLength":1,"minLength":1},"writeHeaderLine":{"type":"boolean","default":true,"description":"Write a header row?"},"linebreakType":{"type":"string","default":"CR_LF","description":"Line break type.","enum":["CR_LF","CR","LF"]}},"required":["columnSeparator","linebreakType","quotingChar","targetFieldDefinitions"]},"common-data_import-JsonExportSetting":{"description":"Settings for the JSON export.","properties":{"rootFieldDefinitions":{"type":"array","description":"JSON field definitions.","items":{"$ref":"#/components/schemas/common-data_import-JsonExportSetting.FieldDefinition"},"minItems":1},"prettyPrint":{"type":"boolean","default":false,"description":"Should the JSON be pretty printed (uses more memory)?"},"linebreakType":{"type":"string","default":"CR_LF","description":"Line break type.","enum":["CR_LF","CR","LF"]}},"required":["rootFieldDefinitions"]},"common-data_import-JsonExportSetting.FieldDefinition":{"description":"JSON field definitions.","properties":{"name":{"type":"string","description":"Field name.","minLength":1},"type":{"type":"string","description":"Field data type.","enum":["TEXT","NUMBER","BOOLEAN","DATE","DATE_TIME","OBJECT"]},"children":{"type":"array","description":"For objects: the fields within the object.","items":{"$ref":"#/components/schemas/common-data_import-JsonExportSetting.FieldDefinition"}},"array":{"type":"boolean","default":false,"description":"Is the field an array?"}},"required":["name","type"]},"common-data_import-XmlExportSetting":{"description":"Settings for the XML export.","properties":{"rootTagName":{"type":"string","description":"XML root element."},"entryRootDefinition":{"$ref":"#/components/schemas/common-data_import-XmlExportSetting.FieldDefinition"},"prettyPrint":{"type":"boolean","default":false,"description":"Should the XML be pretty printed (uses more memory)?"},"writeXmlDeclaration":{"type":"boolean","default":true,"description":"Insert the XML declaration at the beginning of the file."}},"required":["entryRootDefinition","rootTagName"]},"common-data_import-XmlExportSetting.FieldDefinition":{"description":"Individual record structure.","properties":{"name":{"type":"string","description":"XML tag name.","minLength":1},"attributes":{"type":"array","description":"Attributes within the tag.","items":{"type":"string","description":"Attributes within the tag."}},"childTags":{"type":"array","description":"Optional: tags within this tag.","items":{"$ref":"#/components/schemas/common-data_import-XmlExportSetting.FieldDefinition"}}},"required":["name"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation  (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Search dialogs to use.","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Search dialogs to use.","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Key for the search dialog result.","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}}}}}
```

## GET /cmn/data-import/rule-sets/{id}/target-fields

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"ImportRuleSet","description":"Import rule sets."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/data-import/rule-sets/{id}/target-fields":{"get":{"tags":["ImportRuleSet"],"operationId":"getAccessibleFields","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/common-data_import-BatchProcessingTargetFieldApi"}}}}}}}}},"components":{"schemas":{"common-data_import-BatchProcessingTargetFieldApi":{"properties":{"path":{"type":"string","description":"Path relevant for the mapping."},"displayName":{"type":"string","description":"Field display name."},"dataType":{"$ref":"#/components/schemas/core-cunit-CuAttributeDataType"},"constraint":{"$ref":"#/components/schemas/core-cunit-CuAttributeConstraint"},"modelType":{"type":"string","description":"Is this a dynamic or a static field?","enum":["STATIC","DYNAMIC"]}}},"core-cunit-CuAttributeDataType":{"description":"Attribute data type (when dataTypeIdentifier is empty).","properties":{"identifier":{"type":"string","description":"Datentyp-identifier","readOnly":true},"jsType":{"type":"string","description":"Which type it is.","readOnly":true},"objectRefIdentifier":{"type":"string","description":"For Object_Ref: which type exactly it is.","readOnly":true},"filterOptions":{"$ref":"#/components/schemas/core-cunit-CuAttributeFilterOptions"},"functions":{"type":"array","description":"Which functions are allowed?","items":{"type":"string","description":"Which functions are allowed?"},"readOnly":true},"predicateOperations":{"type":"array","description":"Which operations are allowed?","items":{"type":"string","description":"Which operations are allowed?","enum":["AND","OR","EQUALS","NOT_EQUALS","LIKE","NOT_LIKE","STARTS_WITH","ENDS_WITH","CONTAINS","NOT_CONTAINS","GREATER_THAN","GREATER_THAN_EQUALS","LESS_THAN","LESS_THAN_EQUALS","IN","NOT_IN","RANGE","NOT_RANGE","IS_NULL","IS_NOT_NULL","IS_NULL_OR_EQUALS","EXISTS","NOT_EXISTS"]},"readOnly":true}}},"core-cunit-CuAttributeFilterOptions":{"description":"CUnit attribute filter options.","properties":{"filterValues":{"type":"array","description":"Possible filter values.","items":{"type":"string","description":"Possible filter values."}},"filterDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"multipleChoice":{"type":"boolean","default":false,"description":"Is a multiple selection allowed?"}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}},"core-cunit-CuAttributeConstraint":{"description":"Attribute constraints.","properties":{"minLength":{"type":"integer","format":"int32","description":"Minimum length (of strings or arrays).","readOnly":true},"maxLength":{"type":"integer","format":"int32","description":"Maximum length (of strings or arrays).","readOnly":true},"minValue":{"type":"integer","format":"int64","description":"Minimum value.","readOnly":true},"includeMinValue":{"type":"boolean","description":"Is the minimum value inclusive?","readOnly":true},"maxValue":{"type":"integer","format":"int64","description":"Maximum value.","readOnly":true},"includeMaxValue":{"type":"boolean","description":"Is the maximum value inclusive?","readOnly":true},"notNull":{"type":"boolean","default":false,"description":"Is the value 'null' forbidden?","readOnly":true},"notBlank":{"type":"boolean","description":"For strings: is a string consisting only of whitespace forbidden?","readOnly":true},"digitsFraction":{"type":"integer","format":"int32","description":"Maximum number of decimal places.","readOnly":true}}}}}}
```

## GET /cmn/data-import/rule-sets/{id}/copy

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"ImportRuleSet","description":"Import rule sets."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/data-import/rule-sets/{id}/copy":{"get":{"tags":["ImportRuleSet"],"operationId":"getCopy_1","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-data_import-ImportMappingRuleSet"}}}}}}}},"components":{"schemas":{"common-data_import-ImportMappingRuleSet":{"description":"Rule set for the import run.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"mode":{"type":"string","description":"Mode.","enum":["SCRIPT","IMPORT","EXPORT"]},"label":{"type":"string","description":"Unique label."},"root":{"type":"string","description":"For JSON and XML import: at which path do the import data start?"},"rules":{"type":"array","description":"Mapping rules.","items":{"$ref":"#/components/schemas/common-data_import-ImportMappingRule"}},"importModuleKey":{"type":"string","description":"Which import this rule set applies to."},"dataFrom":{"type":"integer","format":"int64","description":"First record index (1-based) - all preceding ones are ignored."},"dataTo":{"type":"integer","format":"int64","description":"Last record index (1-based) - all following ones are ignored."},"headerIndex":{"type":"integer","format":"int64","description":"If present: header row index (1-based)."},"columnSeparator":{"type":"string","description":"CSV only: separator within a row."},"fixedWidthColumnDefinitions":{"type":"array","description":"Column definitions used to split fixed-width rows","items":{"$ref":"#/components/schemas/common-data_import-FixedWidthColumnDefinition"}},"charSet":{"type":"string","description":"For CSV and JSON: the character set used.","enum":["UTF_8","ASCII","LATIN_1","AUTO_DETECT"]},"quotingChar":{"type":"string","description":"CSV only: character used to quote a text field (usually ' or \")."},"targetFieldRules":{"type":"array","description":"Indicates how target fields and sub-objects are handled.","items":{"$ref":"#/components/schemas/common-data_import-TargetFieldRule"}},"createRulesForEavGroup":{"type":"string","description":"Indicates that rules should be generated for an EAV group on execution."},"defaultDateFormatDirective":{"$ref":"#/components/schemas/common-data_import-FormatDirective"},"defaultDateTimeFormatDirective":{"$ref":"#/components/schemas/common-data_import-FormatDirective"},"defaultNumberFormatDirective":{"$ref":"#/components/schemas/common-data_import-FormatDirective"},"defaultBooleanFormatDirective":{"$ref":"#/components/schemas/common-data_import-FormatDirective"},"script":{"type":"string","description":"When mode == SCRIPT: the script to execute. Only the script or the script module may be set."},"scriptModuleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"parameters":{"type":"array","description":"Script parameters.","items":{"$ref":"#/components/schemas/common-data_import-ImportMappingRuleSetParameter"}},"parallelExecutionAllowed":{"type":"boolean","default":true,"description":"Is splitting into several tasks executed in parallel allowed?"},"advancedUi":{"type":"boolean","default":false,"description":"Use the advanced representation in the UI?"},"ignoreEmptyData":{"type":"boolean","default":false,"description":"For JSON import: ignore an empty data set?"},"exportSetting":{"$ref":"#/components/schemas/common-data_import-ExportSetting"},"suppressWebhooks":{"type":"boolean","default":false,"description":"Should webhooks be disabled during the execution?"},"suppressWorkflows":{"type":"boolean","default":false,"description":"Should workflows be disabled during the execution?"},"createMissingHeadersFromRuleSet":{"type":"boolean","default":false,"description":"JSON and XML only: generate missing headers automatically from the columns referenced in the rule set?"}},"required":["mode"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-data_import-ImportMappingRule":{"description":"Mapping rules.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"transformation":{"$ref":"#/components/schemas/common-data_import-Transformation"}},"required":["transformation"]},"common-data_import-Transformation":{"description":"Indicates how the value for target is produced.","properties":{"type":{"type":"string","description":"Transformation type.","enum":["DIRECT","CONCAT","TRIM","UPPER_CASE","LOWER_CASE","REPLACE","REGEX_REPLACE","FIXED_VALUE","COALESCE","ROW_INDEX","GET_AT_INDEX","ITERATE","GROUP_TO_OBJECT","MODULE_SPECIFIC"]},"children":{"type":"array","description":"Sub-transformations as input for the transformation.","items":{"$ref":"#/components/schemas/common-data_import-Transformation"}},"columnName":{"type":"string","description":"For DIRECT, GET_AT_INDEX and ITERATE: the column the data are taken from."},"fixedValue":{"type":"string","description":"For FIXED_VALUE: the value."},"replacements":{"type":"array","description":"For REPLACE: the replacements.","items":{"$ref":"#/components/schemas/common-data_import-Transformation.Replacement"}},"matchWholeFieldsOnly":{"type":"boolean","description":"For REPLACE: replace only when the whole value matches, no substrings."},"regexSearch":{"type":"string","description":"For REGEX_REPLACE: the regular expression to search for."},"regexReplacement":{"type":"string","description":"For REGEX_REPLACE: the replacement applied for the regular expression."},"caseSensitive":{"type":"boolean","description":"For (REGEX_)REPLACE: replace only when the case matches?"},"useDefaultValueForReplacement":{"type":"boolean","default":false,"description":"For REPLACE with matchWholeFieldsOnly: should the default value be used when no expression matches?"},"defaultValue":{"type":"string","description":"For REPLACE with matchWholeFieldsOnly: the replacement when no expression matches."},"index":{"type":"integer","format":"int32","description":"For GET_AT_INDEX: which array element is wanted (0-based index)?"},"target":{"type":"string","description":"Target the transformation result is written to."},"formatDirective":{"$ref":"#/components/schemas/common-data_import-FormatDirective"},"moduleSpecificTransformationKey":{"type":"string","description":"Key for special transformations."},"suppressFailures":{"type":"boolean","description":"For special transformations: ignore an error and use null instead?"},"auxiliaryTransformation":{"type":"boolean","default":false,"description":"Is this an auxiliary transformation without a real mapping target?"},"dataType":{"type":"string","description":"For auxiliary transformations: the data type."}},"required":["type"]},"common-data_import-Transformation.Replacement":{"description":"For REPLACE: the replacements.","properties":{"from":{"type":"string","description":"String to replace.","minLength":1},"to":{"type":"string","description":"Replacement for the string."}},"required":["from"]},"common-data_import-FormatDirective":{"description":"Default format for boolean values.","properties":{"formatType":{"type":"string","description":"Which data type this formatting is intended for.","enum":["NUMERIC","DATE","DATETIME","BOOLEAN"]},"patternString":{"type":"string","description":"For DATE and DATETIME: a pattern for parsing."},"groupingSign":{"type":"string","description":"Thousands separator for numeric values."},"decimalSign":{"type":"string","description":"Decimal separator for numeric values."},"representationForTrue":{"type":"string","description":"Text representing the boolean value true (for example 'J')."},"representationForFalse":{"type":"string","description":"Text representing the boolean value false (for example 'N')."}},"required":["formatType"]},"common-data_import-FixedWidthColumnDefinition":{"description":"Column definitions used to split fixed-width rows","properties":{"startPosition":{"type":"integer","format":"int32","description":"Column starting position","minimum":1},"padChar":{"type":"string","description":"will be removed if found at the beginning or end of the column","maxLength":1,"minLength":1}},"required":["startPosition"]},"common-data_import-TargetFieldRule":{"description":"Indicates how target fields and sub-objects are handled.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"path":{"type":"string","description":"Path to the sub-object or field."},"lookupFields":{"type":"array","description":"Which fields identify the object? Only for LOAD_OR_INSERT, UPDATE and UPSERT.","items":{"type":"string","description":"Which fields identify the object? Only for LOAD_OR_INSERT, UPDATE and UPSERT."}},"policy":{"type":"string","description":"How should sub-objects be handled?","enum":["LOAD","INSERT","INSERT_FACTORY","UPSERT","UPDATE","LOAD_OR_INSERT","LOAD_OR_IGNORE"]},"nullValueHandlingStrategy":{"type":"string","description":"How should a null value be handled?","enum":["IGNORE","OVERRIDE"]},"ignoreRules":{"type":"array","description":"Conditions under which the object to import should be ignored.","items":{"$ref":"#/components/schemas/common-data_import-IgnoreRule"}}},"required":["path"]},"common-data_import-IgnoreRule":{"description":"Conditions under which the object to import should be ignored.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"comparisonType":{"type":"string","description":"Comparison operator.","enum":["IS_NULL","IS_NOT_NULL","EQUALS","NOT_EQUALS","STARTS_WITH","ENDS_WITH","CONTAINS","NOT_CONTAINS","GREATER_THAN","GREATER_THAN_EQUALS","LESS_THAN","LESS_THAN_EQUALS"]},"matchingType":{"type":"string","description":"Does a single match already fail or must all values match?","enum":["ANY_MATCH","ALL_MATCH"]},"comparisonValue":{"type":"string","description":"Value that leads to exclusion."},"fieldToCompare":{"type":"string","description":"Which field's value is compared?"}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"common-data_import-ImportMappingRuleSetParameter":{"description":"Import rule set parameter.","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Parameter name.","maxLength":255,"minLength":0},"requiredValueType":{"type":"string","description":"Parameter type, if it was predefined e.g. by a script module.","maxLength":255,"minLength":0,"readOnly":true},"fixedValue":{"type":"string","description":"Fixed value (only in combination with fixedValueType).","maxLength":255,"minLength":0},"fixedValueType":{"type":"string","description":"Fixed value data type (only in combination with fixedValue).","maxLength":255,"minLength":0},"queryPresetRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"variableMapping":{"type":"object","additionalProperties":{"type":"string","description":"Mapping from a query variable (key) to attribute paths in the import data (value)."},"description":"Mapping from a query variable (key) to attribute paths in the import data (value)."},"attributePath":{"type":"string","description":"Path to an attribute within the query from queryPresetRef."}},"required":["name"]},"common-data_import-ExportSetting":{"description":"When a file export module was selected: the export settings.","properties":{"fileName":{"type":"string","description":"File name without the file extension.","minLength":1},"charset":{"type":"string","default":"UTF_8_BOM","description":"Character set.","enum":["UTF_8","UTF_8_BOM","ASCII","LATIN_1"]},"csvSetting":{"$ref":"#/components/schemas/common-data_import-CsvExportSetting"},"jsonSetting":{"$ref":"#/components/schemas/common-data_import-JsonExportSetting"},"xmlSetting":{"$ref":"#/components/schemas/common-data_import-XmlExportSetting"}},"required":["charset","fileName"]},"common-data_import-CsvExportSetting":{"description":"Settings for the CSV export.","properties":{"targetFieldDefinitions":{"type":"array","description":"Column definitions (in the correct order).","items":{"type":"string","description":"Column definitions (in the correct order)."},"minItems":1},"columnSeparator":{"type":"string","default":";","description":"Column separator.","maxLength":1,"minLength":1},"quotingChar":{"type":"string","default":"\"","description":"Quoting character.","maxLength":1,"minLength":1},"writeHeaderLine":{"type":"boolean","default":true,"description":"Write a header row?"},"linebreakType":{"type":"string","default":"CR_LF","description":"Line break type.","enum":["CR_LF","CR","LF"]}},"required":["columnSeparator","linebreakType","quotingChar","targetFieldDefinitions"]},"common-data_import-JsonExportSetting":{"description":"Settings for the JSON export.","properties":{"rootFieldDefinitions":{"type":"array","description":"JSON field definitions.","items":{"$ref":"#/components/schemas/common-data_import-JsonExportSetting.FieldDefinition"},"minItems":1},"prettyPrint":{"type":"boolean","default":false,"description":"Should the JSON be pretty printed (uses more memory)?"},"linebreakType":{"type":"string","default":"CR_LF","description":"Line break type.","enum":["CR_LF","CR","LF"]}},"required":["rootFieldDefinitions"]},"common-data_import-JsonExportSetting.FieldDefinition":{"description":"JSON field definitions.","properties":{"name":{"type":"string","description":"Field name.","minLength":1},"type":{"type":"string","description":"Field data type.","enum":["TEXT","NUMBER","BOOLEAN","DATE","DATE_TIME","OBJECT"]},"children":{"type":"array","description":"For objects: the fields within the object.","items":{"$ref":"#/components/schemas/common-data_import-JsonExportSetting.FieldDefinition"}},"array":{"type":"boolean","default":false,"description":"Is the field an array?"}},"required":["name","type"]},"common-data_import-XmlExportSetting":{"description":"Settings for the XML export.","properties":{"rootTagName":{"type":"string","description":"XML root element."},"entryRootDefinition":{"$ref":"#/components/schemas/common-data_import-XmlExportSetting.FieldDefinition"},"prettyPrint":{"type":"boolean","default":false,"description":"Should the XML be pretty printed (uses more memory)?"},"writeXmlDeclaration":{"type":"boolean","default":true,"description":"Insert the XML declaration at the beginning of the file."}},"required":["entryRootDefinition","rootTagName"]},"common-data_import-XmlExportSetting.FieldDefinition":{"description":"Individual record structure.","properties":{"name":{"type":"string","description":"XML tag name.","minLength":1},"attributes":{"type":"array","description":"Attributes within the tag.","items":{"type":"string","description":"Attributes within the tag."}},"childTags":{"type":"array","description":"Optional: tags within this tag.","items":{"$ref":"#/components/schemas/common-data_import-XmlExportSetting.FieldDefinition"}}},"required":["name"]}}}}
```

## GET /cmn/data-import/rule-sets/module/{moduleKey}/target-fields

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"ImportRuleSet","description":"Import rule sets."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/data-import/rule-sets/module/{moduleKey}/target-fields":{"get":{"tags":["ImportRuleSet"],"operationId":"getAccessibleFields_1","parameters":[{"name":"moduleKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/common-data_import-BatchProcessingTargetFieldApi"}}}}}}}}},"components":{"schemas":{"common-data_import-BatchProcessingTargetFieldApi":{"properties":{"path":{"type":"string","description":"Path relevant for the mapping."},"displayName":{"type":"string","description":"Field display name."},"dataType":{"$ref":"#/components/schemas/core-cunit-CuAttributeDataType"},"constraint":{"$ref":"#/components/schemas/core-cunit-CuAttributeConstraint"},"modelType":{"type":"string","description":"Is this a dynamic or a static field?","enum":["STATIC","DYNAMIC"]}}},"core-cunit-CuAttributeDataType":{"description":"Attribute data type (when dataTypeIdentifier is empty).","properties":{"identifier":{"type":"string","description":"Datentyp-identifier","readOnly":true},"jsType":{"type":"string","description":"Which type it is.","readOnly":true},"objectRefIdentifier":{"type":"string","description":"For Object_Ref: which type exactly it is.","readOnly":true},"filterOptions":{"$ref":"#/components/schemas/core-cunit-CuAttributeFilterOptions"},"functions":{"type":"array","description":"Which functions are allowed?","items":{"type":"string","description":"Which functions are allowed?"},"readOnly":true},"predicateOperations":{"type":"array","description":"Which operations are allowed?","items":{"type":"string","description":"Which operations are allowed?","enum":["AND","OR","EQUALS","NOT_EQUALS","LIKE","NOT_LIKE","STARTS_WITH","ENDS_WITH","CONTAINS","NOT_CONTAINS","GREATER_THAN","GREATER_THAN_EQUALS","LESS_THAN","LESS_THAN_EQUALS","IN","NOT_IN","RANGE","NOT_RANGE","IS_NULL","IS_NOT_NULL","IS_NULL_OR_EQUALS","EXISTS","NOT_EXISTS"]},"readOnly":true}}},"core-cunit-CuAttributeFilterOptions":{"description":"CUnit attribute filter options.","properties":{"filterValues":{"type":"array","description":"Possible filter values.","items":{"type":"string","description":"Possible filter values."}},"filterDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"multipleChoice":{"type":"boolean","default":false,"description":"Is a multiple selection allowed?"}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}},"core-cunit-CuAttributeConstraint":{"description":"Attribute constraints.","properties":{"minLength":{"type":"integer","format":"int32","description":"Minimum length (of strings or arrays).","readOnly":true},"maxLength":{"type":"integer","format":"int32","description":"Maximum length (of strings or arrays).","readOnly":true},"minValue":{"type":"integer","format":"int64","description":"Minimum value.","readOnly":true},"includeMinValue":{"type":"boolean","description":"Is the minimum value inclusive?","readOnly":true},"maxValue":{"type":"integer","format":"int64","description":"Maximum value.","readOnly":true},"includeMaxValue":{"type":"boolean","description":"Is the maximum value inclusive?","readOnly":true},"notNull":{"type":"boolean","default":false,"description":"Is the value 'null' forbidden?","readOnly":true},"notBlank":{"type":"boolean","description":"For strings: is a string consisting only of whitespace forbidden?","readOnly":true},"digitsFraction":{"type":"integer","format":"int32","description":"Maximum number of decimal places.","readOnly":true}}}}}}
```

## GET /cmn/data-import/rule-sets/importable-types

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"ImportRuleSet","description":"Import rule sets."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/data-import/rule-sets/importable-types":{"get":{"tags":["ImportRuleSet"],"operationId":"getImportableTypes","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/common-data_import-ImportModuleInformation"}}}}}}}}},"components":{"schemas":{"common-data_import-ImportModuleInformation":{"properties":{"startEntityIdentifier":{"type":"string","description":"Main import entity."},"key":{"type":"string","description":"Unique import type key."},"subgraphs":{"type":"array","description":"Sub-objects a resolving strategy can be defined for.","items":{"$ref":"#/components/schemas/common-data_import-ResolvingStrategyInformation"}},"supportsValidation":{"type":"boolean","description":"Is the validation step supported?"},"type":{"type":"string","enum":["ENTITY_IMPORT","FILE_EXPORT"]}}},"common-data_import-ResolvingStrategyInformation":{"description":"Sub-objects a resolving strategy can be defined for.","properties":{"path":{"type":"string","description":"Path to the object."},"allowedStrategies":{"type":"array","description":"Allowed strategies for creating the object.","items":{"type":"string","description":"Allowed strategies for creating the object.","enum":["LOAD","INSERT","INSERT_FACTORY","UPSERT","UPDATE","LOAD_OR_INSERT","LOAD_OR_IGNORE"]}}}}}}}
```

## GET /cmn/data-import/rule-sets/importable-types/{key}

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"ImportRuleSet","description":"Import rule sets."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/data-import/rule-sets/importable-types/{key}":{"get":{"tags":["ImportRuleSet"],"operationId":"getImportableType","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-data_import-ImportModuleInformation"}}}}}}}},"components":{"schemas":{"common-data_import-ImportModuleInformation":{"properties":{"startEntityIdentifier":{"type":"string","description":"Main import entity."},"key":{"type":"string","description":"Unique import type key."},"subgraphs":{"type":"array","description":"Sub-objects a resolving strategy can be defined for.","items":{"$ref":"#/components/schemas/common-data_import-ResolvingStrategyInformation"}},"supportsValidation":{"type":"boolean","description":"Is the validation step supported?"},"type":{"type":"string","enum":["ENTITY_IMPORT","FILE_EXPORT"]}}},"common-data_import-ResolvingStrategyInformation":{"description":"Sub-objects a resolving strategy can be defined for.","properties":{"path":{"type":"string","description":"Path to the object."},"allowedStrategies":{"type":"array","description":"Allowed strategies for creating the object.","items":{"type":"string","description":"Allowed strategies for creating the object.","enum":["LOAD","INSERT","INSERT_FACTORY","UPSERT","UPDATE","LOAD_OR_INSERT","LOAD_OR_IGNORE"]}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developer.vario-software.de/api-reference/import-rule-set.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
