Inspect instances
- async AsyncCogniteClient.data_modeling.instances.inspect(
- nodes: NodeId | Sequence[NodeId] | tuple[str, str] | Sequence[tuple[str, str]] | None = None,
- edges: EdgeId | Sequence[EdgeId] | tuple[str, str] | Sequence[tuple[str, str]] | None = None,
- *,
- involved_views: InvolvedViews | None = None,
- involved_containers: InvolvedContainers | None = None,
-
This method will return the involved views and containers for the given nodes and edges.
- Parameters:
nodes (NodeId | Sequence[NodeId] | tuple[str, str] | Sequence[tuple[str, str]] | None) – Node IDs.
edges (EdgeId | Sequence[EdgeId] | tuple[str, str] | Sequence[tuple[str, str]] | None) – Edge IDs.
involved_views (InvolvedViews | None) – Whether to include involved views. Must pass at least one of involved_views or involved_containers.
involved_containers (InvolvedContainers | None) – Whether to include involved containers. Must pass at least one of involved_views or involved_containers.
- Returns:
List of instance inspection results.
- Return type:
Examples
Look up the involved views for a given node and edge:
>>> from cognite.client import CogniteClient >>> from cognite.client.data_classes.data_modeling import NodeId, EdgeId, InvolvedViews >>> client = CogniteClient() >>> # async_client = AsyncCogniteClient() # another option >>> res = client.data_modeling.instances.inspect( ... nodes=NodeId("my-space", "foo1"), ... edges=EdgeId("my-space", "bar2"), ... involved_views=InvolvedViews(all_versions=False), ... )
Look up the involved containers:
>>> from cognite.client.data_classes.data_modeling import InvolvedContainers >>> res = client.data_modeling.instances.inspect( ... nodes=[("my-space", "foo1"), ("my-space", "foo2")], ... involved_containers=InvolvedContainers(), ... )