Retrieve function call

async AsyncCogniteClient.functions.calls.retrieve(
call_id: int,
function_id: int | None = None,
function_external_id: str | None = None,
) → FunctionCall | None

Retrieve a single function call by id.

Parameters:

  • call_id (int) – ID of the call.

  • function_id (int | None) – ID of the function on which the call was made.

  • function_external_id (str | None) – External ID of the function on which the call was made.

Returns:

Requested function call or None if either call ID or function identifier is not found.

Return type:

FunctionCall | None

Examples

Retrieve single function call by id:

>>> from cognite.client import CogniteClient, AsyncCogniteClient
>>> client = CogniteClient()
>>> # async_client = AsyncCogniteClient()  # another option
>>> call = client.functions.calls.retrieve(call_id=2, function_id=1)

Retrieve function call directly on a function object:

>>> func = client.functions.retrieve(id=1)
>>> call = func.retrieve_call(id=2)