Skip to content

Transformation API (1)

This API possibility to transform string with python code.

Overview
URL

https://www.cdq.ch/team

Krystian Sola

krystian.sola@cdq.com

Languages
Servers
Mock server

https://idp.cdq.com/_mock/apis/transformation-api/api-v1/

Production SOAP

https://api.corporate-data-league.ch/transformation-api/soap/v1/

Production

https://api.corporate-data-league.ch/transformation-api/

Configurations

Data Transformation Configurations

Operations

Transformations

Transformations

Operations

Data Transformation Definitions

Data Transformation Definitions

Operations

Create Data Transformation Definition

Request

Create Data Transformation Definition with provided mappings.

Security
oAuth2
Bodyapplication/json
importsArray of objects(ImportDataTransformationDefinition)

List of imported data transformation definitions.

namestring(DataTransformationDefinitionName)

Name of the Data Transformation Definition.

Example: "My DTD"
directionstring(DataTransformationDefinitionDirectionParam)

Direction of the Data Transformation Definition. Does not prevent usage of reverse transformation. This field is used by Transformation-aware endpoints to determine whether to use normal or reversed definition.

Enum ValueDescription
INBOUND

Indicates that target attributes correspond the the CDQ data model.

OUTBOUND

Indicates that source attributes correspond the the CDQ data model.

Example: "INBOUND"
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.

customTransformationsArray of objects(CustomTransformation)

Custom transformation in python or javascript code.

The code must define a function "transform" with one parameter "raw_data" of type string. The function must return either:

  • a string
  • a json object (dict in python, JSON object literal in javascript).

When returning a json object, it must follow the following structure:

{
  "targetAttributePath": "value",
  "targetAttributePath2": "value2"
  "targetAttributePath3": null // Null (e.g., None, undefined) values are ignored
}

If sourceAttribute is a list, then the raw_data parameter will contain a serialized json array of strings. For example, if sourceAttribute points to ["address.line1", "address.line2"], then raw_data will be "["address.line1","address.line2"]" rather than an array of strings.

The simplest transformation looks as follows:

def transform(raw_data):
    return raw_data

To make some operation on json following code should be applied:

import json

def transform(raw_data):
    json_result = json.loads(raw_data)
    return json_result["address"]

The method def transform(raw_data) must always be provided. Feature is experimental and limited to CDQ organizations.

Enable this transformation by setting transformation type in targetTransformations to CUSTOM_TRANSFORMATION and fill transformationName with the name of the custom transformation.

curl -i -X POST \
  https://idp.cdq.com/_mock/apis/transformation-api/api-v1/datatransformationdefinitions \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "imports": [
      {
        "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
      }
    ],
    "name": "My DTD",
    "direction": "INBOUND",
    "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"
      }
    ],
    "customTransformations": [
      {
        "name": "Code above.",
        "code": "Code above.",
        "language": "python"
      }
    ]
  }'

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"
directionstring(DataTransformationDefinitionDirectionParam)

Direction of the Data Transformation Definition. Does not prevent usage of reverse transformation. This field is used by Transformation-aware endpoints to determine whether to use normal or reversed definition.

Enum ValueDescription
INBOUND

Indicates that target attributes correspond the the CDQ data model.

OUTBOUND

Indicates that source attributes correspond the the CDQ data model.

Example: "INBOUND"
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: "2020-08-31T16:47+00:00"
modifiedBystring(ModifiedBy)

User or Client UUID which modified the resource.

Example: "76248934691294444"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
customTransformationsArray of objects(CustomTransformation)

Custom transformation in python or javascript code.

The code must define a function "transform" with one parameter "raw_data" of type string. The function must return either:

  • a string
  • a json object (dict in python, JSON object literal in javascript).

When returning a json object, it must follow the following structure:

{
  "targetAttributePath": "value",
  "targetAttributePath2": "value2"
  "targetAttributePath3": null // Null (e.g., None, undefined) values are ignored
}

If sourceAttribute is a list, then the raw_data parameter will contain a serialized json array of strings. For example, if sourceAttribute points to ["address.line1", "address.line2"], then raw_data will be "["address.line1","address.line2"]" rather than an array of strings.

The simplest transformation looks as follows:

def transform(raw_data):
    return raw_data

To make some operation on json following code should be applied:

import json

def transform(raw_data):
    json_result = json.loads(raw_data)
    return json_result["address"]

The method def transform(raw_data) must always be provided. Feature is experimental and limited to CDQ organizations.

Enable this transformation by setting transformation type in targetTransformations to CUSTOM_TRANSFORMATION and fill transformationName with the name of the custom transformation.

Response
application/json
{
  "imports": [
    { … }
  ],
  "name": "My DTD",
  "direction": "INBOUND",
  "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": "2020-08-31T16:47+00:00",
  "modifiedBy": "76248934691294444",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "customTransformations": [
    { … }
  ]
}

List Data Transformation Definitions

Request

List Data Transformation Definitions.

Security
oAuth2
Query
pageinteger

The page number.

Default 0
Example: page=2
pageSizeinteger

Number of entries in a page.

Default 10
Example: pageSize=50
importsstring

Filter for imports.

Example: imports=SAP.ODM
curl -i -X GET \
  https://idp.cdq.com/_mock/apis/transformation-api/api-v1/datatransformationdefinitions \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
totalinteger(PageTotal)

Total number of items which can be paged.

Example: "67"
pageSizeinteger(PageSize)[ 1 .. 1000 ]

Number of items per page.

Default 10
Example: "100"
pageinteger(Page)>= 0

Current page number.

Default 0
Example: "1"
valuesArray of objects(DataTransformationDefinitionInternal)

List of data transformation definitions.

Response
application/json
{
  "total": "67",
  "pageSize": "100",
  "page": "1",
  "values": [
    { … }
  ]
}

Create Data Transformation Definition

Request

Create Data Transformation Definition with provided mappings.

Security
oAuth2
Bodyapplication/json
importsArray of objects(ImportDataTransformationDefinition)

List of imported data transformation definitions.

namestring(DataTransformationDefinitionName)

Name of the Data Transformation Definition.

Example: "My DTD"
directionstring(DataTransformationDefinitionDirectionParam)

Direction of the Data Transformation Definition. Does not prevent usage of reverse transformation. This field is used by Transformation-aware endpoints to determine whether to use normal or reversed definition.

Enum ValueDescription
INBOUND

Indicates that target attributes correspond the the CDQ data model.

OUTBOUND

Indicates that source attributes correspond the the CDQ data model.

Example: "INBOUND"
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://idp.cdq.com/_mock/apis/transformation-api/api-v1/public/datatransformationdefinitions \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "imports": [
      {
        "id": "SAP.ODM"
      }
    ],
    "name": "YOUR DTD NAME",
    "direction": "INBOUND",
    "type": {
      "name": "BUSINESS_PARTNER",
      "technicalKey": "BUSINESS_PARTNER"
    },
    "mappings": [],
    "reverseMappings": [],
    "valueMappings": [],
    "values": []
  }'

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"
directionstring(DataTransformationDefinitionDirectionParam)

Direction of the Data Transformation Definition. Does not prevent usage of reverse transformation. This field is used by Transformation-aware endpoints to determine whether to use normal or reversed definition.

Enum ValueDescription
INBOUND

Indicates that target attributes correspond the the CDQ data model.

OUTBOUND

Indicates that source attributes correspond the the CDQ data model.

Example: "INBOUND"
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: "2020-08-31T16:47+00:00"
modifiedBystring(ModifiedBy)

User or Client UUID which modified the resource.

Example: "76248934691294444"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
Response
application/json
{
  "imports": [
    { … }
  ],
  "name": "My DTD",
  "direction": "INBOUND",
  "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": "2020-08-31T16:47+00:00",
  "modifiedBy": "76248934691294444",
  "modifiedAt": "2020-08-31T16:47+00:00"
}

List Data Transformation Definitions

Request

List Data Transformation Definitions.

Security
oAuth2
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 model.

UPDATED_BUSINESS_PARTNER

Data transformation definitions applied to updated business partner model.

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://idp.cdq.com/_mock/apis/transformation-api/api-v1/public/datatransformationdefinitions \
  -H 'Authorization: Bearer <YOUR_TOKEN_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
oAuth2
Path
idstringrequired

ID of the data transformation definition.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
curl -i -X GET \
  https://idp.cdq.com/_mock/apis/transformation-api/api-v1/datatransformationdefinitions/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4/reverse \
  -H 'Authorization: Bearer <YOUR_TOKEN_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"
directionstring(DataTransformationDefinitionDirectionParam)

Direction of the Data Transformation Definition. Does not prevent usage of reverse transformation. This field is used by Transformation-aware endpoints to determine whether to use normal or reversed definition.

Enum ValueDescription
INBOUND

Indicates that target attributes correspond the the CDQ data model.

OUTBOUND

Indicates that source attributes correspond the the CDQ data model.

Example: "INBOUND"
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: "2020-08-31T16:47+00:00"
modifiedBystring(ModifiedBy)

User or Client UUID which modified the resource.

Example: "76248934691294444"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
customTransformationsArray of objects(CustomTransformation)

Custom transformation in python or javascript code.

The code must define a function "transform" with one parameter "raw_data" of type string. The function must return either:

  • a string
  • a json object (dict in python, JSON object literal in javascript).

When returning a json object, it must follow the following structure:

{
  "targetAttributePath": "value",
  "targetAttributePath2": "value2"
  "targetAttributePath3": null // Null (e.g., None, undefined) values are ignored
}

If sourceAttribute is a list, then the raw_data parameter will contain a serialized json array of strings. For example, if sourceAttribute points to ["address.line1", "address.line2"], then raw_data will be "["address.line1","address.line2"]" rather than an array of strings.

The simplest transformation looks as follows:

def transform(raw_data):
    return raw_data

To make some operation on json following code should be applied:

import json

def transform(raw_data):
    json_result = json.loads(raw_data)
    return json_result["address"]

The method def transform(raw_data) must always be provided. Feature is experimental and limited to CDQ organizations.

Enable this transformation by setting transformation type in targetTransformations to CUSTOM_TRANSFORMATION and fill transformationName with the name of the custom transformation.

Response
application/json
{
  "imports": [
    { … }
  ],
  "name": "My DTD",
  "direction": "INBOUND",
  "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": "2020-08-31T16:47+00:00",
  "modifiedBy": "76248934691294444",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "customTransformations": [
    { … }
  ]
}

Reverse Data Transformation Definition

Request

Reverse Data Transformation Definition.

Security
oAuth2
Path
idstringrequired

ID of the data transformation definition.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
curl -i -X GET \
  https://idp.cdq.com/_mock/apis/transformation-api/api-v1/public/datatransformationdefinitions/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4/reverse \
  -H 'Authorization: Bearer <YOUR_TOKEN_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"
directionstring(DataTransformationDefinitionDirectionParam)

Direction of the Data Transformation Definition. Does not prevent usage of reverse transformation. This field is used by Transformation-aware endpoints to determine whether to use normal or reversed definition.

Enum ValueDescription
INBOUND

Indicates that target attributes correspond the the CDQ data model.

OUTBOUND

Indicates that source attributes correspond the the CDQ data model.

Example: "INBOUND"
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: "2020-08-31T16:47+00:00"
modifiedBystring(ModifiedBy)

User or Client UUID which modified the resource.

Example: "76248934691294444"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
Response
application/json
{
  "imports": [
    { … }
  ],
  "name": "My DTD",
  "direction": "INBOUND",
  "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": "2020-08-31T16:47+00:00",
  "modifiedBy": "76248934691294444",
  "modifiedAt": "2020-08-31T16:47+00:00"
}

Read Data Transformation Definition

Request

Read Data Transformation Definition.

Security
oAuth2
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://idp.cdq.com/_mock/apis/transformation-api/api-v1/datatransformationdefinitions/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'Authorization: Bearer <YOUR_TOKEN_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"
directionstring(DataTransformationDefinitionDirectionParam)

Direction of the Data Transformation Definition. Does not prevent usage of reverse transformation. This field is used by Transformation-aware endpoints to determine whether to use normal or reversed definition.

Enum ValueDescription
INBOUND

Indicates that target attributes correspond the the CDQ data model.

OUTBOUND

Indicates that source attributes correspond the the CDQ data model.

Example: "INBOUND"
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: "2020-08-31T16:47+00:00"
modifiedBystring(ModifiedBy)

User or Client UUID which modified the resource.

Example: "76248934691294444"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
customTransformationsArray of objects(CustomTransformation)

Custom transformation in python or javascript code.

The code must define a function "transform" with one parameter "raw_data" of type string. The function must return either:

  • a string
  • a json object (dict in python, JSON object literal in javascript).

When returning a json object, it must follow the following structure:

{
  "targetAttributePath": "value",
  "targetAttributePath2": "value2"
  "targetAttributePath3": null // Null (e.g., None, undefined) values are ignored
}

If sourceAttribute is a list, then the raw_data parameter will contain a serialized json array of strings. For example, if sourceAttribute points to ["address.line1", "address.line2"], then raw_data will be "["address.line1","address.line2"]" rather than an array of strings.

The simplest transformation looks as follows:

def transform(raw_data):
    return raw_data

To make some operation on json following code should be applied:

import json

def transform(raw_data):
    json_result = json.loads(raw_data)
    return json_result["address"]

The method def transform(raw_data) must always be provided. Feature is experimental and limited to CDQ organizations.

Enable this transformation by setting transformation type in targetTransformations to CUSTOM_TRANSFORMATION and fill transformationName with the name of the custom transformation.

Response
application/json
{
  "imports": [
    { … }
  ],
  "name": "My DTD",
  "direction": "INBOUND",
  "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": "2020-08-31T16:47+00:00",
  "modifiedBy": "76248934691294444",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "customTransformations": [
    { … }
  ]
}

Update Data Transformation Definition

Request

Update Data Transformation Definition.

Security
oAuth2
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"
directionstring(DataTransformationDefinitionDirectionParam)

Direction of the Data Transformation Definition. Does not prevent usage of reverse transformation. This field is used by Transformation-aware endpoints to determine whether to use normal or reversed definition.

Enum ValueDescription
INBOUND

Indicates that target attributes correspond the the CDQ data model.

OUTBOUND

Indicates that source attributes correspond the the CDQ data model.

Example: "INBOUND"
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.

customTransformationsArray of objects(CustomTransformation)

Custom transformation in python or javascript code.

The code must define a function "transform" with one parameter "raw_data" of type string. The function must return either:

  • a string
  • a json object (dict in python, JSON object literal in javascript).

When returning a json object, it must follow the following structure:

{
  "targetAttributePath": "value",
  "targetAttributePath2": "value2"
  "targetAttributePath3": null // Null (e.g., None, undefined) values are ignored
}

If sourceAttribute is a list, then the raw_data parameter will contain a serialized json array of strings. For example, if sourceAttribute points to ["address.line1", "address.line2"], then raw_data will be "["address.line1","address.line2"]" rather than an array of strings.

The simplest transformation looks as follows:

def transform(raw_data):
    return raw_data

To make some operation on json following code should be applied:

import json

def transform(raw_data):
    json_result = json.loads(raw_data)
    return json_result["address"]

The method def transform(raw_data) must always be provided. Feature is experimental and limited to CDQ organizations.

Enable this transformation by setting transformation type in targetTransformations to CUSTOM_TRANSFORMATION and fill transformationName with the name of the custom transformation.

curl -i -X PUT \
  https://idp.cdq.com/_mock/apis/transformation-api/api-v1/datatransformationdefinitions/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "imports": [
      {
        "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
      }
    ],
    "name": "My DTD",
    "direction": "INBOUND",
    "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"
      }
    ],
    "customTransformations": [
      {
        "name": "Code above.",
        "code": "Code above.",
        "language": "python"
      }
    ]
  }'

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"
directionstring(DataTransformationDefinitionDirectionParam)

Direction of the Data Transformation Definition. Does not prevent usage of reverse transformation. This field is used by Transformation-aware endpoints to determine whether to use normal or reversed definition.

Enum ValueDescription
INBOUND

Indicates that target attributes correspond the the CDQ data model.

OUTBOUND

Indicates that source attributes correspond the the CDQ data model.

Example: "INBOUND"
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: "2020-08-31T16:47+00:00"
modifiedBystring(ModifiedBy)

User or Client UUID which modified the resource.

Example: "76248934691294444"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
customTransformationsArray of objects(CustomTransformation)

Custom transformation in python or javascript code.

The code must define a function "transform" with one parameter "raw_data" of type string. The function must return either:

  • a string
  • a json object (dict in python, JSON object literal in javascript).

When returning a json object, it must follow the following structure:

{
  "targetAttributePath": "value",
  "targetAttributePath2": "value2"
  "targetAttributePath3": null // Null (e.g., None, undefined) values are ignored
}

If sourceAttribute is a list, then the raw_data parameter will contain a serialized json array of strings. For example, if sourceAttribute points to ["address.line1", "address.line2"], then raw_data will be "["address.line1","address.line2"]" rather than an array of strings.

The simplest transformation looks as follows:

def transform(raw_data):
    return raw_data

To make some operation on json following code should be applied:

import json

def transform(raw_data):
    json_result = json.loads(raw_data)
    return json_result["address"]

The method def transform(raw_data) must always be provided. Feature is experimental and limited to CDQ organizations.

Enable this transformation by setting transformation type in targetTransformations to CUSTOM_TRANSFORMATION and fill transformationName with the name of the custom transformation.

Response
application/json
{
  "imports": [
    { … }
  ],
  "name": "My DTD",
  "direction": "INBOUND",
  "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": "2020-08-31T16:47+00:00",
  "modifiedBy": "76248934691294444",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "customTransformations": [
    { … }
  ]
}

Delete Data Transformation Definition

Request

Delete Data Transformation Definition.

Security
oAuth2
Path
idstringrequired

ID of the data transformation definition.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
curl -i -X DELETE \
  https://idp.cdq.com/_mock/apis/transformation-api/api-v1/datatransformationdefinitions/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'Authorization: Bearer <YOUR_TOKEN_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 Data Transformation Definition

Request

Read Data Transformation Definition.

Security
oAuth2
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://idp.cdq.com/_mock/apis/transformation-api/api-v1/public/datatransformationdefinitions/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'Authorization: Bearer <YOUR_TOKEN_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"
directionstring(DataTransformationDefinitionDirectionParam)

Direction of the Data Transformation Definition. Does not prevent usage of reverse transformation. This field is used by Transformation-aware endpoints to determine whether to use normal or reversed definition.

Enum ValueDescription
INBOUND

Indicates that target attributes correspond the the CDQ data model.

OUTBOUND

Indicates that source attributes correspond the the CDQ data model.

Example: "INBOUND"
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: "2020-08-31T16:47+00:00"
modifiedBystring(ModifiedBy)

User or Client UUID which modified the resource.

Example: "76248934691294444"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
Response
application/json
{
  "imports": [
    { … }
  ],
  "name": "My DTD",
  "direction": "INBOUND",
  "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": "2020-08-31T16:47+00:00",
  "modifiedBy": "76248934691294444",
  "modifiedAt": "2020-08-31T16:47+00:00"
}

Update Data Transformation Definition

Request

Update Data Transformation Definition.

Security
oAuth2
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"
directionstring(DataTransformationDefinitionDirectionParam)

Direction of the Data Transformation Definition. Does not prevent usage of reverse transformation. This field is used by Transformation-aware endpoints to determine whether to use normal or reversed definition.

Enum ValueDescription
INBOUND

Indicates that target attributes correspond the the CDQ data model.

OUTBOUND

Indicates that source attributes correspond the the CDQ data model.

Example: "INBOUND"
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://idp.cdq.com/_mock/apis/transformation-api/api-v1/public/datatransformationdefinitions/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "imports": [
      {
        "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
      }
    ],
    "name": "My DTD",
    "direction": "INBOUND",
    "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"
directionstring(DataTransformationDefinitionDirectionParam)

Direction of the Data Transformation Definition. Does not prevent usage of reverse transformation. This field is used by Transformation-aware endpoints to determine whether to use normal or reversed definition.

Enum ValueDescription
INBOUND

Indicates that target attributes correspond the the CDQ data model.

OUTBOUND

Indicates that source attributes correspond the the CDQ data model.

Example: "INBOUND"
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: "2020-08-31T16:47+00:00"
modifiedBystring(ModifiedBy)

User or Client UUID which modified the resource.

Example: "76248934691294444"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
Response
application/json
{
  "imports": [
    { … }
  ],
  "name": "My DTD",
  "direction": "INBOUND",
  "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": "2020-08-31T16:47+00:00",
  "modifiedBy": "76248934691294444",
  "modifiedAt": "2020-08-31T16:47+00:00"
}

Delete Data Transformation Definition

Request

Delete Data Transformation Definition.

Security
oAuth2
Path
idstringrequired

ID of the data transformation definition.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
curl -i -X DELETE \
  https://idp.cdq.com/_mock/apis/transformation-api/api-v1/public/datatransformationdefinitions/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'Authorization: Bearer <YOUR_TOKEN_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
oAuth2
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://idp.cdq.com/_mock/apis/transformation-api/api-v1/datatransformationdefinitions/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4/versions/1 \
  -H 'Authorization: Bearer <YOUR_TOKEN_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"
directionstring(DataTransformationDefinitionDirectionParam)

Direction of the Data Transformation Definition. Does not prevent usage of reverse transformation. This field is used by Transformation-aware endpoints to determine whether to use normal or reversed definition.

Enum ValueDescription
INBOUND

Indicates that target attributes correspond the the CDQ data model.

OUTBOUND

Indicates that source attributes correspond the the CDQ data model.

Example: "INBOUND"
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.

customTransformationsArray of objects(CustomTransformation)

Custom transformation in python or javascript code.

The code must define a function "transform" with one parameter "raw_data" of type string. The function must return either:

  • a string
  • a json object (dict in python, JSON object literal in javascript).

When returning a json object, it must follow the following structure:

{
  "targetAttributePath": "value",
  "targetAttributePath2": "value2"
  "targetAttributePath3": null // Null (e.g., None, undefined) values are ignored
}

If sourceAttribute is a list, then the raw_data parameter will contain a serialized json array of strings. For example, if sourceAttribute points to ["address.line1", "address.line2"], then raw_data will be "["address.line1","address.line2"]" rather than an array of strings.

The simplest transformation looks as follows:

def transform(raw_data):
    return raw_data

To make some operation on json following code should be applied:

import json

def transform(raw_data):
    json_result = json.loads(raw_data)
    return json_result["address"]

The method def transform(raw_data) must always be provided. Feature is experimental and limited to CDQ organizations.

Enable this transformation by setting transformation type in targetTransformations to CUSTOM_TRANSFORMATION and fill transformationName with the name of the custom transformation.

idstring

Unique identifier of Data Transformation Definition version.

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

Unique identifier for a Data Transformation Definition.

Example: "SAP.ODM"
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: "2020-08-31T16:47+00:00"
Response
application/json
{
  "imports": [
    { … }
  ],
  "name": "My DTD",
  "direction": "INBOUND",
  "type": {
    "name": "BUSINESS_PARTNER",
    "technicalKey": "BUSINESS_PARTNER"
  },
  "mappings": [
    { … }
  ],
  "reverseMappings": [
    { … }
  ],
  "valueMappings": [
    { … }
  ],
  "values": [
    { … }
  ],
  "customTransformations": [
    { … }
  ],
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "dataTransformationDefinitionId": "SAP.ODM",
  "version": 1,
  "workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "createdBy": "76248934691294444",
  "createdAt": "2020-08-31T16:47+00:00"
}

Read specific version of Data Transformation Definition

Request

Read specific version of Data Transformation Definition.

Security
oAuth2
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://idp.cdq.com/_mock/apis/transformation-api/api-v1/public/datatransformationdefinitions/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4/versions/1 \
  -H 'Authorization: Bearer <YOUR_TOKEN_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"
directionstring(DataTransformationDefinitionDirectionParam)

Direction of the Data Transformation Definition. Does not prevent usage of reverse transformation. This field is used by Transformation-aware endpoints to determine whether to use normal or reversed definition.

Enum ValueDescription
INBOUND

Indicates that target attributes correspond the the CDQ data model.

OUTBOUND

Indicates that source attributes correspond the the CDQ data model.

Example: "INBOUND"
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: "2020-08-31T16:47+00:00"
Response
application/json
{
  "imports": [
    { … }
  ],
  "name": "My DTD",
  "direction": "INBOUND",
  "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": "2020-08-31T16:47+00:00"
}

Data Transformation Schemas

Data Transformation Schemas

Operations