Retrieve multiple files’ metadata by id

async AsyncCogniteClient.files.retrieve_multiple(
ids: Sequence[int] | None = None,
external_ids: SequenceNotStr[str] | None = None,
instance_ids: Sequence[NodeId] | None = None,
ignore_unknown_ids: bool = False,
) → FileMetadataList

Retrieve multiple file metadatas by id.

Parameters:

  • ids (Sequence[int] | None) – IDs

  • external_ids (SequenceNotStr[str] | None) – External IDs

  • instance_ids (Sequence[NodeId] | None) – Instance IDs

  • ignore_unknown_ids (bool) – Ignore IDs and external IDs that are not found rather than throw an exception.

Returns:

The requested file metadatas.

Return type:

FileMetadataList

Examples

Get file metadatas by instance id:

>>> from cognite.client import CogniteClient, AsyncCogniteClient
>>> from cognite.client.data_classes.data_modeling import NodeId
>>> client = CogniteClient()
>>> # async_client = AsyncCogniteClient()  # another option
>>> res = client.files.retrieve_multiple(
...     instance_ids=[NodeId("my-space", "my-file-xid")]
... )

Get file metadatas by external id:

>>> res = client.files.retrieve_multiple(external_ids=["abc", "def"])