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

Data Transformation Schemas

Data Transformation Schemas

Operations

Create Data Transformation Schema

Request

Create Data Transformation Schema with provided json schema.

Security
oAuth2
Bodyapplication/json
jsonSchemaobject

Validation schema in json format.

namestring(DataTransformationSchemaName)

Name of the json schema validation.

Example: "My schema"
curl -i -X POST \
  https://idp.cdq.com/_mock/apis/transformation-api/api-v1/public/datatransformationschemas \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "jsonSchema": {},
    "name": "My schema"
  }'

Responses

OK

Bodyapplication/json
jsonSchemaobject

Validation schema in json format.

namestring(DataTransformationSchemaName)

Name of the json schema validation.

Example: "My schema"
idstring(DataTransformationSchemaId)

ID of the json validation schema.

Example: "66432427ba96dd27add2ea34"
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
{
  "jsonSchema": {},
  "name": "My schema",
  "id": "66432427ba96dd27add2ea34",
  "createdBy": "76248934691294444",
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedBy": "76248934691294444",
  "modifiedAt": "2020-08-31T16:47+00:00"
}

List Data Transformation Schemas

Request

List Data Transformation Schemas.

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
curl -i -X GET \
  https://idp.cdq.com/_mock/apis/transformation-api/api-v1/public/datatransformationschemas \
  -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(DataTransformationSchemaSearchResult)

List of data transformation validation schemas.

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

Read Data Transformation Schema

Request

Read Data Transformation Schema.

Security
oAuth2
Path
idstringrequired

ID of the data transformation schema.

Example: 66432427ba96dd27add2ea34
curl -i -X GET \
  https://idp.cdq.com/_mock/apis/transformation-api/api-v1/public/datatransformationschemas/66432427ba96dd27add2ea34 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
jsonSchemaobject

Validation schema in json format.

namestring(DataTransformationSchemaName)

Name of the json schema validation.

Example: "My schema"
idstring(DataTransformationSchemaId)

ID of the json validation schema.

Example: "66432427ba96dd27add2ea34"
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
{
  "jsonSchema": {},
  "name": "My schema",
  "id": "66432427ba96dd27add2ea34",
  "createdBy": "76248934691294444",
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedBy": "76248934691294444",
  "modifiedAt": "2020-08-31T16:47+00:00"
}

Update Data Transformation Schema

Request

Update Data Transformation Schema.

Security
oAuth2
Path
idstringrequired

ID of the data transformation schema.

Example: 66432427ba96dd27add2ea34
Bodyapplication/jsonrequired
jsonSchemaobject

Validation schema in json format.

namestring(DataTransformationSchemaName)

Name of the json schema validation.

Example: "My schema"
curl -i -X PUT \
  https://idp.cdq.com/_mock/apis/transformation-api/api-v1/public/datatransformationschemas/66432427ba96dd27add2ea34 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "jsonSchema": {},
    "name": "My schema"
  }'

Responses

OK

Bodyapplication/json
jsonSchemaobject

Validation schema in json format.

namestring(DataTransformationSchemaName)

Name of the json schema validation.

Example: "My schema"
idstring(DataTransformationSchemaId)

ID of the json validation schema.

Example: "66432427ba96dd27add2ea34"
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
{
  "jsonSchema": {},
  "name": "My schema",
  "id": "66432427ba96dd27add2ea34",
  "createdBy": "76248934691294444",
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedBy": "76248934691294444",
  "modifiedAt": "2020-08-31T16:47+00:00"
}

Delete Data Transformation Schema

Request

Delete Data Transformation Schema.

Security
oAuth2
Path
idstringrequired

ID of the data transformation schema.

Example: 66432427ba96dd27add2ea34
curl -i -X DELETE \
  https://idp.cdq.com/_mock/apis/transformation-api/api-v1/public/datatransformationschemas/66432427ba96dd27add2ea34 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
idstring(DataTransformationSchemaId)

ID of the json validation schema.

Example: "66432427ba96dd27add2ea34"
Response
application/json
{
  "id": "66432427ba96dd27add2ea34"
}

Delete Data Transformation Schema

Request

Delete Data Transformation Schema.

Security
oAuth2
Path
namestringrequired

Name of the json validation schema.

Example: BUSINESS_PARTNER_SCHEMA
curl -i -X DELETE \
  https://idp.cdq.com/_mock/apis/transformation-api/api-v1/datatransformationschemas/BUSINESS_PARTNER_SCHEMA/delete \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
idstring(DataTransformationSchemaId)

ID of the json validation schema.

Example: "66432427ba96dd27add2ea34"
Response
application/json
{
  "id": "66432427ba96dd27add2ea34"
}

Create Data Transformation SchemaDeprecated

Request

Create Data Transformation Schema with provided json schema.

Security
oAuth2
Bodyapplication/json
jsonSchemaobject

Validation schema in json format.

namestring(DataTransformationSchemaName)

Name of the json schema validation.

Example: "My schema"
curl -i -X POST \
  https://idp.cdq.com/_mock/apis/transformation-api/api-v1/datatransformationschemas \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "jsonSchema": {},
    "name": "My schema"
  }'

Responses

OK

Bodyapplication/json
jsonSchemaobject

Validation schema in json format.

namestring(DataTransformationSchemaName)

Name of the json schema validation.

Example: "My schema"
idstring(DataTransformationSchemaId)

ID of the json validation schema.

Example: "66432427ba96dd27add2ea34"
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
{
  "jsonSchema": {},
  "name": "My schema",
  "id": "66432427ba96dd27add2ea34",
  "createdBy": "76248934691294444",
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedBy": "76248934691294444",
  "modifiedAt": "2020-08-31T16:47+00:00"
}

List Data Transformation SchemasDeprecated

Request

List Data Transformation Schemas.

Security
oAuth2
Query
pageinteger

the page number

Default 0
Example: page=2
pageSizeinteger

number of entries in a page

Default 10
Example: pageSize=50
curl -i -X GET \
  https://idp.cdq.com/_mock/apis/transformation-api/api-v1/datatransformationschemas \
  -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(DataTransformationSchema)

List of data transformation validation schemas.

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

Read Data Transformation SchemaDeprecated

Request

Read Data Transformation Schema.

Security
oAuth2
Path
idstringrequired

ID of the data transformation schema.

Example: 66432427ba96dd27add2ea34
curl -i -X GET \
  https://idp.cdq.com/_mock/apis/transformation-api/api-v1/datatransformationschemas/66432427ba96dd27add2ea34 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
jsonSchemaobject

Validation schema in json format.

namestring(DataTransformationSchemaName)

Name of the json schema validation.

Example: "My schema"
idstring(DataTransformationSchemaId)

ID of the json validation schema.

Example: "66432427ba96dd27add2ea34"
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
{
  "jsonSchema": {},
  "name": "My schema",
  "id": "66432427ba96dd27add2ea34",
  "createdBy": "76248934691294444",
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedBy": "76248934691294444",
  "modifiedAt": "2020-08-31T16:47+00:00"
}

Update Data Transformation SchemaDeprecated

Request

Update Data Transformation Schema.

Security
oAuth2
Path
idstringrequired

ID of the data transformation schema.

Example: 66432427ba96dd27add2ea34
Bodyapplication/jsonrequired
jsonSchemaobject

Validation schema in json format.

namestring(DataTransformationSchemaName)

Name of the json schema validation.

Example: "My schema"
curl -i -X PUT \
  https://idp.cdq.com/_mock/apis/transformation-api/api-v1/datatransformationschemas/66432427ba96dd27add2ea34 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "jsonSchema": {},
    "name": "My schema"
  }'

Responses

OK

Bodyapplication/json
jsonSchemaobject

Validation schema in json format.

namestring(DataTransformationSchemaName)

Name of the json schema validation.

Example: "My schema"
idstring(DataTransformationSchemaId)

ID of the json validation schema.

Example: "66432427ba96dd27add2ea34"
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
{
  "jsonSchema": {},
  "name": "My schema",
  "id": "66432427ba96dd27add2ea34",
  "createdBy": "76248934691294444",
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedBy": "76248934691294444",
  "modifiedAt": "2020-08-31T16:47+00:00"
}

Delete Data Transformation SchemaDeprecated

Request

Delete Data Transformation Schema.

Security
oAuth2
Path
idstringrequired

ID of the data transformation schema.

Example: 66432427ba96dd27add2ea34
curl -i -X DELETE \
  https://idp.cdq.com/_mock/apis/transformation-api/api-v1/datatransformationschemas/66432427ba96dd27add2ea34 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
idstring(DataTransformationSchemaId)

ID of the json validation schema.

Example: "66432427ba96dd27add2ea34"
Response
application/json
{
  "id": "66432427ba96dd27add2ea34"
}