Retrieve mappings

async AsyncCogniteClient.hosted_extractors.mappings.retrieve(
external_ids: str | SequenceNotStr[str],
ignore_unknown_ids: bool = False,
) → Mapping | MappingList

Retrieve one or more mappings.

Parameters:

  • external_ids (str | SequenceNotStr[str]) – The external ID provided by the client. Must be unique for the resource type.

  • ignore_unknown_ids (bool) – Ignore external IDs that are not found

Returns:

Requested mappings

Return type:

Mapping | MappingList

Examples

>>> from cognite.client import CogniteClient, AsyncCogniteClient
>>> client = CogniteClient()
>>> # async_client = AsyncCogniteClient()  # another option
>>> res = client.hosted_extractors.mappings.retrieve("myMapping")

Get multiple mappings by id:

>>> res = client.hosted_extractors.mappings.retrieve(
...     ["myMapping", "myMapping2"], ignore_unknown_ids=True
... )