Python SDK
res = client.transformations.retrieve(id=1)
res = client.transformations.retrieve(external_id="1")
res = client.transformations.retrieve_multiple(ids=[1,2,3], external_ids=['transform-1','transform-2'])List<Item> byExternalIds = List.of(Item.newBuilder()
.setExternalId("10")
.build());
client.transformations().retrieve(byExternalIds);curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/byids \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"withJobDetails": true,
"items": [
{
"externalId": "my.known.id"
}
],
"ignoreUnknownIds": true
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
withJobDetails: true,
items: [{externalId: 'my.known.id'}],
ignoreUnknownIds: true
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/byids', 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/byids",
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([
'withJobDetails' => true,
'items' => [
[
'externalId' => 'my.known.id'
]
],
'ignoreUnknownIds' => true
]),
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/byids"
payload := strings.NewReader("{\n \"withJobDetails\": true,\n \"items\": [\n {\n \"externalId\": \"my.known.id\"\n }\n ],\n \"ignoreUnknownIds\": true\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/byids")
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 \"withJobDetails\": true,\n \"items\": [\n {\n \"externalId\": \"my.known.id\"\n }\n ],\n \"ignoreUnknownIds\": true\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"
}
]
}
}Retrieve transformations
Required capabilities:
transformationsAcl:READ
Retrieve a maximum of 1000 transformations by ids and externalIds per request.
POST
/
transformations
/
byids
Python SDK
res = client.transformations.retrieve(id=1)
res = client.transformations.retrieve(external_id="1")
res = client.transformations.retrieve_multiple(ids=[1,2,3], external_ids=['transform-1','transform-2'])List<Item> byExternalIds = List.of(Item.newBuilder()
.setExternalId("10")
.build());
client.transformations().retrieve(byExternalIds);curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/byids \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"withJobDetails": true,
"items": [
{
"externalId": "my.known.id"
}
],
"ignoreUnknownIds": true
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
withJobDetails: true,
items: [{externalId: 'my.known.id'}],
ignoreUnknownIds: true
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/byids', 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/byids",
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([
'withJobDetails' => true,
'items' => [
[
'externalId' => 'my.known.id'
]
],
'ignoreUnknownIds' => true
]),
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/byids"
payload := strings.NewReader("{\n \"withJobDetails\": true,\n \"items\": [\n {\n \"externalId\": \"my.known.id\"\n }\n ],\n \"ignoreUnknownIds\": true\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/byids")
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 \"withJobDetails\": true,\n \"items\": [\n {\n \"externalId\": \"my.known.id\"\n }\n ],\n \"ignoreUnknownIds\": true\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
All provided IDs and external IDs must be unique.
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