ImportRuleSet

Import-Regelwerke

Find an existing Resource by identifier

get

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

*/*

404

Resource with given ID was not found

*/*

get

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

HTTPcURLJavaScriptPython

GET /api/cmn/data-import/rule-sets/{id} HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T17:24:38.922Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T17:24:38.922Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "mode": "SCRIPT",
  "label": "text",
  "jsonRoot": "text",
  "rules": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:24:38.922Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:24:38.922Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "transformation": {
        "type": "DIRECT",
        "children": [
          {
            "type": "DIRECT",
            "children": "[Circular Reference]",
            "columnName": "text",
            "fixedValue": "text",
            "replacements": [
              {
                "from": "text",
                "to": "text"
              }
            ],
            "matchWholeFieldsOnly": true,
            "regexSearch": "text",
            "regexReplacement": "text",
            "caseSensitive": true,
            "useDefaultValueForReplacement": false,
            "defaultValue": "text",
            "index": 1,
            "target": "text",
            "formatDirective": {
              "formatType": "NUMERIC",
              "patternString": "text",
              "groupingSign": "text",
              "decimalSign": "text",
              "representationForTrue": "text",
              "representationForFalse": "text"
            },
            "moduleSpecificTransformationKey": "text",
            "suppressFailures": true,
            "auxiliaryTransformation": false,
            "dataType": "text"
          }
        ],
        "columnName": "text",
        "fixedValue": "text",
        "replacements": [
          {
            "from": "text",
            "to": "text"
          }
        ],
        "matchWholeFieldsOnly": true,
        "regexSearch": "text",
        "regexReplacement": "text",
        "caseSensitive": true,
        "useDefaultValueForReplacement": false,
        "defaultValue": "text",
        "index": 1,
        "target": "text",
        "formatDirective": {
          "formatType": "NUMERIC",
          "patternString": "text",
          "groupingSign": "text",
          "decimalSign": "text",
          "representationForTrue": "text",
          "representationForFalse": "text"
        },
        "moduleSpecificTransformationKey": "text",
        "suppressFailures": true,
        "auxiliaryTransformation": false,
        "dataType": "text"
      }
    }
  ],
  "importModuleKey": "text",
  "dataFrom": 1,
  "dataTo": 1,
  "headerIndex": 1,
  "columnSeparator": "text",
  "charSet": "UTF_8",
  "quotingChar": "text",
  "targetFieldRules": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:24:38.922Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:24:38.922Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "path": "text",
      "lookupFields": [
        "text"
      ],
      "policy": "LOAD",
      "nullValueHandlingStrategy": "IGNORE",
      "ignoreRules": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T17:24:38.922Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T17:24:38.922Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "comparisonType": "IS_NULL",
          "matchingType": "ANY_MATCH",
          "comparisonValue": "text",
          "fieldToCompare": "text"
        }
      ]
    }
  ],
  "createRulesForEavGroup": "text",
  "defaultDateFormatDirective": {
    "formatType": "NUMERIC",
    "patternString": "text",
    "groupingSign": "text",
    "decimalSign": "text",
    "representationForTrue": "text",
    "representationForFalse": "text"
  },
  "defaultDateTimeFormatDirective": {
    "formatType": "NUMERIC",
    "patternString": "text",
    "groupingSign": "text",
    "decimalSign": "text",
    "representationForTrue": "text",
    "representationForFalse": "text"
  },
  "defaultNumberFormatDirective": {
    "formatType": "NUMERIC",
    "patternString": "text",
    "groupingSign": "text",
    "decimalSign": "text",
    "representationForTrue": "text",
    "representationForFalse": "text"
  },
  "defaultBooleanFormatDirective": {
    "formatType": "NUMERIC",
    "patternString": "text",
    "groupingSign": "text",
    "decimalSign": "text",
    "representationForTrue": "text",
    "representationForFalse": "text"
  },
  "script": "text",
  "scriptModuleRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "parameters": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:24:38.922Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:24:38.922Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "name": "text",
      "requiredValueType": "text",
      "fixedValue": "text",
      "fixedValueType": "text",
      "queryPresetRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "variableMapping": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "attributePath": "text"
    }
  ],
  "advancedUi": false,
  "ignoreEmptyData": false,
  "exportSetting": {
    "fileName": "text",
    "charset": "UTF_8_BOM",
    "csvSetting": {
      "targetFieldDefinitions": [
        "text"
      ],
      "columnSeparator": ";",
      "quotingChar": "\"",
      "writeHeaderLine": true,
      "linebreakType": "CR_LF"
    }
  },
  "suppressWebhooks": false,
  "suppressWorkflows": false
}

Update existing Resource

put

Path parameters

idinteger · int64Required

an identifier

Body

application/json

Regelsatz für den Import-Vorgang

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

modestring · enumRequired

Modus

Possible values:

labelstringOptional

Eindeutiges Label

jsonRootstringOptional

Bei JSON-Import: Ab welchem Pfad beginnen die Import-Daten?

importModuleKeystringOptional

Für welchen Import gilt dieser Regelsatz

dataFrominteger · int64Optional

Index des ersten Datensatzes (1-basiert) - alle vorherigen werden ignoriert

dataTointeger · int64Optional

Index des letzten Datensatzes (1-basiert) - alle danach werden ignoriert

headerIndexinteger · int64Optional

Falls vorhanden: Index der Kopfzeile (1-basiert)

columnSeparatorstringOptional

Nur für CSV: Trennzeichen innerhalb einer Zeile

charSetstring · enumOptional

Für CSV & JSON: Verwendeter Zeichensatz

Possible values:

quotingCharstringOptional

Nur für CSV: Zeichen um ein Textfeld zu quoten (i.d.R. ' oder ")

createRulesForEavGroupstringOptional

Gibt an, dass für eine Eav-Gruppe bei der Ausführung Regeln erzeugt werden sollen.

scriptstringOptional

Falls Mode == SCRIPT: auszuführendes Skript. Nur Skript oder Skript-Modul darf gesetzt sein

advancedUibooleanOptional

Erweiterte Darstellung im UI verwenden?

Default: false

ignoreEmptyDatabooleanOptional

Bei JSON-Import: Leere Datenmenge ignorieren?

Default: false

suppressWebhooksbooleanOptional

Sollen Webhooks bei Ausführung deaktiviert werden?

Default: false

suppressWorkflowsbooleanOptional

Sollen Workflows bei Ausführung deaktiviert werden?

Default: false

Responses

200

successful operation

*/*

404

Resource was not found

*/*

422

Resource was not valid to process

*/*

put

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

HTTPcURLJavaScriptPython

PUT /api/cmn/data-import/rule-sets/{id} HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 3121

{
  "version": "text",
  "info": {},
  "id": "text",
  "mode": "SCRIPT",
  "label": "text",
  "jsonRoot": "text",
  "rules": [
    {
      "version": "text",
      "info": {},
      "id": "text",
      "transformation": {
        "type": "DIRECT",
        "children": [
          {
            "type": "DIRECT",
            "children": "[Circular Reference]",
            "columnName": "text",
            "fixedValue": "text",
            "replacements": [
              {
                "from": "text",
                "to": "text"
              }
            ],
            "matchWholeFieldsOnly": true,
            "regexSearch": "text",
            "regexReplacement": "text",
            "caseSensitive": true,
            "useDefaultValueForReplacement": false,
            "defaultValue": "text",
            "index": 1,
            "target": "text",
            "formatDirective": {
              "formatType": "NUMERIC",
              "patternString": "text",
              "groupingSign": "text",
              "decimalSign": "text",
              "representationForTrue": "text",
              "representationForFalse": "text"
            },
            "moduleSpecificTransformationKey": "text",
            "suppressFailures": true,
            "auxiliaryTransformation": false,
            "dataType": "text"
          }
        ],
        "columnName": "text",
        "fixedValue": "text",
        "replacements": [
          {
            "from": "text",
            "to": "text"
          }
        ],
        "matchWholeFieldsOnly": true,
        "regexSearch": "text",
        "regexReplacement": "text",
        "caseSensitive": true,
        "useDefaultValueForReplacement": false,
        "defaultValue": "text",
        "index": 1,
        "target": "text",
        "formatDirective": {
          "formatType": "NUMERIC",
          "patternString": "text",
          "groupingSign": "text",
          "decimalSign": "text",
          "representationForTrue": "text",
          "representationForFalse": "text"
        },
        "moduleSpecificTransformationKey": "text",
        "suppressFailures": true,
        "auxiliaryTransformation": false,
        "dataType": "text"
      }
    }
  ],
  "importModuleKey": "text",
  "dataFrom": 1,
  "dataTo": 1,
  "headerIndex": 1,
  "columnSeparator": "text",
  "charSet": "UTF_8",
  "quotingChar": "text",
  "targetFieldRules": [
    {
      "version": "text",
      "info": {},
      "id": "text",
      "path": "text",
      "lookupFields": [
        "text"
      ],
      "policy": "LOAD",
      "nullValueHandlingStrategy": "IGNORE",
      "ignoreRules": [
        {
          "version": "text",
          "info": {},
          "id": "text",
          "comparisonType": "IS_NULL",
          "matchingType": "ANY_MATCH",
          "comparisonValue": "text",
          "fieldToCompare": "text"
        }
      ]
    }
  ],
  "createRulesForEavGroup": "text",
  "defaultDateFormatDirective": {
    "formatType": "NUMERIC",
    "patternString": "text",
    "groupingSign": "text",
    "decimalSign": "text",
    "representationForTrue": "text",
    "representationForFalse": "text"
  },
  "defaultDateTimeFormatDirective": {
    "formatType": "NUMERIC",
    "patternString": "text",
    "groupingSign": "text",
    "decimalSign": "text",
    "representationForTrue": "text",
    "representationForFalse": "text"
  },
  "defaultNumberFormatDirective": {
    "formatType": "NUMERIC",
    "patternString": "text",
    "groupingSign": "text",
    "decimalSign": "text",
    "representationForTrue": "text",
    "representationForFalse": "text"
  },
  "defaultBooleanFormatDirective": {
    "formatType": "NUMERIC",
    "patternString": "text",
    "groupingSign": "text",
    "decimalSign": "text",
    "representationForTrue": "text",
    "representationForFalse": "text"
  },
  "script": "text",
  "scriptModuleRef": {
    "id": "text"
  },
  "parameters": [
    {
      "version": "text",
      "info": {},
      "id": "text",
      "name": "text",
      "fixedValue": "text",
      "fixedValueType": "text",
      "queryPresetRef": {
        "id": "text"
      },
      "variableMapping": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "attributePath": "text"
    }
  ],
  "advancedUi": false,
  "ignoreEmptyData": false,
  "exportSetting": {
    "fileName": "text",
    "charset": "UTF_8_BOM",
    "csvSetting": {
      "targetFieldDefinitions": [
        "text"
      ],
      "columnSeparator": ";",
      "quotingChar": "\"",
      "writeHeaderLine": true,
      "linebreakType": "CR_LF"
    }
  },
  "suppressWebhooks": false,
  "suppressWorkflows": false
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T17:24:38.922Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T17:24:38.922Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "mode": "SCRIPT",
  "label": "text",
  "jsonRoot": "text",
  "rules": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:24:38.922Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:24:38.922Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "transformation": {
        "type": "DIRECT",
        "children": [
          {
            "type": "DIRECT",
            "children": "[Circular Reference]",
            "columnName": "text",
            "fixedValue": "text",
            "replacements": [
              {
                "from": "text",
                "to": "text"
              }
            ],
            "matchWholeFieldsOnly": true,
            "regexSearch": "text",
            "regexReplacement": "text",
            "caseSensitive": true,
            "useDefaultValueForReplacement": false,
            "defaultValue": "text",
            "index": 1,
            "target": "text",
            "formatDirective": {
              "formatType": "NUMERIC",
              "patternString": "text",
              "groupingSign": "text",
              "decimalSign": "text",
              "representationForTrue": "text",
              "representationForFalse": "text"
            },
            "moduleSpecificTransformationKey": "text",
            "suppressFailures": true,
            "auxiliaryTransformation": false,
            "dataType": "text"
          }
        ],
        "columnName": "text",
        "fixedValue": "text",
        "replacements": [
          {
            "from": "text",
            "to": "text"
          }
        ],
        "matchWholeFieldsOnly": true,
        "regexSearch": "text",
        "regexReplacement": "text",
        "caseSensitive": true,
        "useDefaultValueForReplacement": false,
        "defaultValue": "text",
        "index": 1,
        "target": "text",
        "formatDirective": {
          "formatType": "NUMERIC",
          "patternString": "text",
          "groupingSign": "text",
          "decimalSign": "text",
          "representationForTrue": "text",
          "representationForFalse": "text"
        },
        "moduleSpecificTransformationKey": "text",
        "suppressFailures": true,
        "auxiliaryTransformation": false,
        "dataType": "text"
      }
    }
  ],
  "importModuleKey": "text",
  "dataFrom": 1,
  "dataTo": 1,
  "headerIndex": 1,
  "columnSeparator": "text",
  "charSet": "UTF_8",
  "quotingChar": "text",
  "targetFieldRules": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:24:38.922Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:24:38.922Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "path": "text",
      "lookupFields": [
        "text"
      ],
      "policy": "LOAD",
      "nullValueHandlingStrategy": "IGNORE",
      "ignoreRules": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T17:24:38.922Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T17:24:38.922Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "comparisonType": "IS_NULL",
          "matchingType": "ANY_MATCH",
          "comparisonValue": "text",
          "fieldToCompare": "text"
        }
      ]
    }
  ],
  "createRulesForEavGroup": "text",
  "defaultDateFormatDirective": {
    "formatType": "NUMERIC",
    "patternString": "text",
    "groupingSign": "text",
    "decimalSign": "text",
    "representationForTrue": "text",
    "representationForFalse": "text"
  },
  "defaultDateTimeFormatDirective": {
    "formatType": "NUMERIC",
    "patternString": "text",
    "groupingSign": "text",
    "decimalSign": "text",
    "representationForTrue": "text",
    "representationForFalse": "text"
  },
  "defaultNumberFormatDirective": {
    "formatType": "NUMERIC",
    "patternString": "text",
    "groupingSign": "text",
    "decimalSign": "text",
    "representationForTrue": "text",
    "representationForFalse": "text"
  },
  "defaultBooleanFormatDirective": {
    "formatType": "NUMERIC",
    "patternString": "text",
    "groupingSign": "text",
    "decimalSign": "text",
    "representationForTrue": "text",
    "representationForFalse": "text"
  },
  "script": "text",
  "scriptModuleRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "parameters": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:24:38.922Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:24:38.922Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "name": "text",
      "requiredValueType": "text",
      "fixedValue": "text",
      "fixedValueType": "text",
      "queryPresetRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "variableMapping": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "attributePath": "text"
    }
  ],
  "advancedUi": false,
  "ignoreEmptyData": false,
  "exportSetting": {
    "fileName": "text",
    "charset": "UTF_8_BOM",
    "csvSetting": {
      "targetFieldDefinitions": [
        "text"
      ],
      "columnSeparator": ";",
      "quotingChar": "\"",
      "writeHeaderLine": true,
      "linebreakType": "CR_LF"
    }
  },
  "suppressWebhooks": false,
  "suppressWorkflows": false
}

Delete an existing Resource

delete

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

*/*

404

Resource was not found

*/*

409

unable to delete Resource, due to constraints, existing references or internal state

*/*

delete

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

HTTPcURLJavaScriptPython

DELETE /api/cmn/data-import/rule-sets/{id} HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "context": "text",
  "messageValue": "text"
}

Create new Resource

post

Body

application/json

Regelsatz für den Import-Vorgang

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

modestring · enumRequired

Modus

Possible values:

labelstringOptional

Eindeutiges Label

jsonRootstringOptional

Bei JSON-Import: Ab welchem Pfad beginnen die Import-Daten?

importModuleKeystringOptional

Für welchen Import gilt dieser Regelsatz

dataFrominteger · int64Optional

Index des ersten Datensatzes (1-basiert) - alle vorherigen werden ignoriert

dataTointeger · int64Optional

Index des letzten Datensatzes (1-basiert) - alle danach werden ignoriert

headerIndexinteger · int64Optional

Falls vorhanden: Index der Kopfzeile (1-basiert)

columnSeparatorstringOptional

Nur für CSV: Trennzeichen innerhalb einer Zeile

charSetstring · enumOptional

Für CSV & JSON: Verwendeter Zeichensatz

Possible values:

quotingCharstringOptional

Nur für CSV: Zeichen um ein Textfeld zu quoten (i.d.R. ' oder ")

createRulesForEavGroupstringOptional

Gibt an, dass für eine Eav-Gruppe bei der Ausführung Regeln erzeugt werden sollen.

scriptstringOptional

Falls Mode == SCRIPT: auszuführendes Skript. Nur Skript oder Skript-Modul darf gesetzt sein

advancedUibooleanOptional

Erweiterte Darstellung im UI verwenden?

Default: false

ignoreEmptyDatabooleanOptional

Bei JSON-Import: Leere Datenmenge ignorieren?

Default: false

suppressWebhooksbooleanOptional

Sollen Webhooks bei Ausführung deaktiviert werden?

Default: false

suppressWorkflowsbooleanOptional

Sollen Workflows bei Ausführung deaktiviert werden?

Default: false

Responses

200

successful operation

*/*

422

Resource was not valid to process

*/*

post

/cmn/data-import/rule-sets

HTTPcURLJavaScriptPython

POST /api/cmn/data-import/rule-sets HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 3121

{
  "version": "text",
  "info": {},
  "id": "text",
  "mode": "SCRIPT",
  "label": "text",
  "jsonRoot": "text",
  "rules": [
    {
      "version": "text",
      "info": {},
      "id": "text",
      "transformation": {
        "type": "DIRECT",
        "children": [
          {
            "type": "DIRECT",
            "children": "[Circular Reference]",
            "columnName": "text",
            "fixedValue": "text",
            "replacements": [
              {
                "from": "text",
                "to": "text"
              }
            ],
            "matchWholeFieldsOnly": true,
            "regexSearch": "text",
            "regexReplacement": "text",
            "caseSensitive": true,
            "useDefaultValueForReplacement": false,
            "defaultValue": "text",
            "index": 1,
            "target": "text",
            "formatDirective": {
              "formatType": "NUMERIC",
              "patternString": "text",
              "groupingSign": "text",
              "decimalSign": "text",
              "representationForTrue": "text",
              "representationForFalse": "text"
            },
            "moduleSpecificTransformationKey": "text",
            "suppressFailures": true,
            "auxiliaryTransformation": false,
            "dataType": "text"
          }
        ],
        "columnName": "text",
        "fixedValue": "text",
        "replacements": [
          {
            "from": "text",
            "to": "text"
          }
        ],
        "matchWholeFieldsOnly": true,
        "regexSearch": "text",
        "regexReplacement": "text",
        "caseSensitive": true,
        "useDefaultValueForReplacement": false,
        "defaultValue": "text",
        "index": 1,
        "target": "text",
        "formatDirective": {
          "formatType": "NUMERIC",
          "patternString": "text",
          "groupingSign": "text",
          "decimalSign": "text",
          "representationForTrue": "text",
          "representationForFalse": "text"
        },
        "moduleSpecificTransformationKey": "text",
        "suppressFailures": true,
        "auxiliaryTransformation": false,
        "dataType": "text"
      }
    }
  ],
  "importModuleKey": "text",
  "dataFrom": 1,
  "dataTo": 1,
  "headerIndex": 1,
  "columnSeparator": "text",
  "charSet": "UTF_8",
  "quotingChar": "text",
  "targetFieldRules": [
    {
      "version": "text",
      "info": {},
      "id": "text",
      "path": "text",
      "lookupFields": [
        "text"
      ],
      "policy": "LOAD",
      "nullValueHandlingStrategy": "IGNORE",
      "ignoreRules": [
        {
          "version": "text",
          "info": {},
          "id": "text",
          "comparisonType": "IS_NULL",
          "matchingType": "ANY_MATCH",
          "comparisonValue": "text",
          "fieldToCompare": "text"
        }
      ]
    }
  ],
  "createRulesForEavGroup": "text",
  "defaultDateFormatDirective": {
    "formatType": "NUMERIC",
    "patternString": "text",
    "groupingSign": "text",
    "decimalSign": "text",
    "representationForTrue": "text",
    "representationForFalse": "text"
  },
  "defaultDateTimeFormatDirective": {
    "formatType": "NUMERIC",
    "patternString": "text",
    "groupingSign": "text",
    "decimalSign": "text",
    "representationForTrue": "text",
    "representationForFalse": "text"
  },
  "defaultNumberFormatDirective": {
    "formatType": "NUMERIC",
    "patternString": "text",
    "groupingSign": "text",
    "decimalSign": "text",
    "representationForTrue": "text",
    "representationForFalse": "text"
  },
  "defaultBooleanFormatDirective": {
    "formatType": "NUMERIC",
    "patternString": "text",
    "groupingSign": "text",
    "decimalSign": "text",
    "representationForTrue": "text",
    "representationForFalse": "text"
  },
  "script": "text",
  "scriptModuleRef": {
    "id": "text"
  },
  "parameters": [
    {
      "version": "text",
      "info": {},
      "id": "text",
      "name": "text",
      "fixedValue": "text",
      "fixedValueType": "text",
      "queryPresetRef": {
        "id": "text"
      },
      "variableMapping": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "attributePath": "text"
    }
  ],
  "advancedUi": false,
  "ignoreEmptyData": false,
  "exportSetting": {
    "fileName": "text",
    "charset": "UTF_8_BOM",
    "csvSetting": {
      "targetFieldDefinitions": [
        "text"
      ],
      "columnSeparator": ";",
      "quotingChar": "\"",
      "writeHeaderLine": true,
      "linebreakType": "CR_LF"
    }
  },
  "suppressWebhooks": false,
  "suppressWorkflows": false
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T17:24:38.922Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T17:24:38.922Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "mode": "SCRIPT",
  "label": "text",
  "jsonRoot": "text",
  "rules": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:24:38.922Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:24:38.922Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "transformation": {
        "type": "DIRECT",
        "children": [
          {
            "type": "DIRECT",
            "children": "[Circular Reference]",
            "columnName": "text",
            "fixedValue": "text",
            "replacements": [
              {
                "from": "text",
                "to": "text"
              }
            ],
            "matchWholeFieldsOnly": true,
            "regexSearch": "text",
            "regexReplacement": "text",
            "caseSensitive": true,
            "useDefaultValueForReplacement": false,
            "defaultValue": "text",
            "index": 1,
            "target": "text",
            "formatDirective": {
              "formatType": "NUMERIC",
              "patternString": "text",
              "groupingSign": "text",
              "decimalSign": "text",
              "representationForTrue": "text",
              "representationForFalse": "text"
            },
            "moduleSpecificTransformationKey": "text",
            "suppressFailures": true,
            "auxiliaryTransformation": false,
            "dataType": "text"
          }
        ],
        "columnName": "text",
        "fixedValue": "text",
        "replacements": [
          {
            "from": "text",
            "to": "text"
          }
        ],
        "matchWholeFieldsOnly": true,
        "regexSearch": "text",
        "regexReplacement": "text",
        "caseSensitive": true,
        "useDefaultValueForReplacement": false,
        "defaultValue": "text",
        "index": 1,
        "target": "text",
        "formatDirective": {
          "formatType": "NUMERIC",
          "patternString": "text",
          "groupingSign": "text",
          "decimalSign": "text",
          "representationForTrue": "text",
          "representationForFalse": "text"
        },
        "moduleSpecificTransformationKey": "text",
        "suppressFailures": true,
        "auxiliaryTransformation": false,
        "dataType": "text"
      }
    }
  ],
  "importModuleKey": "text",
  "dataFrom": 1,
  "dataTo": 1,
  "headerIndex": 1,
  "columnSeparator": "text",
  "charSet": "UTF_8",
  "quotingChar": "text",
  "targetFieldRules": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:24:38.922Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:24:38.922Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "path": "text",
      "lookupFields": [
        "text"
      ],
      "policy": "LOAD",
      "nullValueHandlingStrategy": "IGNORE",
      "ignoreRules": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T17:24:38.922Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T17:24:38.922Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "comparisonType": "IS_NULL",
          "matchingType": "ANY_MATCH",
          "comparisonValue": "text",
          "fieldToCompare": "text"
        }
      ]
    }
  ],
  "createRulesForEavGroup": "text",
  "defaultDateFormatDirective": {
    "formatType": "NUMERIC",
    "patternString": "text",
    "groupingSign": "text",
    "decimalSign": "text",
    "representationForTrue": "text",
    "representationForFalse": "text"
  },
  "defaultDateTimeFormatDirective": {
    "formatType": "NUMERIC",
    "patternString": "text",
    "groupingSign": "text",
    "decimalSign": "text",
    "representationForTrue": "text",
    "representationForFalse": "text"
  },
  "defaultNumberFormatDirective": {
    "formatType": "NUMERIC",
    "patternString": "text",
    "groupingSign": "text",
    "decimalSign": "text",
    "representationForTrue": "text",
    "representationForFalse": "text"
  },
  "defaultBooleanFormatDirective": {
    "formatType": "NUMERIC",
    "patternString": "text",
    "groupingSign": "text",
    "decimalSign": "text",
    "representationForTrue": "text",
    "representationForFalse": "text"
  },
  "script": "text",
  "scriptModuleRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "parameters": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:24:38.922Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:24:38.922Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "name": "text",
      "requiredValueType": "text",
      "fixedValue": "text",
      "fixedValueType": "text",
      "queryPresetRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "variableMapping": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "attributePath": "text"
    }
  ],
  "advancedUi": false,
  "ignoreEmptyData": false,
  "exportSetting": {
    "fileName": "text",
    "charset": "UTF_8_BOM",
    "csvSetting": {
      "targetFieldDefinitions": [
        "text"
      ],
      "columnSeparator": ";",
      "quotingChar": "\"",
      "writeHeaderLine": true,
      "linebreakType": "CR_LF"
    }
  },
  "suppressWebhooks": false,
  "suppressWorkflows": false
}

get

Path parameters

idinteger · int64Required

Responses

200

OK

*/*

get

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

HTTPcURLJavaScriptPython

GET /api/cmn/data-import/rule-sets/{id}/target-fields HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

[
  {
    "path": "text",
    "displayName": "text",
    "dataType": {
      "identifier": "text",
      "jsType": "text",
      "objectRefIdentifier": "text",
      "filterOptions": {
        "filterValues": [
          "text"
        ],
        "filterDialog": {},
        "multipleChoice": false
      },
      "functions": [
        "text"
      ],
      "predicateOperations": [
        "AND"
      ]
    },
    "constraint": {
      "minLength": 1,
      "maxLength": 1,
      "minValue": 1,
      "includeMinValue": true,
      "maxValue": 1,
      "includeMaxValue": true,
      "notNull": false,
      "notBlank": true
    },
    "modelType": "STATIC"
  }
]

get

Path parameters

idinteger · int64Required

Responses

200

OK

*/*

get

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

HTTPcURLJavaScriptPython

GET /api/cmn/data-import/rule-sets/{id}/copy HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T17:24:38.922Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T17:24:38.922Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "mode": "SCRIPT",
  "label": "text",
  "jsonRoot": "text",
  "rules": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:24:38.922Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:24:38.922Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "transformation": {
        "type": "DIRECT",
        "children": [
          {
            "type": "DIRECT",
            "children": "[Circular Reference]",
            "columnName": "text",
            "fixedValue": "text",
            "replacements": [
              {
                "from": "text",
                "to": "text"
              }
            ],
            "matchWholeFieldsOnly": true,
            "regexSearch": "text",
            "regexReplacement": "text",
            "caseSensitive": true,
            "useDefaultValueForReplacement": false,
            "defaultValue": "text",
            "index": 1,
            "target": "text",
            "formatDirective": {
              "formatType": "NUMERIC",
              "patternString": "text",
              "groupingSign": "text",
              "decimalSign": "text",
              "representationForTrue": "text",
              "representationForFalse": "text"
            },
            "moduleSpecificTransformationKey": "text",
            "suppressFailures": true,
            "auxiliaryTransformation": false,
            "dataType": "text"
          }
        ],
        "columnName": "text",
        "fixedValue": "text",
        "replacements": [
          {
            "from": "text",
            "to": "text"
          }
        ],
        "matchWholeFieldsOnly": true,
        "regexSearch": "text",
        "regexReplacement": "text",
        "caseSensitive": true,
        "useDefaultValueForReplacement": false,
        "defaultValue": "text",
        "index": 1,
        "target": "text",
        "formatDirective": {
          "formatType": "NUMERIC",
          "patternString": "text",
          "groupingSign": "text",
          "decimalSign": "text",
          "representationForTrue": "text",
          "representationForFalse": "text"
        },
        "moduleSpecificTransformationKey": "text",
        "suppressFailures": true,
        "auxiliaryTransformation": false,
        "dataType": "text"
      }
    }
  ],
  "importModuleKey": "text",
  "dataFrom": 1,
  "dataTo": 1,
  "headerIndex": 1,
  "columnSeparator": "text",
  "charSet": "UTF_8",
  "quotingChar": "text",
  "targetFieldRules": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:24:38.922Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:24:38.922Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "path": "text",
      "lookupFields": [
        "text"
      ],
      "policy": "LOAD",
      "nullValueHandlingStrategy": "IGNORE",
      "ignoreRules": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T17:24:38.922Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T17:24:38.922Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "comparisonType": "IS_NULL",
          "matchingType": "ANY_MATCH",
          "comparisonValue": "text",
          "fieldToCompare": "text"
        }
      ]
    }
  ],
  "createRulesForEavGroup": "text",
  "defaultDateFormatDirective": {
    "formatType": "NUMERIC",
    "patternString": "text",
    "groupingSign": "text",
    "decimalSign": "text",
    "representationForTrue": "text",
    "representationForFalse": "text"
  },
  "defaultDateTimeFormatDirective": {
    "formatType": "NUMERIC",
    "patternString": "text",
    "groupingSign": "text",
    "decimalSign": "text",
    "representationForTrue": "text",
    "representationForFalse": "text"
  },
  "defaultNumberFormatDirective": {
    "formatType": "NUMERIC",
    "patternString": "text",
    "groupingSign": "text",
    "decimalSign": "text",
    "representationForTrue": "text",
    "representationForFalse": "text"
  },
  "defaultBooleanFormatDirective": {
    "formatType": "NUMERIC",
    "patternString": "text",
    "groupingSign": "text",
    "decimalSign": "text",
    "representationForTrue": "text",
    "representationForFalse": "text"
  },
  "script": "text",
  "scriptModuleRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "parameters": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:24:38.922Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:24:38.922Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "name": "text",
      "requiredValueType": "text",
      "fixedValue": "text",
      "fixedValueType": "text",
      "queryPresetRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "variableMapping": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "attributePath": "text"
    }
  ],
  "advancedUi": false,
  "ignoreEmptyData": false,
  "exportSetting": {
    "fileName": "text",
    "charset": "UTF_8_BOM",
    "csvSetting": {
      "targetFieldDefinitions": [
        "text"
      ],
      "columnSeparator": ";",
      "quotingChar": "\"",
      "writeHeaderLine": true,
      "linebreakType": "CR_LF"
    }
  },
  "suppressWebhooks": false,
  "suppressWorkflows": false
}

get

Path parameters

moduleKeystringRequired

Responses

200

OK

*/*

get

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

HTTPcURLJavaScriptPython

GET /api/cmn/data-import/rule-sets/module/{moduleKey}/target-fields HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

[
  {
    "path": "text",
    "displayName": "text",
    "dataType": {
      "identifier": "text",
      "jsType": "text",
      "objectRefIdentifier": "text",
      "filterOptions": {
        "filterValues": [
          "text"
        ],
        "filterDialog": {},
        "multipleChoice": false
      },
      "functions": [
        "text"
      ],
      "predicateOperations": [
        "AND"
      ]
    },
    "constraint": {
      "minLength": 1,
      "maxLength": 1,
      "minValue": 1,
      "includeMinValue": true,
      "maxValue": 1,
      "includeMaxValue": true,
      "notNull": false,
      "notBlank": true
    },
    "modelType": "STATIC"
  }
]

get

Responses

200

OK

*/*

get

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

HTTPcURLJavaScriptPython

GET /api/cmn/data-import/rule-sets/importable-types HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

[
  {
    "startEntityIdentifier": "text",
    "key": "text",
    "subgraphs": [
      {
        "path": "text",
        "allowedStrategies": [
          "LOAD"
        ]
      }
    ],
    "supportsFileUpload": true,
    "supportsValidation": true,
    "type": "ENTITY_IMPORT"
  }
]