Retrieve jobs

async AsyncCogniteClient.hosted_extractors.jobs.retrieve(

external_ids: str | SequenceNotStr[str],

ignore_unknown_ids: bool = False,

) → Job | None | JobList

Retrieve one or more jobs.

Parameters:

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

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

Returns:

Requested jobs

Return type:

Job | None | JobList

Examples

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

Get multiple jobs by id:

>>> res = client.hosted_extractors.jobs.retrieve(
...     ["myJob", "myOtherJob"], ignore_unknown_ids=True
... )