Parameters#

class fews_py_wrapper._api.endpoints.Parameters[source]#
static endpoint_function(*, client, filter_id=<fews_openapi_py_client.types.Unset object>, location_ids=<fews_openapi_py_client.types.Unset object>, show_attributes=<fews_openapi_py_client.types.Unset object>, document_format=<fews_openapi_py_client.types.Unset object>, document_version=<fews_openapi_py_client.types.Unset object>)#

Get parameters that are available for the ‘filterId’ argument

Get parameters that are available for the ‘filterId’ argument. Parameters are also returned if no

time series are available for a parameter in the filter. If no filterId is passed then all parameters configured in the pre-defined filter will be returned.

Parameters:

  • filter_id (str | Unset)

  • location_ids (list[str] | Unset) – The parameter can be repeated

  • show_attributes (ParametersShowAttributes | Unset)

  • document_format (ParametersDocumentFormat | Unset)

  • document_version (str | Unset)

  • client (AuthenticatedClient | Client)

Raises:

  • errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Response[Any]

Return type:

Response[Any]

execute(*, client, **kwargs)[source]#

Execute the API endpoint call.

Parameters:

  • client (AuthenticatedClient | Client) – AuthenticatedClient or Client instance for API calls.

  • document_format – Format of the returned document.

  • **kwargs (Any) – Keyword arguments for the API call.

Returns:

Parsed JSON response from the API.

Return type:

dict