const timeseries = await client.timeseries.update([{
id: 3785438579439,
update: {
name: { set: 'New name' }
}
}]);{
"items": [
{
"id": 4503599627370496,
"isString": true,
"type": "<string>",
"isStep": true,
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"externalId": "<string>",
"instanceId": {
"space": "<string>",
"externalId": "<string>"
},
"name": "<string>",
"metadata": {},
"unit": "<string>",
"unitExternalId": "<string>",
"assetId": 4503599627370496,
"description": "<string>",
"securityCategories": [
123
],
"dataSetId": 4503599627370496
}
]
}Required capabilities:
timeSeriesAcl:WRITE
Updates one or more time series. Fields outside of the request remain unchanged.
For primitive fields (those whose type is string, number, or boolean), use "set": value
to update the value; use "setNull": true to set the field to null.
For JSON array fields (for example securityCategories), use "set": [value1, value2] to
update the value; use "add": [value1, value2] to add values; use
"remove": [value1, value2] to remove values.
const timeseries = await client.timeseries.update([{
id: 3785438579439,
update: {
name: { set: 'New name' }
}
}]);{
"items": [
{
"id": 4503599627370496,
"isString": true,
"type": "<string>",
"isStep": true,
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"externalId": "<string>",
"instanceId": {
"space": "<string>",
"externalId": "<string>"
},
"name": "<string>",
"metadata": {},
"unit": "<string>",
"unitExternalId": "<string>",
"assetId": 4503599627370496,
"description": "<string>",
"securityCategories": [
123
],
"dataSetId": 4503599627370496
}
]
}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.
List of changes.
1 - 1000 elementsChanges will be applied to time series.
Show child attributes
Response with the corresponding time series after applying the updates.
List of responses. The order matches the requests order.
Show child attributes
Was this page helpful?