List Data Mapper Definitions

Read the Data Mapper Definition Page.

SecurityapiKey

Request

query Parameters

label	Array of strings Label for filtering that is passed as header parameter with the name label. Example: label=Custom label
page	integer <int32> >= 0 Default: 0 Number of the page that will be retrieved. Example: page=10
pageSize	integer <int32> >= 1 Default: 20 Number of items to be returned on the page. Example: pageSize=10
sharedWithOrganization	boolean Filters only mappings which are shared with organization or not. Example: sharedWithOrganization=true
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: sort=-modifiedAt

Responses

200

get/datamapperdefinitions

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"numberOfPages": "10",
"page": "1",
"pageSize": "100",
"total": "67",
"values": [{"id": "6440dba32b30176c5917b1b7",
"createdAt": "2025-02-21T08:27:54Z",
"createdBy": "76248934691294444",
"lastUpdatedAt": "2025-02-21T08:27:54Z",
"modifiedAt": "2025-02-21T08:27:55Z",
"modifiedBy": "76248934691294444",
"creatorUsername": "john.doe",
"creatorOrganization": "cdq",
"shareWithOrganization": "true",
"labels": ["Custom Storage Name"
],
"name": "Custom name of Data Mapper",
"valueMappings": [{"sourceValue": "en",
"targetValue": "INTERNATIONAL",
"targetAttribute": "address.version.characterSet"
}
],
"inputMapping": {"businessPartnerAttributeMappings": [{"sourceConstant": "LOCAL",
"sourceAttributes": ["Name"
],
"targetAttributes": ["businessPartner.names[0].value"
],
"targetAttributeTypes": ["BUSINESS_PARTNER_NAME_TYPE_LOCAL"
],
"countryScopes": ["DE"
],
"selectionType": "COMMA",
"separationType": "LENGTH",
"isMandatoryAttribute": "true",
"valueMapping": "INTERNATIONAL",
"defaultValue": "GB",
"transformations": [{"type": null,
"parameters": [ ]
}
]
}
],
"addressesAttributeMappings": [[{"sourceConstant": "LOCAL",
"sourceAttributes": [null
],
"targetAttributes": [null
],
"targetAttributeTypes": [null
],
"countryScopes": [null
],
"selectionType": "COMMA",
"separationType": "LENGTH",
"isMandatoryAttribute": "true",
"valueMapping": "INTERNATIONAL",
"defaultValue": "GB",
"transformations": [null
]
}
]
]
},
"outputMapping": {"businessPartnerAttributeMappings": [{"sourceConstant": "LOCAL",
"sourceAttributes": ["Name"
],
"targetAttributes": ["businessPartner.names[0].value"
],
"targetAttributeTypes": ["BUSINESS_PARTNER_NAME_TYPE_LOCAL"
],
"countryScopes": ["DE"
],
"selectionType": "COMMA",
"separationType": "LENGTH",
"isMandatoryAttribute": "true",
"valueMapping": "INTERNATIONAL",
"defaultValue": "GB",
"transformations": [{"type": null,
"parameters": [ ]
}
]
}
],
"addressesAttributeMappings": [[{"sourceConstant": "LOCAL",
"sourceAttributes": [null
],
"targetAttributes": [null
],
"targetAttributeTypes": [null
],
"countryScopes": [null
],
"selectionType": "COMMA",
"separationType": "LENGTH",
"isMandatoryAttribute": "true",
"valueMapping": "INTERNATIONAL",
"defaultValue": "GB",
"transformations": [null
]
}
]
]
}
}
]
}