# List Data Mapper Definitions

Read the Data Mapper Definition Page.

Endpoint: GET /datamapperdefinitions
Version: 5
Security: apiKey

## Query parameters:

  - `label` (array)
    Label for filtering that is passed as header parameter with the name label.
    Example: ["Custom label"]

  - `sharedWithOrganization` (boolean)
    Filters only mappings which are shared with organization or not.
    Example: "true"

  - `page` (integer)
    Number of the page that will be retrieved.
    Example: "10"

  - `pageSize` (integer)
    Number of items to be returned on the page.
    Example: "10"

  - `sort` (string)
    Defines the attributes to sort by. Supported attributes are 'id' and 'modifiedAt', separated by comma (,) and the sort direction in front of each 
attribute. '+' means ascending, '-' means descending. If direction is not given default sort is ascending.
    Example: "-modifiedAt"

## Response 200 fields (application/json):

  - `numberOfPages` (integer)
    Number of pages.
    Example: "10"

  - `page` (integer)
    Current page number.
    Example: "1"

  - `pageSize` (integer)
    Number of items per page.
    Example: "100"

  - `total` (integer)
    Total number of items which can be paged.
    Example: "67"

  - `values` (array)
    List of Data Mapper Definitions.

  - `values.id` (string)
    ID of related Data Mapper Definition that is used for mapping data of this Business Partner Storage.
    Example: "6440dba32b30176c5917b1b7"

  - `values.createdAt` (string)
    Date of creation (ISO 8601-compliant).
    Example: "2025-09-10T10:12:36Z"

  - `values.createdBy` (string)
    Creator of a resource.
    Example: "76248934691294444"

  - `values.modifiedAt` (string)
    Date of modification (ISO 8601-compliant).
    Example: "2025-09-10T10:12:36Z"

  - `values.modifiedBy` (string)
    User or Client UUID which modified the resource.
    Example: "76248934691294444"

  - `values.creatorUsername` (string)
    Username of the creator of the Data Mapper Definition.
    Example: "john.doe"

  - `values.creatorOrganization` (string)
    Organization of the creator of the Data Mapper Definition.
    Example: "cdq"

  - `values.shareWithOrganization` (boolean)
    Toggle to enable that the Data Mapper Definition is shared with the whole organization.
    Example: "true"

  - `values.labels` (array)
    List of labels.
    Example: ["Custom Storage Name"]

  - `values.name` (string)
    Name of the Data Mapper Definition.
    Example: "Custom name of Data Mapper"

  - `values.valueMappings` (array)
    List of Value Mappings.

  - `values.valueMappings.sourceValue` (string)
    The source value for a value mapping.
    Example: "en"

  - `values.valueMappings.targetValue` (string)
    The target value for a value mapping.
    Example: "INTERNATIONAL"

  - `values.valueMappings.targetAttribute` (string)
    The target attribute value (Business Partner or address) in the CDQ data model.
    Example: "address.version.characterSet"

  - `values.inputMapping` (object)
    Maps a Business Partner data from raw data to CDQ data model.

  - `values.inputMapping.businessPartnerAttributeMappings` (array)
    List of Business Partner Attribute Mappings.

  - `values.inputMapping.businessPartnerAttributeMappings.sourceConstant` (string)
    Assigns a fix value at path defined in targetAttributes.
    Example: "LOCAL"

  - `values.inputMapping.businessPartnerAttributeMappings.sourceAttributes` (array)
    List of source attributes.
    Example: ["Name"]

  - `values.inputMapping.businessPartnerAttributeMappings.targetAttributes` (array)
    List of target attributes.
    Example: ["businessPartner.names[0].value"]

  - `values.inputMapping.businessPartnerAttributeMappings.targetAttributeTypes` (array)
    List of target attribute types.
    Example: ["LOCAL"]

  - `values.inputMapping.businessPartnerAttributeMappings.countryScopes` (array)
    List of country scopes.
    Example: ["DE"]

  - `values.inputMapping.businessPartnerAttributeMappings.selectionType` (string)
    Defines how attribute values should be concatenated.
    Enum: "COMMA", "EMPTY", "HYPHEN", "SEMICOLON", "SPACE", "XOR"

  - `values.inputMapping.businessPartnerAttributeMappings.separationType` (string)
    Define how the source value should be separated.
    Enum: "LENGTH"

  - `values.inputMapping.businessPartnerAttributeMappings.isMandatoryAttribute` (boolean)
    Define if the attribute is mandatory or optional.
If , the attribute is mandatory.
If , the attribute is optional.
    Example: "true"

  - `values.inputMapping.businessPartnerAttributeMappings.valueMapping` (string)
    Maps a cons from raw data to CDQ data model.
    Example: "INTERNATIONAL"

  - `values.inputMapping.businessPartnerAttributeMappings.defaultValue` (string)
    Defines default values applied for fields, for which no value was provided.
    Example: "GB"

  - `values.inputMapping.businessPartnerAttributeMappings.transformations` (array)
    List of transformations.

  - `values.inputMapping.businessPartnerAttributeMappings.transformations.type` (string)
    Define the Transformation Type.
    Enum: "UPPER_CASE", "LOWER_CASE"

  - `values.inputMapping.businessPartnerAttributeMappings.transformations.parameters` (array)
    Depending on the Transformation Type different parameters can be given.

  - `values.inputMapping.businessPartnerAttributeMappings.transformations.parameters.key` (string)
    Transformation parameter key.
    Example: "transformationName"

  - `values.inputMapping.businessPartnerAttributeMappings.transformations.parameters.value` (string)
    Value of the parameter.
    Example: "lv_locality_transformation"

  - `values.inputMapping.addressesAttributeMappings` (array)
    Maps an address attribute from raw data to CDQ data model.

  - `values.outputMapping` (object)
    Maps a Business Partner data from raw data to CDQ data model.

  - `values.lastUpdatedAt` (string)
    Deprecated, please use modifiedAt instead.
    Example: "2025-09-10T10:12:36Z"