JavaScript SDK
const [updatedSequence] = await client.sequences.update([{id: 123, update: {name: {set: 'New name'}}}]);res = client.sequences.retrieve(id=1)
res.description = "New description"
res = client.sequences.update(res)
from cognite.client.data_classes import SequenceUpdate
my_update = SequenceUpdate(id=1).description.set("New description").metadata.add({"key": "value"})
res = client.sequences.update(my_update)
from cognite.client.data_classes import SequenceUpdate, SequenceColumn
my_update = SequenceUpdate(id=1).columns.add(SequenceColumn(value_type ="String",external_id="user", description ="some description"))
res = client.sequences.update(my_update)
from cognite.client.data_classes import SequenceUpdate, SequenceColumn
column_def = [
SequenceColumn(value_type ="String",external_id="user", description ="some description"),
SequenceColumn(value_type="Double", external_id="amount")]
my_update = SequenceUpdate(id=1).columns.add(column_def)
res = client.sequences.update(my_update)
from cognite.client.data_classes import SequenceUpdate
my_update = SequenceUpdate(id=1).columns.remove("col_external_id1")
res = client.sequences.update(my_update)
from cognite.client.data_classes import SequenceUpdate
my_update = SequenceUpdate(id=1).columns.remove(["col_external_id1","col_external_id2"])
res = client.sequences.update(my_update)
from cognite.client.data_classes import SequenceUpdate, SequenceColumnUpdate
column_updates = [
SequenceColumnUpdate(external_id="col_external_id_1").external_id.set("new_col_external_id"),
SequenceColumnUpdate(external_id="col_external_id_2").description.set("my new description"),
]
my_update = SequenceUpdate(id=1).columns.modify(column_updates)
res = client.sequences.update(my_update)client.sequences().upsert(upsertSequencesList);curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/sequences/update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"update": {
"name": {
"set": "<string>"
},
"description": {
"set": "<string>"
},
"assetId": {
"set": 123
},
"externalId": {
"set": "<string>"
},
"metadata": {
"set": {
"key1": "value1",
"key2": "value2"
}
},
"dataSetId": {
"set": 123
},
"columns": {
"modify": [
{
"externalId": "my.known.id",
"update": {
"description": {
"set": "<string>"
},
"name": {
"set": "<string>"
},
"metadata": {
"set": {
"key1": "value1",
"key2": "value2"
}
}
}
}
],
"add": [
{
"externalId": "DPS1",
"name": "depth",
"description": "Optional description",
"valueType": "DOUBLE",
"metadata": {
"extracted-by": "cognite"
}
}
],
"remove": [
{
"externalId": "my.known.id"
}
]
}
},
"id": 4503599627370496
}
]
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/sequences/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' => [
'name' => [
'set' => '<string>'
],
'description' => [
'set' => '<string>'
],
'assetId' => [
'set' => 123
],
'externalId' => [
'set' => '<string>'
],
'metadata' => [
'set' => [
'key1' => 'value1',
'key2' => 'value2'
]
],
'dataSetId' => [
'set' => 123
],
'columns' => [
'modify' => [
[
'externalId' => 'my.known.id',
'update' => [
'description' => [
'set' => '<string>'
],
'name' => [
'set' => '<string>'
],
'metadata' => [
'set' => [
'key1' => 'value1',
'key2' => 'value2'
]
]
]
]
],
'add' => [
[
'externalId' => 'DPS1',
'name' => 'depth',
'description' => 'Optional description',
'valueType' => 'DOUBLE',
'metadata' => [
'extracted-by' => 'cognite'
]
]
],
'remove' => [
[
'externalId' => 'my.known.id'
]
]
]
],
'id' => 4503599627370496
]
]
]),
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}/sequences/update"
payload := strings.NewReader("{\n \"items\": [\n {\n \"update\": {\n \"name\": {\n \"set\": \"<string>\"\n },\n \"description\": {\n \"set\": \"<string>\"\n },\n \"assetId\": {\n \"set\": 123\n },\n \"externalId\": {\n \"set\": \"<string>\"\n },\n \"metadata\": {\n \"set\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n }\n },\n \"dataSetId\": {\n \"set\": 123\n },\n \"columns\": {\n \"modify\": [\n {\n \"externalId\": \"my.known.id\",\n \"update\": {\n \"description\": {\n \"set\": \"<string>\"\n },\n \"name\": {\n \"set\": \"<string>\"\n },\n \"metadata\": {\n \"set\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n }\n }\n }\n }\n ],\n \"add\": [\n {\n \"externalId\": \"DPS1\",\n \"name\": \"depth\",\n \"description\": \"Optional description\",\n \"valueType\": \"DOUBLE\",\n \"metadata\": {\n \"extracted-by\": \"cognite\"\n }\n }\n ],\n \"remove\": [\n {\n \"externalId\": \"my.known.id\"\n }\n ]\n }\n },\n \"id\": 4503599627370496\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}/sequences/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 \"name\": {\n \"set\": \"<string>\"\n },\n \"description\": {\n \"set\": \"<string>\"\n },\n \"assetId\": {\n \"set\": 123\n },\n \"externalId\": {\n \"set\": \"<string>\"\n },\n \"metadata\": {\n \"set\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n }\n },\n \"dataSetId\": {\n \"set\": 123\n },\n \"columns\": {\n \"modify\": [\n {\n \"externalId\": \"my.known.id\",\n \"update\": {\n \"description\": {\n \"set\": \"<string>\"\n },\n \"name\": {\n \"set\": \"<string>\"\n },\n \"metadata\": {\n \"set\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n }\n }\n }\n }\n ],\n \"add\": [\n {\n \"externalId\": \"DPS1\",\n \"name\": \"depth\",\n \"description\": \"Optional description\",\n \"valueType\": \"DOUBLE\",\n \"metadata\": {\n \"extracted-by\": \"cognite\"\n }\n }\n ],\n \"remove\": [\n {\n \"externalId\": \"my.known.id\"\n }\n ]\n }\n },\n \"id\": 4503599627370496\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"id": 1,
"columns": [
{
"valueType": "DOUBLE",
"createdTime": 100000000000,
"lastUpdatedTime": 100000000000,
"name": "depth",
"externalId": "DPS1",
"description": "Optional description",
"metadata": {
"extracted-by": "cognite"
}
}
],
"createdTime": 100000000000,
"lastUpdatedTime": 100000000000,
"name": "Any relevant name",
"description": "Optional description",
"assetId": 1221123111,
"externalId": "my.known.id",
"metadata": {
"extracted-by": "cognite"
},
"dataSetId": 2718281828459
}
]
}Required capabilities:
sequencesAcl:WRITE
Updates one or more sequences. Fields outside of the request remain unchanged.
POST
/
sequences
/
update
JavaScript SDK
const [updatedSequence] = await client.sequences.update([{id: 123, update: {name: {set: 'New name'}}}]);res = client.sequences.retrieve(id=1)
res.description = "New description"
res = client.sequences.update(res)
from cognite.client.data_classes import SequenceUpdate
my_update = SequenceUpdate(id=1).description.set("New description").metadata.add({"key": "value"})
res = client.sequences.update(my_update)
from cognite.client.data_classes import SequenceUpdate, SequenceColumn
my_update = SequenceUpdate(id=1).columns.add(SequenceColumn(value_type ="String",external_id="user", description ="some description"))
res = client.sequences.update(my_update)
from cognite.client.data_classes import SequenceUpdate, SequenceColumn
column_def = [
SequenceColumn(value_type ="String",external_id="user", description ="some description"),
SequenceColumn(value_type="Double", external_id="amount")]
my_update = SequenceUpdate(id=1).columns.add(column_def)
res = client.sequences.update(my_update)
from cognite.client.data_classes import SequenceUpdate
my_update = SequenceUpdate(id=1).columns.remove("col_external_id1")
res = client.sequences.update(my_update)
from cognite.client.data_classes import SequenceUpdate
my_update = SequenceUpdate(id=1).columns.remove(["col_external_id1","col_external_id2"])
res = client.sequences.update(my_update)
from cognite.client.data_classes import SequenceUpdate, SequenceColumnUpdate
column_updates = [
SequenceColumnUpdate(external_id="col_external_id_1").external_id.set("new_col_external_id"),
SequenceColumnUpdate(external_id="col_external_id_2").description.set("my new description"),
]
my_update = SequenceUpdate(id=1).columns.modify(column_updates)
res = client.sequences.update(my_update)client.sequences().upsert(upsertSequencesList);curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/sequences/update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"update": {
"name": {
"set": "<string>"
},
"description": {
"set": "<string>"
},
"assetId": {
"set": 123
},
"externalId": {
"set": "<string>"
},
"metadata": {
"set": {
"key1": "value1",
"key2": "value2"
}
},
"dataSetId": {
"set": 123
},
"columns": {
"modify": [
{
"externalId": "my.known.id",
"update": {
"description": {
"set": "<string>"
},
"name": {
"set": "<string>"
},
"metadata": {
"set": {
"key1": "value1",
"key2": "value2"
}
}
}
}
],
"add": [
{
"externalId": "DPS1",
"name": "depth",
"description": "Optional description",
"valueType": "DOUBLE",
"metadata": {
"extracted-by": "cognite"
}
}
],
"remove": [
{
"externalId": "my.known.id"
}
]
}
},
"id": 4503599627370496
}
]
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/sequences/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' => [
'name' => [
'set' => '<string>'
],
'description' => [
'set' => '<string>'
],
'assetId' => [
'set' => 123
],
'externalId' => [
'set' => '<string>'
],
'metadata' => [
'set' => [
'key1' => 'value1',
'key2' => 'value2'
]
],
'dataSetId' => [
'set' => 123
],
'columns' => [
'modify' => [
[
'externalId' => 'my.known.id',
'update' => [
'description' => [
'set' => '<string>'
],
'name' => [
'set' => '<string>'
],
'metadata' => [
'set' => [
'key1' => 'value1',
'key2' => 'value2'
]
]
]
]
],
'add' => [
[
'externalId' => 'DPS1',
'name' => 'depth',
'description' => 'Optional description',
'valueType' => 'DOUBLE',
'metadata' => [
'extracted-by' => 'cognite'
]
]
],
'remove' => [
[
'externalId' => 'my.known.id'
]
]
]
],
'id' => 4503599627370496
]
]
]),
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}/sequences/update"
payload := strings.NewReader("{\n \"items\": [\n {\n \"update\": {\n \"name\": {\n \"set\": \"<string>\"\n },\n \"description\": {\n \"set\": \"<string>\"\n },\n \"assetId\": {\n \"set\": 123\n },\n \"externalId\": {\n \"set\": \"<string>\"\n },\n \"metadata\": {\n \"set\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n }\n },\n \"dataSetId\": {\n \"set\": 123\n },\n \"columns\": {\n \"modify\": [\n {\n \"externalId\": \"my.known.id\",\n \"update\": {\n \"description\": {\n \"set\": \"<string>\"\n },\n \"name\": {\n \"set\": \"<string>\"\n },\n \"metadata\": {\n \"set\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n }\n }\n }\n }\n ],\n \"add\": [\n {\n \"externalId\": \"DPS1\",\n \"name\": \"depth\",\n \"description\": \"Optional description\",\n \"valueType\": \"DOUBLE\",\n \"metadata\": {\n \"extracted-by\": \"cognite\"\n }\n }\n ],\n \"remove\": [\n {\n \"externalId\": \"my.known.id\"\n }\n ]\n }\n },\n \"id\": 4503599627370496\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}/sequences/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 \"name\": {\n \"set\": \"<string>\"\n },\n \"description\": {\n \"set\": \"<string>\"\n },\n \"assetId\": {\n \"set\": 123\n },\n \"externalId\": {\n \"set\": \"<string>\"\n },\n \"metadata\": {\n \"set\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n }\n },\n \"dataSetId\": {\n \"set\": 123\n },\n \"columns\": {\n \"modify\": [\n {\n \"externalId\": \"my.known.id\",\n \"update\": {\n \"description\": {\n \"set\": \"<string>\"\n },\n \"name\": {\n \"set\": \"<string>\"\n },\n \"metadata\": {\n \"set\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n }\n }\n }\n }\n ],\n \"add\": [\n {\n \"externalId\": \"DPS1\",\n \"name\": \"depth\",\n \"description\": \"Optional description\",\n \"valueType\": \"DOUBLE\",\n \"metadata\": {\n \"extracted-by\": \"cognite\"\n }\n }\n ],\n \"remove\": [\n {\n \"externalId\": \"my.known.id\"\n }\n ]\n }\n },\n \"id\": 4503599627370496\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"id": 1,
"columns": [
{
"valueType": "DOUBLE",
"createdTime": 100000000000,
"lastUpdatedTime": 100000000000,
"name": "depth",
"externalId": "DPS1",
"description": "Optional description",
"metadata": {
"extracted-by": "cognite"
}
}
],
"createdTime": 100000000000,
"lastUpdatedTime": 100000000000,
"name": "Any relevant name",
"description": "Optional description",
"assetId": 1221123111,
"externalId": "my.known.id",
"metadata": {
"extracted-by": "cognite"
},
"dataSetId": 2718281828459
}
]
}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
Patch definition
Required array length:
1 - 1000 elements- Select by Id
- Select by ExternalId
Show child attributes
Show child attributes
Response
200 - application/json
Response with the updated sequences.
Show child attributes
Show child attributes
Last modified on July 10, 2026
Was this page helpful?
⌘I