Import Rule Set

Import-Regelwerke

Find an existing Resource by identifier

get

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

*/*

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

rootstringOptional

Bei JSON- und XML-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

parallelExecutionAllowedbooleanOptional

Aufsplitten in mehrere parallel ausgeführte Tasks erlauben?

Default: true

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

createMissingHeadersFromRuleSetbooleanOptional

Nur JSON & XML: Fehlende Header automatisch aus den im RuleSet referenzierten Spalten erzeugen?

Default: false

404

Resource with given ID was not found

*/*

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

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

{
  "version": "text",
  "info": {
    "createdAt": "2026-07-21T01:38:59.432Z",
    "createdFrom": "text",
    "updatedAt": "2026-07-21T01:38:59.432Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "mode": "SCRIPT",
  "label": "text",
  "root": "text",
  "rules": [],
  "importModuleKey": "text",
  "dataFrom": 1,
  "dataTo": 1,
  "headerIndex": 1,
  "columnSeparator": "text",
  "charSet": "UTF_8",
  "quotingChar": "text",
  "targetFieldRules": [],
  "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": [],
  "parallelExecutionAllowed": true,
  "advancedUi": false,
  "ignoreEmptyData": false,
  "exportSetting": {
    "fileName": "text",
    "charset": "UTF_8_BOM",
    "csvSetting": {
      "targetFieldDefinitions": [
        "text"
      ],
      "columnSeparator": ";",
      "quotingChar": "\"",
      "writeHeaderLine": true,
      "linebreakType": "CR_LF"
    },
    "jsonSetting": {
      "rootFieldDefinitions": [],
      "prettyPrint": false,
      "linebreakType": "CR_LF"
    },
    "xmlSetting": {
      "rootTagName": "text",
      "entryRootDefinition": {
        "name": "text",
        "attributes": [
          "text"
        ],
        "childTags": []
      },
      "prettyPrint": false,
      "writeXmlDeclaration": true
    }
  },
  "suppressWebhooks": false,
  "suppressWorkflows": false,
  "createMissingHeadersFromRuleSet": false
}

Update existing Resource

put

Path parameters

idinteger · int64Required

an identifier

Body

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

rootstringOptional

Bei JSON- und XML-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

parallelExecutionAllowedbooleanOptional

Aufsplitten in mehrere parallel ausgeführte Tasks erlauben?

Default: true

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

createMissingHeadersFromRuleSetbooleanOptional

Nur JSON & XML: Fehlende Header automatisch aus den im RuleSet referenzierten Spalten erzeugen?

Default: false

Responses

200

successful operation

*/*

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

rootstringOptional

Bei JSON- und XML-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

parallelExecutionAllowedbooleanOptional

Aufsplitten in mehrere parallel ausgeführte Tasks erlauben?

Default: true

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

createMissingHeadersFromRuleSetbooleanOptional

Nur JSON & XML: Fehlende Header automatisch aus den im RuleSet referenzierten Spalten erzeugen?

Default: false

404

Resource was not found

*/*

422

Resource was not valid to process

*/*

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

PUT /api/cmn/data-import/rule-sets/{id} HTTP/1.1
Host: 10.102.24.218:32792
Content-Type: application/json
Accept: */*
Content-Length: 1689

{
  "version": "text",
  "info": {},
  "id": "text",
  "mode": "SCRIPT",
  "label": "text",
  "root": "text",
  "rules": [],
  "importModuleKey": "text",
  "dataFrom": 1,
  "dataTo": 1,
  "headerIndex": 1,
  "columnSeparator": "text",
  "charSet": "UTF_8",
  "quotingChar": "text",
  "targetFieldRules": [],
  "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": [],
  "parallelExecutionAllowed": true,
  "advancedUi": false,
  "ignoreEmptyData": false,
  "exportSetting": {
    "fileName": "text",
    "charset": "UTF_8_BOM",
    "csvSetting": {
      "targetFieldDefinitions": [
        "text"
      ],
      "columnSeparator": ";",
      "quotingChar": "\"",
      "writeHeaderLine": true,
      "linebreakType": "CR_LF"
    },
    "jsonSetting": {
      "rootFieldDefinitions": [],
      "prettyPrint": false,
      "linebreakType": "CR_LF"
    },
    "xmlSetting": {
      "rootTagName": "text",
      "entryRootDefinition": {
        "name": "text",
        "attributes": [
          "text"
        ],
        "childTags": []
      },
      "prettyPrint": false,
      "writeXmlDeclaration": true
    }
  },
  "suppressWebhooks": false,
  "suppressWorkflows": false,
  "createMissingHeadersFromRuleSet": false
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-07-21T01:38:59.432Z",
    "createdFrom": "text",
    "updatedAt": "2026-07-21T01:38:59.432Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "mode": "SCRIPT",
  "label": "text",
  "root": "text",
  "rules": [],
  "importModuleKey": "text",
  "dataFrom": 1,
  "dataTo": 1,
  "headerIndex": 1,
  "columnSeparator": "text",
  "charSet": "UTF_8",
  "quotingChar": "text",
  "targetFieldRules": [],
  "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": [],
  "parallelExecutionAllowed": true,
  "advancedUi": false,
  "ignoreEmptyData": false,
  "exportSetting": {
    "fileName": "text",
    "charset": "UTF_8_BOM",
    "csvSetting": {
      "targetFieldDefinitions": [
        "text"
      ],
      "columnSeparator": ";",
      "quotingChar": "\"",
      "writeHeaderLine": true,
      "linebreakType": "CR_LF"
    },
    "jsonSetting": {
      "rootFieldDefinitions": [],
      "prettyPrint": false,
      "linebreakType": "CR_LF"
    },
    "xmlSetting": {
      "rootTagName": "text",
      "entryRootDefinition": {
        "name": "text",
        "attributes": [
          "text"
        ],
        "childTags": []
      },
      "prettyPrint": false,
      "writeXmlDeclaration": true
    }
  },
  "suppressWebhooks": false,
  "suppressWorkflows": false,
  "createMissingHeadersFromRuleSet": false
}

Delete an existing Resource

delete

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

*/*

contextstringOptional

message context

messageValuestringOptional

message

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}

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

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

Create new Resource

post

Body

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

rootstringOptional

Bei JSON- und XML-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

parallelExecutionAllowedbooleanOptional

Aufsplitten in mehrere parallel ausgeführte Tasks erlauben?

Default: true

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

createMissingHeadersFromRuleSetbooleanOptional

Nur JSON & XML: Fehlende Header automatisch aus den im RuleSet referenzierten Spalten erzeugen?

Default: false

Responses

200

successful operation

*/*

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

rootstringOptional

Bei JSON- und XML-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

parallelExecutionAllowedbooleanOptional

Aufsplitten in mehrere parallel ausgeführte Tasks erlauben?

Default: true

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

createMissingHeadersFromRuleSetbooleanOptional

Nur JSON & XML: Fehlende Header automatisch aus den im RuleSet referenzierten Spalten erzeugen?

Default: false

422

Resource was not valid to process

*/*

post/cmn/data-import/rule-sets

POST /api/cmn/data-import/rule-sets HTTP/1.1
Host: 10.102.24.218:32792
Content-Type: application/json
Accept: */*
Content-Length: 1689

{
  "version": "text",
  "info": {},
  "id": "text",
  "mode": "SCRIPT",
  "label": "text",
  "root": "text",
  "rules": [],
  "importModuleKey": "text",
  "dataFrom": 1,
  "dataTo": 1,
  "headerIndex": 1,
  "columnSeparator": "text",
  "charSet": "UTF_8",
  "quotingChar": "text",
  "targetFieldRules": [],
  "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": [],
  "parallelExecutionAllowed": true,
  "advancedUi": false,
  "ignoreEmptyData": false,
  "exportSetting": {
    "fileName": "text",
    "charset": "UTF_8_BOM",
    "csvSetting": {
      "targetFieldDefinitions": [
        "text"
      ],
      "columnSeparator": ";",
      "quotingChar": "\"",
      "writeHeaderLine": true,
      "linebreakType": "CR_LF"
    },
    "jsonSetting": {
      "rootFieldDefinitions": [],
      "prettyPrint": false,
      "linebreakType": "CR_LF"
    },
    "xmlSetting": {
      "rootTagName": "text",
      "entryRootDefinition": {
        "name": "text",
        "attributes": [
          "text"
        ],
        "childTags": []
      },
      "prettyPrint": false,
      "writeXmlDeclaration": true
    }
  },
  "suppressWebhooks": false,
  "suppressWorkflows": false,
  "createMissingHeadersFromRuleSet": false
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-07-21T01:38:59.432Z",
    "createdFrom": "text",
    "updatedAt": "2026-07-21T01:38:59.432Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "mode": "SCRIPT",
  "label": "text",
  "root": "text",
  "rules": [],
  "importModuleKey": "text",
  "dataFrom": 1,
  "dataTo": 1,
  "headerIndex": 1,
  "columnSeparator": "text",
  "charSet": "UTF_8",
  "quotingChar": "text",
  "targetFieldRules": [],
  "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": [],
  "parallelExecutionAllowed": true,
  "advancedUi": false,
  "ignoreEmptyData": false,
  "exportSetting": {
    "fileName": "text",
    "charset": "UTF_8_BOM",
    "csvSetting": {
      "targetFieldDefinitions": [
        "text"
      ],
      "columnSeparator": ";",
      "quotingChar": "\"",
      "writeHeaderLine": true,
      "linebreakType": "CR_LF"
    },
    "jsonSetting": {
      "rootFieldDefinitions": [],
      "prettyPrint": false,
      "linebreakType": "CR_LF"
    },
    "xmlSetting": {
      "rootTagName": "text",
      "entryRootDefinition": {
        "name": "text",
        "attributes": [
          "text"
        ],
        "childTags": []
      },
      "prettyPrint": false,
      "writeXmlDeclaration": true
    }
  },
  "suppressWebhooks": false,
  "suppressWorkflows": false,
  "createMissingHeadersFromRuleSet": false
}

get

Path parameters

idinteger · int64Required

Responses

200

*/*

pathstringOptional

für das Mapping relavanter Pfad

displayNamestringOptional

Anzeigename für das Feld

modelTypestring · enumOptional

dynamisches oder statisches Feld?

Possible values:

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

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

200

[]

get

Path parameters

idinteger · int64Required

Responses

200

*/*

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

rootstringOptional

Bei JSON- und XML-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

parallelExecutionAllowedbooleanOptional

Aufsplitten in mehrere parallel ausgeführte Tasks erlauben?

Default: true

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

createMissingHeadersFromRuleSetbooleanOptional

Nur JSON & XML: Fehlende Header automatisch aus den im RuleSet referenzierten Spalten erzeugen?

Default: false

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

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

200

{
  "version": "text",
  "info": {
    "createdAt": "2026-07-21T01:38:59.432Z",
    "createdFrom": "text",
    "updatedAt": "2026-07-21T01:38:59.432Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "mode": "SCRIPT",
  "label": "text",
  "root": "text",
  "rules": [],
  "importModuleKey": "text",
  "dataFrom": 1,
  "dataTo": 1,
  "headerIndex": 1,
  "columnSeparator": "text",
  "charSet": "UTF_8",
  "quotingChar": "text",
  "targetFieldRules": [],
  "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": [],
  "parallelExecutionAllowed": true,
  "advancedUi": false,
  "ignoreEmptyData": false,
  "exportSetting": {
    "fileName": "text",
    "charset": "UTF_8_BOM",
    "csvSetting": {
      "targetFieldDefinitions": [
        "text"
      ],
      "columnSeparator": ";",
      "quotingChar": "\"",
      "writeHeaderLine": true,
      "linebreakType": "CR_LF"
    },
    "jsonSetting": {
      "rootFieldDefinitions": [],
      "prettyPrint": false,
      "linebreakType": "CR_LF"
    },
    "xmlSetting": {
      "rootTagName": "text",
      "entryRootDefinition": {
        "name": "text",
        "attributes": [
          "text"
        ],
        "childTags": []
      },
      "prettyPrint": false,
      "writeXmlDeclaration": true
    }
  },
  "suppressWebhooks": false,
  "suppressWorkflows": false,
  "createMissingHeadersFromRuleSet": false
}

get

Path parameters

moduleKeystringRequired

Responses

200

*/*

pathstringOptional

für das Mapping relavanter Pfad

displayNamestringOptional

Anzeigename für das Feld

modelTypestring · enumOptional

dynamisches oder statisches Feld?

Possible values:

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

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

200

[]

get

Responses

200

*/*

startEntityIdentifierstringOptional

Haupt-Entity des Imports

keystringOptional

Eindeutiger Schlüssel für eine Import-Art

supportsValidationbooleanOptional

Wird der Validierungsschritt unterstützt?

typestring · enumOptionalPossible values:

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

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

200

[]

PreviousAktivitäten NextArticle Storage

Last updated 12 hours ago

Was this helpful?