Python SDK
transformation_schedule = client.transformations.schedules.retrieve(id=1)
transformation_schedule.is_paused = True
res = client.transformations.schedules.update(transformation_schedule)
from cognite.client.data_classes import TransformationScheduleUpdate
my_update = TransformationScheduleUpdate(id=1).interval.set("0 * * * *").is_paused.set(False)
res = client.transformations.schedules.update(my_update)
List<Transformation.Schedule> editedInput = List.of(Transformation.Schedule.newBuilder()
.setExternalId("10")
.setIsPaused(true)
.setInterval("*/10 * * * *")
.build());
List<Transformation.Schedule> updatedList =
client.transformations().schedules().schedule(editedInput);
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/schedules/update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"update": {},
"externalId": "my.known.id"
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({items: [{update: {}, externalId: 'my.known.id'}]})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/schedules/update', 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/update",
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' => [
[
'update' => [
],
'externalId' => 'my.known.id'
]
]
]),
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/update"
payload := strings.NewReader("{\n \"items\": [\n {\n \"update\": {},\n \"externalId\": \"my.known.id\"\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/schedules/update")
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 \"update\": {},\n \"externalId\": \"my.known.id\"\n }\n ]\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"
}
]
}
}Required capabilities:
transformationsAcl:WRITE
POST
/
transformations
/
schedules
/
update
Python SDK
transformation_schedule = client.transformations.schedules.retrieve(id=1)
transformation_schedule.is_paused = True
res = client.transformations.schedules.update(transformation_schedule)
from cognite.client.data_classes import TransformationScheduleUpdate
my_update = TransformationScheduleUpdate(id=1).interval.set("0 * * * *").is_paused.set(False)
res = client.transformations.schedules.update(my_update)
List<Transformation.Schedule> editedInput = List.of(Transformation.Schedule.newBuilder()
.setExternalId("10")
.setIsPaused(true)
.setInterval("*/10 * * * *")
.build());
List<Transformation.Schedule> updatedList =
client.transformations().schedules().schedule(editedInput);
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/schedules/update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"update": {},
"externalId": "my.known.id"
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({items: [{update: {}, externalId: 'my.known.id'}]})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/schedules/update', 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/update",
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' => [
[
'update' => [
],
'externalId' => 'my.known.id'
]
]
]),
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/update"
payload := strings.NewReader("{\n \"items\": [\n {\n \"update\": {},\n \"externalId\": \"my.known.id\"\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/schedules/update")
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 \"update\": {},\n \"externalId\": \"my.known.id\"\n }\n ]\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 schedule updates. Must be up to a maximum of 1000 items.
- Option 1
- Option 2
Show child attributes
Show child attributes
Response
Response with list of schedules.
Show child attributes
Show child attributes
Last modified on July 13, 2026
Was this page helpful?
⌘I