Python SDK
from cognite.client.data_classes import TransformationWrite, TransformationDestination
from cognite.client.data_classes.transformations.common import ViewInfo, EdgeType, DataModelInfo
transformations = [
TransformationWrite(
external_id="transformation1",
name="transformation1",
ignore_null_fields=False,
destination=TransformationDestination.assets()
),
TransformationWrite(
external_id="transformation2",
name="transformation2",
ignore_null_fields=False,
destination=TransformationDestination.raw("myDatabase", "myTable")
),
TransformationWrite(
external_id="transformation3",
name="transformation3",
ignore_null_fields=False,
view = ViewInfo(space="TypeSpace", external_id="TypeExtId", version="version"),
destination=TransformationDestination.nodes(view, "InstanceSpace")
),
TransformationWrite(
external_id="transformation4",
name="transformation4",
ignore_null_fields=False,
view = ViewInfo(space="TypeSpace", external_id="TypeExtId", version="version"),
destination=TransformationDestination.edges(view, "InstanceSpace")
),
TransformationWrite(
external_id="transformation5",
name="transformation5",
ignore_null_fields=False,
edge_type = EdgeType(space="TypeSpace", external_id="TypeExtId"),
destination=TransformationDestination.edges(edge_type,"InstanceSpace")
),
TransformationWrite(
external_id="transformation6",
name="transformation6",
ignore_null_fields=False,
data_model = DataModelInfo(space="modelSpace", external_id="modelExternalId",version="modelVersion",destination_type="viewExternalId"),
destination=TransformationDestination.instances(data_model,"InstanceSpace")
),
TransformationWrite(
external_id="transformation7",
name="transformation7",
ignore_null_fields=False,
data_model = DataModelInfo(space="modelSpace", external_id="modelExternalId",version="modelVersion",destination_type="viewExternalId", destination_relationship_from_type="connectionPropertyName"),
destination=TransformationDestination.instances(data_model,"InstanceSpace")
),
]
res = client.transformations.create(transformations)
Transformation.Builder builder = Transformation.newBuilder()
.setName("TransformationTestSDK-")
.setQuery("select * from teste")
.setConflictMode("upsert")
.setIsPublic(true)
.setExternalId("TestSKD-")
.setIgnoreNullFields(true)
.setDataSetId(dataSetId)
.setDestination(Transformation.Destination.newBuilder()
.setType("raw")
.setDatabase("Test")
.setTable("Test")
.build()
);
List<Transformation> createdList = client.transformations().upsert(List.of(builder.build()));
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"name": "<string>",
"externalId": "my.known.id",
"ignoreNullFields": true,
"query": "<string>",
"destination": {},
"isPublic": true,
"dataSetId": 123,
"tags": [
"<string>"
]
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
name: '<string>',
externalId: 'my.known.id',
ignoreNullFields: true,
query: '<string>',
destination: {},
isPublic: true,
dataSetId: 123,
tags: ['<string>']
}
]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'items' => [
[
'name' => '<string>',
'externalId' => 'my.known.id',
'ignoreNullFields' => true,
'query' => '<string>',
'destination' => [
],
'isPublic' => true,
'dataSetId' => 123,
'tags' => [
'<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations"
payload := strings.NewReader("{\n \"items\": [\n {\n \"name\": \"<string>\",\n \"externalId\": \"my.known.id\",\n \"ignoreNullFields\": true,\n \"query\": \"<string>\",\n \"destination\": {},\n \"isPublic\": true,\n \"dataSetId\": 123,\n \"tags\": [\n \"<string>\"\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"name\": \"<string>\",\n \"externalId\": \"my.known.id\",\n \"ignoreNullFields\": true,\n \"query\": \"<string>\",\n \"destination\": {},\n \"isPublic\": true,\n \"dataSetId\": 123,\n \"tags\": [\n \"<string>\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"id": 123,
"name": "<string>",
"query": "<string>",
"destination": {},
"isPublic": true,
"createdTime": 123,
"lastUpdatedTime": 123,
"owner": "<string>",
"ownerIsCurrentUser": true,
"hasSourceOidcCredentials": true,
"hasDestinationOidcCredentials": true,
"externalId": "my.known.id",
"ignoreNullFields": true,
"blocked": {
"reason": "<string>",
"createdTime": 123
},
"sourceSession": {
"clientId": "<string>",
"sessionId": 123,
"projectName": "<string>"
},
"destinationSession": {
"clientId": "<string>",
"sessionId": 123,
"projectName": "<string>"
},
"lastFinishedJob": {
"id": 123,
"uuid": "<string>",
"transformationId": 123,
"transformationExternalId": "<string>",
"sourceProject": "<string>",
"destinationProject": "<string>",
"destination": {},
"query": "<string>",
"createdTime": 123,
"ignoreNullFields": true,
"startedTime": 123,
"finishedTime": 123,
"lastSeenTime": 123,
"error": "<string>"
},
"runningJob": {
"id": 123,
"uuid": "<string>",
"transformationId": 123,
"transformationExternalId": "<string>",
"sourceProject": "<string>",
"destinationProject": "<string>",
"destination": {},
"query": "<string>",
"createdTime": 123,
"ignoreNullFields": true,
"startedTime": 123,
"finishedTime": 123,
"lastSeenTime": 123,
"error": "<string>"
},
"schedule": {
"id": 123,
"externalId": "<string>",
"createdTime": 123,
"lastUpdatedTime": 123,
"interval": "0 0 * * *",
"isPaused": true
},
"dataSetId": 123,
"tags": [
"<string>"
]
}
]
}{
"error": {
"code": 123,
"message": "<string>",
"missing": [
{
"externalId": "my.known.id"
}
],
"duplicated": [
{
"externalId": "my.known.id"
}
]
}
}{
"error": {
"code": 123,
"message": "<string>",
"missing": [
{
"externalId": "my.known.id"
}
],
"duplicated": [
{
"externalId": "my.known.id"
}
]
}
}{
"error": {
"code": 123,
"message": "<string>",
"missing": [
{
"externalId": "my.known.id"
}
],
"duplicated": [
{
"externalId": "my.known.id"
}
]
}
}Create transformations
Required capabilities:
transformationsAcl:WRITE
Create a maximum of 1000 transformations per request.
POST
/
transformations
Python SDK
from cognite.client.data_classes import TransformationWrite, TransformationDestination
from cognite.client.data_classes.transformations.common import ViewInfo, EdgeType, DataModelInfo
transformations = [
TransformationWrite(
external_id="transformation1",
name="transformation1",
ignore_null_fields=False,
destination=TransformationDestination.assets()
),
TransformationWrite(
external_id="transformation2",
name="transformation2",
ignore_null_fields=False,
destination=TransformationDestination.raw("myDatabase", "myTable")
),
TransformationWrite(
external_id="transformation3",
name="transformation3",
ignore_null_fields=False,
view = ViewInfo(space="TypeSpace", external_id="TypeExtId", version="version"),
destination=TransformationDestination.nodes(view, "InstanceSpace")
),
TransformationWrite(
external_id="transformation4",
name="transformation4",
ignore_null_fields=False,
view = ViewInfo(space="TypeSpace", external_id="TypeExtId", version="version"),
destination=TransformationDestination.edges(view, "InstanceSpace")
),
TransformationWrite(
external_id="transformation5",
name="transformation5",
ignore_null_fields=False,
edge_type = EdgeType(space="TypeSpace", external_id="TypeExtId"),
destination=TransformationDestination.edges(edge_type,"InstanceSpace")
),
TransformationWrite(
external_id="transformation6",
name="transformation6",
ignore_null_fields=False,
data_model = DataModelInfo(space="modelSpace", external_id="modelExternalId",version="modelVersion",destination_type="viewExternalId"),
destination=TransformationDestination.instances(data_model,"InstanceSpace")
),
TransformationWrite(
external_id="transformation7",
name="transformation7",
ignore_null_fields=False,
data_model = DataModelInfo(space="modelSpace", external_id="modelExternalId",version="modelVersion",destination_type="viewExternalId", destination_relationship_from_type="connectionPropertyName"),
destination=TransformationDestination.instances(data_model,"InstanceSpace")
),
]
res = client.transformations.create(transformations)
Transformation.Builder builder = Transformation.newBuilder()
.setName("TransformationTestSDK-")
.setQuery("select * from teste")
.setConflictMode("upsert")
.setIsPublic(true)
.setExternalId("TestSKD-")
.setIgnoreNullFields(true)
.setDataSetId(dataSetId)
.setDestination(Transformation.Destination.newBuilder()
.setType("raw")
.setDatabase("Test")
.setTable("Test")
.build()
);
List<Transformation> createdList = client.transformations().upsert(List.of(builder.build()));
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"name": "<string>",
"externalId": "my.known.id",
"ignoreNullFields": true,
"query": "<string>",
"destination": {},
"isPublic": true,
"dataSetId": 123,
"tags": [
"<string>"
]
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
name: '<string>',
externalId: 'my.known.id',
ignoreNullFields: true,
query: '<string>',
destination: {},
isPublic: true,
dataSetId: 123,
tags: ['<string>']
}
]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'items' => [
[
'name' => '<string>',
'externalId' => 'my.known.id',
'ignoreNullFields' => true,
'query' => '<string>',
'destination' => [
],
'isPublic' => true,
'dataSetId' => 123,
'tags' => [
'<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations"
payload := strings.NewReader("{\n \"items\": [\n {\n \"name\": \"<string>\",\n \"externalId\": \"my.known.id\",\n \"ignoreNullFields\": true,\n \"query\": \"<string>\",\n \"destination\": {},\n \"isPublic\": true,\n \"dataSetId\": 123,\n \"tags\": [\n \"<string>\"\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"name\": \"<string>\",\n \"externalId\": \"my.known.id\",\n \"ignoreNullFields\": true,\n \"query\": \"<string>\",\n \"destination\": {},\n \"isPublic\": true,\n \"dataSetId\": 123,\n \"tags\": [\n \"<string>\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"id": 123,
"name": "<string>",
"query": "<string>",
"destination": {},
"isPublic": true,
"createdTime": 123,
"lastUpdatedTime": 123,
"owner": "<string>",
"ownerIsCurrentUser": true,
"hasSourceOidcCredentials": true,
"hasDestinationOidcCredentials": true,
"externalId": "my.known.id",
"ignoreNullFields": true,
"blocked": {
"reason": "<string>",
"createdTime": 123
},
"sourceSession": {
"clientId": "<string>",
"sessionId": 123,
"projectName": "<string>"
},
"destinationSession": {
"clientId": "<string>",
"sessionId": 123,
"projectName": "<string>"
},
"lastFinishedJob": {
"id": 123,
"uuid": "<string>",
"transformationId": 123,
"transformationExternalId": "<string>",
"sourceProject": "<string>",
"destinationProject": "<string>",
"destination": {},
"query": "<string>",
"createdTime": 123,
"ignoreNullFields": true,
"startedTime": 123,
"finishedTime": 123,
"lastSeenTime": 123,
"error": "<string>"
},
"runningJob": {
"id": 123,
"uuid": "<string>",
"transformationId": 123,
"transformationExternalId": "<string>",
"sourceProject": "<string>",
"destinationProject": "<string>",
"destination": {},
"query": "<string>",
"createdTime": 123,
"ignoreNullFields": true,
"startedTime": 123,
"finishedTime": 123,
"lastSeenTime": 123,
"error": "<string>"
},
"schedule": {
"id": 123,
"externalId": "<string>",
"createdTime": 123,
"lastUpdatedTime": 123,
"interval": "0 0 * * *",
"isPaused": true
},
"dataSetId": 123,
"tags": [
"<string>"
]
}
]
}{
"error": {
"code": 123,
"message": "<string>",
"missing": [
{
"externalId": "my.known.id"
}
],
"duplicated": [
{
"externalId": "my.known.id"
}
]
}
}{
"error": {
"code": 123,
"message": "<string>",
"missing": [
{
"externalId": "my.known.id"
}
],
"duplicated": [
{
"externalId": "my.known.id"
}
]
}
}{
"error": {
"code": 123,
"message": "<string>",
"missing": [
{
"externalId": "my.known.id"
}
],
"duplicated": [
{
"externalId": "my.known.id"
}
]
}
}Authorizations
oidc-tokenoauth2-client-credentialsoauth2-open-industrial-dataoauth2-auth-code
Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
Body
application/json
Maximum array length:
1000Show child attributes
Show child attributes
Response
Response with list of transformations.
Array of objects (Transformation).
Show child attributes
Show child attributes
Last modified on July 13, 2026
Was this page helpful?
⌘I