New: build custom CDF applications with Cognite Flows. Documentation · What's new.
const events = await client.events.update([{id: 123, update: {description: {set: 'New description'}}}]);{
"items": [
{
"id": 4503599627370496,
"lastUpdatedTime": 1730204346000,
"createdTime": 1730204346000,
"externalId": "my.known.id",
"dataSetId": 4503599627370496,
"startTime": 1730204346000,
"endTime": 1730204346000,
"type": "<string>",
"subtype": "<string>",
"description": "<string>",
"metadata": {},
"assetIds": [
4503599627370496
],
"source": "<string>"
}
]
}Required capabilities:
eventsAcl:WRITE
Updates events in the same project. This operation supports partial updates; Fields omitted from queries will remain unchanged on objects.
For primitive fields (String, Long, Int), use ‘set’: ‘value’ to update value; use ‘setNull’: true to set that field to null.
For the Json Array field (e.g. assetIds), use ‘set’: [value1, value2] to update value; use ‘add’: [v1, v2] to add values to current list of values; use ‘remove’: [v1, v2] to remove these values from current list of values if exists.
A maximum of 1000 events can be updated per request, and all of the event IDs must be unique.
Request throttling
This endpoint is a subject of the new throttling schema (limited request rate and concurrency). Please check Events resource description for more information.
const events = await client.events.update([{id: 123, update: {description: {set: 'New description'}}}]);{
"items": [
{
"id": 4503599627370496,
"lastUpdatedTime": 1730204346000,
"createdTime": 1730204346000,
"externalId": "my.known.id",
"dataSetId": 4503599627370496,
"startTime": 1730204346000,
"endTime": 1730204346000,
"type": "<string>",
"subtype": "<string>",
"description": "<string>",
"metadata": {},
"assetIds": [
4503599627370496
],
"source": "<string>"
}
]
}Documentation Index
Fetch the complete documentation index at: https://docs.cognite.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
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
List of changes. A maximum of 1000 events can be updated per request, and all of the event IDs must be unique.
1 - 1000 elementsChanges will be applied to event.
- Option 1
- Option 2
Show child attributes
Show child attributes
Response
Paged response with list of events
Show child attributes
Show child attributes
Was this page helpful?