Delete

async AsyncCogniteClient.data_modeling.records.delete(

items: RecordId | Sequence[RecordId],

*,

stream_id: str,

ignore_unknown_ids: Literal[True] = True,

) → None

Delete records from a stream.

Only valid for mutable streams (returns 422 on immutable). Unknown space + externalId pairs are silently ignored.

Parameters:

• items (RecordId | Sequence[RecordId]) – Records to delete.

• stream_id (str) – External ID of the stream to delete from.

• ignore_unknown_ids (Literal[True]) – Currently only True is supported

Examples

Delete records:

>>> from cognite.client import CogniteClient
>>> from cognite.client.data_classes.data_modeling.records import RecordId
>>> client = CogniteClient()
>>> client.data_modeling.records.delete(
...     stream_id="my-stream",
...     items=[
...         RecordId(space="my-space", external_id="rec-1"),
...         RecordId(space="my-space", external_id="rec-2"),
...     ],
... )