Python SDK
res = client.transformations.schedules.retrieve(id=1)
res = client.transformations.schedules.retrieve(external_id="1")
res = client.transformations.schedules.retrieve_multiple(ids=[1, 2, 3])
res = client.transformations.schedules.retrieve_multiple(external_ids=["t1", "t2"])List<Item> itemsToRetrieve = List.of(Item.newBuilder()
.setExternalId("10")
.build());
List<Transformation.Schedule> retrievedItems =
client.transformations().schedules().retrieve(itemsToRetrieve);curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/schedules/byids \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"externalId": "my.known.id"
}
],
"ignoreUnknownIds": true
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({items: [{externalId: 'my.known.id'}], ignoreUnknownIds: true})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/schedules/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/schedules/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([
'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/schedules/byids"
payload := strings.NewReader("{\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/schedules/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 \"items\": [\n {\n \"externalId\": \"my.known.id\"\n }\n ],\n \"ignoreUnknownIds\": true\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"id": 123,
"externalId": "<string>",
"createdTime": 123,
"lastUpdatedTime": 123,
"interval": "0 0 * * *",
"isPaused": true
}
]
}{
"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 schedules
Required capabilities:
transformationsAcl:READ
Retrieve transformation schedules by transformation IDs or external IDs.
POST
/
transformations
/
schedules
/
byids
Python SDK
res = client.transformations.schedules.retrieve(id=1)
res = client.transformations.schedules.retrieve(external_id="1")
res = client.transformations.schedules.retrieve_multiple(ids=[1, 2, 3])
res = client.transformations.schedules.retrieve_multiple(external_ids=["t1", "t2"])List<Item> itemsToRetrieve = List.of(Item.newBuilder()
.setExternalId("10")
.build());
List<Transformation.Schedule> retrievedItems =
client.transformations().schedules().retrieve(itemsToRetrieve);curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/schedules/byids \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"externalId": "my.known.id"
}
],
"ignoreUnknownIds": true
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({items: [{externalId: 'my.known.id'}], ignoreUnknownIds: true})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/schedules/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/schedules/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([
'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/schedules/byids"
payload := strings.NewReader("{\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/schedules/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 \"items\": [\n {\n \"externalId\": \"my.known.id\"\n }\n ],\n \"ignoreUnknownIds\": true\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"id": 123,
"externalId": "<string>",
"createdTime": 123,
"lastUpdatedTime": 123,
"interval": "0 0 * * *",
"isPaused": true
}
]
}{
"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
List of transformation IDs of schedules to retrieve. Must be up to a maximum of 1000 items and all of them must be unique.
Response
Response with list of schedules.
Show child attributes
Show child attributes
Last modified on July 10, 2026
Was this page helpful?
⌘I