Data Transformation

Data Transformation Public Webservice

Poll Transformation Job

After you have started a transformation job, you will receive a job id in the response.

{
  "id" : "<ID>"
}

Use this ID to poll for the status of the job using this endpoint. Once the status is FINISHED the transformation is done, and you are able to verify the result in your storage.

SecurityapiKey
Request
path Parameters
id
required
string (JobId)

ID of the transformation job.

Example: 35f23c03-1c22-45fe-9484-3ffe769325de
Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get/jobs/transformationjobs/{id}
Request samples 
Response samples 
application/json
{
  • "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "domain": "BusinessPartner",
  • "name": "Process vendor data.",
  • "description": "I started this job to improve quality of our data.",
  • "createdBy": "76248934691294444",
  • "createdAt": "2024-12-21T01:35:27Z",
  • "modifiedAt": "2024-12-21T01:35:27Z",
  • "progress": "77",
  • "status": "RUNNING",
  • "statusMessage": "DataSource [5e2874fb8d2a7400011acee1] has no DataMapperDefinition attached and no alternative dataMapperDefinitionId was passed to the job",
  • "storageId": "72d6900fce6b326088f5d9d91049e3e6",
  • "dataSourceId": "648824a691d8d2503d65103e",
  • "dataMapperDefinitionId": "6440dba32b30176c5917b1b7",
  • "dataTransformationDefinitionId": "6440dba32b30176c5917b1b7",
  • "featuresOn": [
    ],
  • "result": {
    }
}
Start Transformation Job
Starting a Transformation Job. In case any selected data source does not have a dataMappingDefinition an API error returned.


SecurityapiKey 
Request 
Request Body schema: application/json
required
cmd


Array of objects (TransformationJobRequestCountry) 
List of countries for which the records should be transformed.


 
dataMapperDefinitionId
string (DataMapperDefinitionId) 
ID of related Data Mapper Definition that is used for mapping data of this Business Partner Storage.


 
 Example:  "6440dba32b30176c5917b1b7"
dataSourceId
string
Unique identifier for a Data Source of the Storage. 


If set, only the records that belong to the data source identified by this ID are transformed.
By default, all records of the Business Partner Storage (means from all data sources) are transformed.


 
 Example:  "648824a691d8d2503d65103e"
dataTransformationDefinitionId
string (DataTransformationDefinitionId) 
ID of related Data Transformation Definition that is used for mapping data of this Business Partner Storage.


 
 Example:  "6440dba32b30176c5917b1b7"
description
string (JobDescription) 
Detailed description of a Job.


 
 Example:  "I started this job to improve quality of our data."
featuresOn
Array of strings (TransformationJobFeatureParam) 
Items Enum: Description
ENABLE_EXTERNAL_ID_UPDATE
Enables to update external ID of a Business Partner.


UPSERT_CHANGES_ONLY
Performs transformation only for business partners, for which changes in the mapping are relevant. By default, all records of the storage are transformed.


 
 Example:  ["UPSERT_CHANGES_ONLY"]
name
string (JobName) 
Name of a Job.


 
 Example:  "Process vendor data."
startAfter
string
Processes transformation of records starting from the ID 'startAfter'.


 
 Example:  "NjI4ZGNkZjAzYjlkMjY4NjhlNjQxNDRm"
storageId
required
string (BusinessPartnerStorageId) 
Unique identifier of the Storage.


 
 Example:  "72d6900fce6b326088f5d9d91049e3e6"
Responses 
200
OK


400
The sent request is malformed.


401
Unauthorized


403
Forbidden


post/jobs/transformationjobs
Request samples 
application/json
{
  • "name": "Process vendor data.",
  • "description": "I started this job to improve quality of our data.",
  • "dataSourceId": "648824a691d8d2503d65103e",
  • "countries": [
    ],
  • "storageId": "72d6900fce6b326088f5d9d91049e3e6",
  • "dataMapperDefinitionId": "6440dba32b30176c5917b1b7",
  • "dataTransformationDefinitionId": "6440dba32b30176c5917b1b7",
  • "startAfter": "NjI4ZGNkZjAzYjlkMjY4NjhlNjQxNDRm",
  • "featuresOn": [
    ]
}
Response samples 
application/json
{
  • "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "domain": "BusinessPartner",
  • "name": "Process vendor data.",
  • "description": "I started this job to improve quality of our data.",
  • "createdBy": "76248934691294444",
  • "createdAt": "2024-12-21T01:35:27Z",
  • "modifiedAt": "2024-12-21T01:35:27Z",
  • "progress": "77",
  • "status": "RUNNING",
  • "statusMessage": "DataSource [5e2874fb8d2a7400011acee1] has no DataMapperDefinition attached and no alternative dataMapperDefinitionId was passed to the job",
  • "storageId": "72d6900fce6b326088f5d9d91049e3e6",
  • "dataSourceId": "648824a691d8d2503d65103e",
  • "dataMapperDefinitionId": "6440dba32b30176c5917b1b7",
  • "dataTransformationDefinitionId": "6440dba32b30176c5917b1b7",
  • "featuresOn": [
    ],
  • "result": {
    }
}
Use Data Mapper DefinitionDeprecated
Use a Data Mapper Definition to transform a list of records into Business Partners.


SecurityapiKey 
Request 
path Parameters
id
required
string (DataMapperDefinitionId) 
ID of the Data Mapper Definition.


 
 Example:  6440dba32b30176c5917b1b7
Request Body schema: application/json
required
Records


recordsAsJsonString
Array of strings
The records to be transformed as json string.


 
 Example:  ["{\"address\": \"Musterstrasse 1, 12345 Musterstadt\"}"]
Responses 
200
OK


401
Unauthorized


403
Forbidden


404
Not Found


post/v3/datamappers/{id}/transform
Request samples 
application/json
{
  • "recordsAsJsonString": [
    ]
}
Response samples 
application/json
[
  • {
    }
]