Locations#

class fews_py_wrapper._api.endpoints.Locations[source]#
static endpoint_function(*, client, filter_id=<fews_openapi_py_client.types.Unset object>, parameter_ids=<fews_openapi_py_client.types.Unset object>, location_ids=<fews_openapi_py_client.types.Unset object>, show_time_series_info=<fews_openapi_py_client.types.Unset object>, parameter_group_id=<fews_openapi_py_client.types.Unset object>, show_attributes=<fews_openapi_py_client.types.Unset object>, attribute_ids=<fews_openapi_py_client.types.Unset object>, show_parent_locations=<fews_openapi_py_client.types.Unset object>, show_thresholds=<fews_openapi_py_client.types.Unset object>, include_icon_names=<fews_openapi_py_client.types.Unset object>, include_location_relations=<fews_openapi_py_client.types.Unset object>, include_time_dependency=<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 locations that are available for the ‘filterId’ argument

Get locations that are available for the ‘filterId’ argument. Locations are also returned if no time

series are available for a location in the filter. If not filterId is passed then all locations configured in the pre-defined filter will be returned.

Parameters:

  • filter_id (str | Unset)

  • parameter_ids (str | Unset)

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

  • show_time_series_info (LocationsShowTimeSeriesInfo | Unset)

  • parameter_group_id (str | Unset)

  • show_attributes (LocationsShowAttributes | Unset)

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

  • show_parent_locations (LocationsShowParentLocations | Unset)

  • show_thresholds (LocationsShowThresholds | Unset)

  • include_icon_names (LocationsIncludeIconNames | Unset)

  • include_location_relations (LocationsIncludeLocationRelations | Unset)

  • include_time_dependency (LocationsIncludeTimeDependency | Unset)

  • document_format (LocationsDocumentFormat | 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