Cognite Data Fusion API

Update subscriptions

Updates one or more subscriptions. Fields that are not included in the request, are not changed.

If both instanceIds and timeSeriesIds are set, they must either both be add/remove or both be set operations.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code

Request

Request Body schema: application/json
required

The subscriptions to update

required

Array of objects (Select by externalId) = 1 items

Responses

200

A list of subscriptions updated

post/timeseries/subscriptions/update

Request samples

Payload
Python SDK
curl

application/json

{"items": [{"externalId": "my.known.id",
"update": {"timeSeriesIds": {"add": ["my.known.id"
],
"remove": ["my.known.id"
]
},
"instanceIds": {"add": [{"space": "string",
"externalId": "string"
}
],
"remove": [{"space": "string",
"externalId": "string"
}
]
},
"name": {"set": "string"
},
"description": {"set": "string"
},
"dataSetId": {"set": 0
},
"filter": {"set": {"or": [{"not": {"and": [{"equals": {"property": ["metadata",
"manufacturer"
],
"value": "acme"
}
},
{"in": {"property": ["name"
],
"values": ["pump-1-temperature",
"motor-9-temperature"
]
}
},
{"range": {"property": ["dataSetId"
],
"gte": 1,
"lt": 10
}
}
]
}
},
{"and": [{"equals": {"property": ["assetId"
],
"value": 1234
}
},
{"equals": {"property": ["description"
],
"value": "Temperature in Celsius"
}
}
]
}
]
}
}
}
}
]
}

Response samples

application/json

{"items": [{"externalId": "my.known.id",
"name": "string",
"description": "string",
"dataSetId": 1,
"partitionCount": 1,
"timeSeriesCount": 0,
"filter": {"or": [{"not": {"and": [{"equals": {"property": ["metadata",
"manufacturer"
],
"value": "acme"
}
},
{"in": {"property": ["name"
],
"values": ["pump-1-temperature",
"motor-9-temperature"
]
}
},
{"range": {"property": ["dataSetId"
],
"gte": 1,
"lt": 10
}
}
]
}
},
{"and": [{"equals": {"property": ["assetId"
],
"value": 1234
}
},
{"equals": {"property": ["description"
],
"value": "Temperature in Celsius"
}
}
]
}
]
},
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000
}
]
}

➔ Next to Events

Update subscriptions

Request Body schema: application/jsonrequired

Request Body schema: application/json
required