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

List Configurations

Request

List all Data Transformation Configurations.

Security
oAuth2
Query
limitinteger(Limit)

Number of items.

Example: limit=100
startAfterstring(StartAfter)

Start after the given id.

Example: startAfter=5712566172571652
defaultConfigurationboolean

Limit search to configurations with provided default flag value. If left empty, all configurations will be returned.

Default null
Example: defaultConfiguration=true
clientIdstring

API Key ID or Client ID. When present returns only configurations assigned to the given API key.

Example: clientId=12345678-1234-5678-1234-567812345678
curl -i -X GET \
  https://idp.cdq.com/_mock/apis/transformation-api/api-v1/configurations/datatransformation \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation

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(DataTransformationConfigurationSearchResult)

List of data transformation configurations.

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

Create Configuration

Request

Create new configuration for data transformation.

Security
oAuth2
Bodyapplication/json
transactionIdstring(TransactionId)

ID of the transaction, pass it in later requests to make them part of the transaction.

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
featuresOnArray of strings(TransactionFeaturesOn)

Features to be activated. Do not use CREATE_TRANSACTION and COMMIT_TRANSACTION at the same time.

Items Enum ValueDescription
CREATE_TRANSACTION

Creates a new transaction and makes the current request a part of it. By default turned off.

COMMIT_TRANSACTION

Commit transaction. By default turned off.

Example: ["CREATE_TRANSACTION"]
workspaceIdstring(WorkspaceId)

Uniquely identifying ID of the workspace.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."
configurationobject(TransformationConfigurationModel)

Transformation configuration model.

relatedConfigurationsArray of objects(RelatedConfiguration)<= 10 items

List of related configurations.

copiedFromobject(WorkspaceConfigurationCopiedFrom)

The configuration from which the new configuration is copied.

curl -i -X POST \
  https://idp.cdq.com/_mock/apis/transformation-api/api-v1/configurations/datatransformation \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2",
    "featuresOn": [
      "CREATE_TRANSACTION"
    ],
    "workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
    "name": "Client configuration.",
    "configuration": {
      "businessPartner": {
        "dataTransformationDefinitionId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
      },
      "updatedBusinessPartner": {
        "dataTransformationDefinitionId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
      }
    },
    "relatedConfigurations": [
      {
        "id": "a0200062daa56952a8640005",
        "owner": {
          "service": "reference-data-api",
          "path": "/public/configurations/businesspartnerlookup"
        }
      }
    ],
    "copiedFrom": {
      "configurationId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
      "workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
    }
  }'

Responses

Configuration created successfully

Bodyapplication/json
idstring(ConfigurationId)

Uniquely identifies a configuration.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."
versioninteger(VersionNumber)

Version number of the resource.

Example: 1
configurationobject(TransformationConfigurationModel)

Transformation configuration model.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
transactionIdstring(TransactionId)

ID of the transaction, pass it in later requests to make them part of the transaction.

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
relatedConfigurationsArray of objects(RelatedConfiguration)

List of related configurations.

Response
application/json
{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Client configuration.",
  "version": 1,
  "configuration": {
    "businessPartner": { … },
    "updatedBusinessPartner": { … }
  },
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2",
  "relatedConfigurations": [
    { … }
  ]
}

Read Configuration

Request

Read configuration by id.

Security
oAuth2
Path
configurationIdstring(ConfigurationId)required

Configuration id.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
curl -i -X GET \
  https://idp.cdq.com/_mock/apis/transformation-api/api-v1/configurations/datatransformation/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation

Bodyapplication/json
idstring(ConfigurationId)

Uniquely identifies a configuration.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."
versioninteger(VersionNumber)

Version number of the resource.

Example: 1
configurationobject(TransformationConfigurationModel)

Transformation configuration model.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
transactionIdstring(TransactionId)

ID of the transaction, pass it in later requests to make them part of the transaction.

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
relatedConfigurationsArray of objects(RelatedConfiguration)

List of related configurations.

Response
application/json
{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Client configuration.",
  "version": 1,
  "configuration": {
    "businessPartner": { … },
    "updatedBusinessPartner": { … }
  },
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2",
  "relatedConfigurations": [
    { … }
  ]
}

Update Configuration

Request

Update existing configuration by id.

Security
oAuth2
Path
configurationIdstring(ConfigurationId)required

Configuration id.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
Bodyapplication/json
transactionIdstring(TransactionId)

ID of the transaction, pass it in later requests to make them part of the transaction.

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
featuresOnArray of strings(TransactionFeaturesOn)

Features to be activated. Do not use CREATE_TRANSACTION and COMMIT_TRANSACTION at the same time.

Items Enum ValueDescription
CREATE_TRANSACTION

Creates a new transaction and makes the current request a part of it. By default turned off.

COMMIT_TRANSACTION

Commit transaction. By default turned off.

Example: ["CREATE_TRANSACTION"]
namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."
configurationobject(TransformationConfigurationModel)

Transformation configuration model.

curl -i -X PUT \
  https://idp.cdq.com/_mock/apis/transformation-api/api-v1/configurations/datatransformation/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2",
    "featuresOn": [
      "CREATE_TRANSACTION"
    ],
    "name": "Client configuration.",
    "configuration": {
      "businessPartner": {
        "dataTransformationDefinitionId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
      },
      "updatedBusinessPartner": {
        "dataTransformationDefinitionId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
      }
    }
  }'

Responses

Configuration updated successful

Bodyapplication/json
idstring(ConfigurationId)

Uniquely identifies a configuration.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."
versioninteger(VersionNumber)

Version number of the resource.

Example: 1
configurationobject(TransformationConfigurationModel)

Transformation configuration model.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
transactionIdstring(TransactionId)

ID of the transaction, pass it in later requests to make them part of the transaction.

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
relatedConfigurationsArray of objects(RelatedConfiguration)

List of related configurations.

Response
application/json
{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Client configuration.",
  "version": 1,
  "configuration": {
    "businessPartner": { … },
    "updatedBusinessPartner": { … }
  },
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2",
  "relatedConfigurations": [
    { … }
  ]
}

Delete Configuration

Request

Delete configuration.

Security
oAuth2
Path
configurationIdstring(ConfigurationId)required

Configuration id.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
Query
transactionIdstring(TransactionId)

ID of the transaction, pass it in later requests to make them part of the transaction.

Example: transactionId=8e37da1e-ee9d-4ee0-b03d-24a1f89988f2
featuresOnArray of strings(TransactionFeatureParam)

Features to be activated. Do not use CREATE_TRANSACTION and COMMIT_TRANSACTION at the same time.

Items Enum ValueDescription
CREATE_TRANSACTION

Creates a new transaction and makes the current request a part of it. By default turned off.

COMMIT_TRANSACTION

Commit transaction. By default turned off.

Example: featuresOn=CREATE_TRANSACTION
curl -i -X DELETE \
  https://idp.cdq.com/_mock/apis/transformation-api/api-v1/configurations/datatransformation/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK.

Bodyapplication/json
idstring(ConfigurationId)

Uniquely identifies a configuration.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."
versioninteger(VersionNumber)

Version number of the resource.

Example: 1
configurationobject(TransformationConfigurationModel)

Transformation configuration model.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
transactionIdstring(TransactionId)

ID of the transaction, pass it in later requests to make them part of the transaction.

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
relatedConfigurationsArray of objects(RelatedConfiguration)

List of related configurations.

Response
application/json
{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Client configuration.",
  "version": 1,
  "configuration": {
    "businessPartner": { … },
    "updatedBusinessPartner": { … }
  },
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2",
  "relatedConfigurations": [
    { … }
  ]
}

Read Data Transformation Configuration Version

Request

Read a specific version of a data transformation configuration by id and version number.

Security
oAuth2
Path
configurationIdstringrequired

ID of the configuration.

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

Version number of the configuration.

Example: 1
curl -i -X GET \
  https://idp.cdq.com/_mock/apis/transformation-api/api-v1/configurations/datatransformation/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4/versions/1 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation.

Bodyapplication/json
idstring

Unique identifier of the data transformation configuration version. Not to be confused with the configuration ID.

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

The name of the configuration

Example: "Configuration Name"
configurationIdstring(ConfigurationId)

Uniquely identifies a configuration.

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

Version number of the resource.

Example: 1
configurationobject(TransformationConfigurationModel)

Transformation configuration model.

createdAtstring

Date and time when the first version of the configuration was created (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
modifiedAtstring

Date and time when this version of the configuration was created (ISO 8601-compliant).

Example: "2020-08-22T13:45+00:00"
createdBystring

User who created the first version of the configuration.

Example: "69129435489347624"
modifiedBystring

User who created this version of the configuration.

Example: "76248934691294444"
Response
application/json
{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Configuration Name",
  "configurationId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "version": 1,
  "configuration": {
    "businessPartner": { … },
    "updatedBusinessPartner": { … }
  },
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-22T13:45+00:00",
  "createdBy": "69129435489347624",
  "modifiedBy": "76248934691294444"
}

Transformations

Transformations

Operations

Data Transformation Definitions

Data Transformation Definitions

Operations

Data Transformation Schemas

Data Transformation Schemas

Operations