Skip to content

Transformation API (1)

This API possibility to transform string with python code.

Download OpenAPI description
api-v1.json
api-v1.yaml
Languages
Servers
Production

https://api.cdq.com/transformation/rest/

Transformations

Transformations

Operations

Data Transformation Definitions

Data Transformation Definitions

Operations

Create Data Transformation Definition

Request

Create Data Transformation Definition with provided mappings.

Security
apiKey
Bodyapplication/json
importsArray of objects(ImportDataTransformationDefinition)

List of imported data transformation definitions.

namestring(DataTransformationDefinitionName)

Name of the Data Transformation Definition.

Example: "My DTD"
typeobject(DataTransformationDefinitionType)

Type of the Data Transformation Definition

mappingsArray of objects(AttributeMappingRule)

List of attribute mappings.

reverseMappingsArray of objects(AttributeMappingRule)

List of reverse attribute mappings.

valueMappingsArray of objects(ValueMapping)

List of value mappings.

valuesArray of objects(Value)

List of values.

curl -i -X POST \
  https://api.cdq.com/transformation/rest/datatransformationdefinitions \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "imports": [
      {
        "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
      }
    ],
    "name": "My DTD",
    "type": {
      "name": "BUSINESS_PARTNER",
      "technicalKey": "BUSINESS_PARTNER"
    },
    "mappings": [
      {
        "sourceAttributes": [
          "businessPartner.record"
        ],
        "sourceSelections": [
          {
            "selectionType": "CONCATENATION",
            "value": ","
          }
        ],
        "targetAttributes": [
          "businessPartner.externalId"
        ],
        "targetTransformations": [
          {
            "constantValue": "constant",
            "targetAttributes": [
              "businessPartner.externalId"
            ],
            "transformationName": "CAPITALIZE",
            "defaultValue": "default",
            "transformationType": "CAPITALIZE"
          }
        ],
        "ignoredValues": [
          "ignored value"
        ]
      }
    ],
    "reverseMappings": [
      {
        "sourceAttributes": [
          "businessPartner.record"
        ],
        "sourceSelections": [
          {
            "selectionType": "CONCATENATION",
            "value": ","
          }
        ],
        "targetAttributes": [
          "businessPartner.externalId"
        ],
        "targetTransformations": [
          {
            "constantValue": "constant",
            "targetAttributes": [
              "businessPartner.externalId"
            ],
            "transformationName": "CAPITALIZE",
            "defaultValue": "default",
            "transformationType": "CAPITALIZE"
          }
        ],
        "ignoredValues": [
          "ignored value"
        ]
      }
    ],
    "valueMappings": [
      {
        "sourceConditions": [
          {
            "sourceValue": "AU",
            "sourceAttribute": "$.identifications[*].country.code",
            "sourceRegex": "^GR\\..{1,}"
          }
        ],
        "sourceValue": "AE1",
        "targetValue": "AE",
        "targetAttribute": "$.identifications[*].country.code",
        "sourceAttribute": "$.identifications[*].country.code",
        "disabled": "false"
      }
    ],
    "values": [
      {
        "sourceValue": "AE1",
        "sourceAttribute": "identifications[*].indentificationType.code"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
importsArray of objects(ImportDataTransformationDefinition)

List of imported data transformation definitions.

namestring(DataTransformationDefinitionName)

Name of the Data Transformation Definition.

Example: "My DTD"
typeobject(DataTransformationDefinitionType)

Type of the Data Transformation Definition

mappingsArray of objects(AttributeMappingRule)

List of attribute mappings.

reverseMappingsArray of objects(AttributeMappingRule)

List of reverse attribute mappings.

valueMappingsArray of objects(ValueMapping)

List of value mappings.

valuesArray of objects(Value)

List of values.

idstring(DataTransformationDefinitionId)

Unique identifier for a data transformation definition.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
workspaceIdstring(WorkspaceId)

Uniquely identifying ID of the workspace.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
versioninteger(VersionNumber)

Version number of the resource.

Example: 1
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-10-07T05:40:51Z"
modifiedBystring(ModifiedBy)

User or Client UUID which modified the resource.

Example: "76248934691294444"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2025-10-07T05:40:51Z"
Response
application/json
{
  "imports": [
    { … }
  ],
  "name": "My DTD",
  "type": {
    "name": "BUSINESS_PARTNER",
    "technicalKey": "BUSINESS_PARTNER"
  },
  "mappings": [
    { … }
  ],
  "reverseMappings": [
    { … }
  ],
  "valueMappings": [
    { … }
  ],
  "values": [
    { … }
  ],
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "version": 1,
  "createdBy": "76248934691294444",
  "createdAt": "2025-10-07T05:40:51Z",
  "modifiedBy": "76248934691294444",
  "modifiedAt": "2025-10-07T05:40:51Z"
}

List Data Transformation Definitions

Request

List Data Transformation Definitions.

Security
apiKey
Query
limitinteger

Number of items.

Default 50
Example: limit=100
startAfterstring(StartAfter)

Start after the given ID.

Example: startAfter=c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
importsstring

Filter for imports.

Example: imports=SAP.ODM
typeTechnicalKeystring(DataTransformationDefinitionTypeTechnicalKeyParam)

Filter for technicalKey type.

Enum ValueDescription
BUSINESS_PARTNER

Data transformation definitions applied to business partner

MESSAGE_DETAILS

Data transformation definitions applied to message details

BANK_ACCOUNT

Data transformation definition used during bank account data import job.

Example: typeTechnicalKey=BUSINESS_PARTNER
curl -i -X GET \
  https://api.cdq.com/transformation/rest/datatransformationdefinitions \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
startAfterstring(StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"
nextStartAfterstring(NextStartAfter)

Provides a value to be used as a startAfter in next page request.

Example: "5712566172571652"
totalinteger(PageTotal)

Total number of items which can be paged.

Example: "67"
valuesArray of objects(DataTransformationDefinitionSearchResult)

List of data transformation definitions.

Response
application/json
{
  "startAfter": "5712566172571652",
  "nextStartAfter": "5712566172571652",
  "total": "67",
  "values": [
    { … }
  ]
}

Reverse Data Transformation Definition

Request

Reverse Data Transformation Definition.

Security
apiKey
Path
idstringrequired

ID of the data transformation definition.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
curl -i -X GET \
  https://api.cdq.com/transformation/rest/datatransformationdefinitions/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4/reverse \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
importsArray of objects(ImportDataTransformationDefinition)

List of imported data transformation definitions.

namestring(DataTransformationDefinitionName)

Name of the Data Transformation Definition.

Example: "My DTD"
typeobject(DataTransformationDefinitionType)

Type of the Data Transformation Definition

mappingsArray of objects(AttributeMappingRule)

List of attribute mappings.

reverseMappingsArray of objects(AttributeMappingRule)

List of reverse attribute mappings.

valueMappingsArray of objects(ValueMapping)

List of value mappings.

valuesArray of objects(Value)

List of values.

idstring(DataTransformationDefinitionId)

Unique identifier for a data transformation definition.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
workspaceIdstring(WorkspaceId)

Uniquely identifying ID of the workspace.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
versioninteger(VersionNumber)

Version number of the resource.

Example: 1
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-10-07T05:40:51Z"
modifiedBystring(ModifiedBy)

User or Client UUID which modified the resource.

Example: "76248934691294444"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2025-10-07T05:40:51Z"
Response
application/json
{
  "imports": [
    { … }
  ],
  "name": "My DTD",
  "type": {
    "name": "BUSINESS_PARTNER",
    "technicalKey": "BUSINESS_PARTNER"
  },
  "mappings": [
    { … }
  ],
  "reverseMappings": [
    { … }
  ],
  "valueMappings": [
    { … }
  ],
  "values": [
    { … }
  ],
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "version": 1,
  "createdBy": "76248934691294444",
  "createdAt": "2025-10-07T05:40:51Z",
  "modifiedBy": "76248934691294444",
  "modifiedAt": "2025-10-07T05:40:51Z"
}

Read Data Transformation Definition

Request

Read Data Transformation Definition.

Security
apiKey
Path
idstringrequired

ID of the data transformation definition.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
Query
featuresOnArray of strings(TransformationDefinitionFeatureParam)

Features to be activated.

Items ValueDescription
RESOLVE_IMPORTS

Merge definitions from import

Example: featuresOn=RESOLVE_IMPORTS
curl -i -X GET \
  https://api.cdq.com/transformation/rest/datatransformationdefinitions/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
importsArray of objects(ImportDataTransformationDefinition)

List of imported data transformation definitions.

namestring(DataTransformationDefinitionName)

Name of the Data Transformation Definition.

Example: "My DTD"
typeobject(DataTransformationDefinitionType)

Type of the Data Transformation Definition

mappingsArray of objects(AttributeMappingRule)

List of attribute mappings.

reverseMappingsArray of objects(AttributeMappingRule)

List of reverse attribute mappings.

valueMappingsArray of objects(ValueMapping)

List of value mappings.

valuesArray of objects(Value)

List of values.

idstring(DataTransformationDefinitionId)

Unique identifier for a data transformation definition.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
workspaceIdstring(WorkspaceId)

Uniquely identifying ID of the workspace.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
versioninteger(VersionNumber)

Version number of the resource.

Example: 1
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-10-07T05:40:51Z"
modifiedBystring(ModifiedBy)

User or Client UUID which modified the resource.

Example: "76248934691294444"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2025-10-07T05:40:51Z"
Response
application/json
{
  "imports": [
    { … }
  ],
  "name": "My DTD",
  "type": {
    "name": "BUSINESS_PARTNER",
    "technicalKey": "BUSINESS_PARTNER"
  },
  "mappings": [
    { … }
  ],
  "reverseMappings": [
    { … }
  ],
  "valueMappings": [
    { … }
  ],
  "values": [
    { … }
  ],
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "version": 1,
  "createdBy": "76248934691294444",
  "createdAt": "2025-10-07T05:40:51Z",
  "modifiedBy": "76248934691294444",
  "modifiedAt": "2025-10-07T05:40:51Z"
}

Update Data Transformation Definition

Request

Update Data Transformation Definition.

Security
apiKey
Path
idstringrequired

ID of the data transformation definition.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
Bodyapplication/jsonrequired
importsArray of objects(ImportDataTransformationDefinition)

List of imported data transformation definitions.

namestring(DataTransformationDefinitionName)

Name of the Data Transformation Definition.

Example: "My DTD"
typeobject(DataTransformationDefinitionType)

Type of the Data Transformation Definition

mappingsArray of objects(AttributeMappingRule)

List of attribute mappings.

reverseMappingsArray of objects(AttributeMappingRule)

List of reverse attribute mappings.

valueMappingsArray of objects(ValueMapping)

List of value mappings.

valuesArray of objects(Value)

List of values.

curl -i -X PUT \
  https://api.cdq.com/transformation/rest/datatransformationdefinitions/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "imports": [
      {
        "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
      }
    ],
    "name": "My DTD",
    "type": {
      "name": "BUSINESS_PARTNER",
      "technicalKey": "BUSINESS_PARTNER"
    },
    "mappings": [
      {
        "sourceAttributes": [
          "businessPartner.record"
        ],
        "sourceSelections": [
          {
            "selectionType": "CONCATENATION",
            "value": ","
          }
        ],
        "targetAttributes": [
          "businessPartner.externalId"
        ],
        "targetTransformations": [
          {
            "constantValue": "constant",
            "targetAttributes": [
              "businessPartner.externalId"
            ],
            "transformationName": "CAPITALIZE",
            "defaultValue": "default",
            "transformationType": "CAPITALIZE"
          }
        ],
        "ignoredValues": [
          "ignored value"
        ]
      }
    ],
    "reverseMappings": [
      {
        "sourceAttributes": [
          "businessPartner.record"
        ],
        "sourceSelections": [
          {
            "selectionType": "CONCATENATION",
            "value": ","
          }
        ],
        "targetAttributes": [
          "businessPartner.externalId"
        ],
        "targetTransformations": [
          {
            "constantValue": "constant",
            "targetAttributes": [
              "businessPartner.externalId"
            ],
            "transformationName": "CAPITALIZE",
            "defaultValue": "default",
            "transformationType": "CAPITALIZE"
          }
        ],
        "ignoredValues": [
          "ignored value"
        ]
      }
    ],
    "valueMappings": [
      {
        "sourceConditions": [
          {
            "sourceValue": "AU",
            "sourceAttribute": "$.identifications[*].country.code",
            "sourceRegex": "^GR\\..{1,}"
          }
        ],
        "sourceValue": "AE1",
        "targetValue": "AE",
        "targetAttribute": "$.identifications[*].country.code",
        "sourceAttribute": "$.identifications[*].country.code",
        "disabled": "false"
      }
    ],
    "values": [
      {
        "sourceValue": "AE1",
        "sourceAttribute": "identifications[*].indentificationType.code"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
importsArray of objects(ImportDataTransformationDefinition)

List of imported data transformation definitions.

namestring(DataTransformationDefinitionName)

Name of the Data Transformation Definition.

Example: "My DTD"
typeobject(DataTransformationDefinitionType)

Type of the Data Transformation Definition

mappingsArray of objects(AttributeMappingRule)

List of attribute mappings.

reverseMappingsArray of objects(AttributeMappingRule)

List of reverse attribute mappings.

valueMappingsArray of objects(ValueMapping)

List of value mappings.

valuesArray of objects(Value)

List of values.

idstring(DataTransformationDefinitionId)

Unique identifier for a data transformation definition.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
workspaceIdstring(WorkspaceId)

Uniquely identifying ID of the workspace.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
versioninteger(VersionNumber)

Version number of the resource.

Example: 1
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-10-07T05:40:51Z"
modifiedBystring(ModifiedBy)

User or Client UUID which modified the resource.

Example: "76248934691294444"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2025-10-07T05:40:51Z"
Response
application/json
{
  "imports": [
    { … }
  ],
  "name": "My DTD",
  "type": {
    "name": "BUSINESS_PARTNER",
    "technicalKey": "BUSINESS_PARTNER"
  },
  "mappings": [
    { … }
  ],
  "reverseMappings": [
    { … }
  ],
  "valueMappings": [
    { … }
  ],
  "values": [
    { … }
  ],
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "version": 1,
  "createdBy": "76248934691294444",
  "createdAt": "2025-10-07T05:40:51Z",
  "modifiedBy": "76248934691294444",
  "modifiedAt": "2025-10-07T05:40:51Z"
}

Delete Data Transformation Definition

Request

Delete Data Transformation Definition.

Security
apiKey
Path
idstringrequired

ID of the data transformation definition.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
curl -i -X DELETE \
  https://api.cdq.com/transformation/rest/datatransformationdefinitions/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
idstring

ID of the deleted object.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
Response
application/json
{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
}

Read specific version of Data Transformation Definition

Request

Read specific version of Data Transformation Definition.

Security
apiKey
Path
idstringrequired

ID of the data transformation definition.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
versionintegerrequired

Version number of the Data Transformation Definition.

Example: 1
curl -i -X GET \
  https://api.cdq.com/transformation/rest/datatransformationdefinitions/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4/versions/1 \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
importsArray of objects(ImportDataTransformationDefinition)

List of imported data transformation definitions.

namestring(DataTransformationDefinitionName)

Name of the Data Transformation Definition.

Example: "My DTD"
typeobject(DataTransformationDefinitionType)

Type of the Data Transformation Definition

mappingsArray of objects(AttributeMappingRule)

List of attribute mappings.

reverseMappingsArray of objects(AttributeMappingRule)

List of reverse attribute mappings.

valueMappingsArray of objects(ValueMapping)

List of value mappings.

valuesArray of objects(Value)

List of values.

idstring

Unique identifier of Data Transformation Definition version.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
dataTransformationDefinitionIdstring

Unique identifier for a Data Transformation Definition.

Example: "17def3cf51b6-abf0-4f8e-9a20-cd83bab2"
versioninteger(DataTransformationDefinitionVersionNumber)

Version number of the configuration.

Example: 1
workspaceIdstring(WorkspaceId)

Uniquely identifying ID of the workspace.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-10-07T05:40:51Z"
Response
application/json
{
  "imports": [
    { … }
  ],
  "name": "My DTD",
  "type": {
    "name": "BUSINESS_PARTNER",
    "technicalKey": "BUSINESS_PARTNER"
  },
  "mappings": [
    { … }
  ],
  "reverseMappings": [
    { … }
  ],
  "valueMappings": [
    { … }
  ],
  "values": [
    { … }
  ],
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "dataTransformationDefinitionId": "17def3cf51b6-abf0-4f8e-9a20-cd83bab2",
  "version": 1,
  "workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "createdBy": "76248934691294444",
  "createdAt": "2025-10-07T05:40:51Z"
}

Data Transformation Schemas

Data Transformation Schemas

Operations