Taskruns#

class fews_py_wrapper._api.endpoints.Taskruns[source]#
static endpoint_function(*, client, workflow_id, topology_node_id=<fews_openapi_py_client.types.Unset object>, forecast_count=<fews_openapi_py_client.types.Unset object>, task_run_ids=<fews_openapi_py_client.types.Unset object>, scenario_id=<fews_openapi_py_client.types.Unset object>, mc_id=<fews_openapi_py_client.types.Unset object>, start_forecast_time=<fews_openapi_py_client.types.Unset object>, end_forecast_time=<fews_openapi_py_client.types.Unset object>, start_dispatch_time=<fews_openapi_py_client.types.Unset object>, end_dispatch_time=<fews_openapi_py_client.types.Unset object>, task_run_status_ids=<fews_openapi_py_client.types.Unset object>, only_forecasts=<fews_openapi_py_client.types.Unset object>, task_run_count=<fews_openapi_py_client.types.Unset object>, only_current=<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 all taskruns for a workflowId filtered by parameters like forecast time or taskrun status

Get all taskruns for a workflowId filtered by parameters like forecast time or taskrun status.

Default only taskruns of forecasts are returned.

Parameters:

  • workflow_id (str)

  • topology_node_id (str | Unset)

  • forecast_count (str | Unset)

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

  • scenario_id (str | Unset)

  • mc_id (str | Unset)

  • start_forecast_time (datetime.datetime | Unset) – Date-time string that adheres to RFC 3339. Example: 2020-03-18T15:00:00Z.

  • end_forecast_time (datetime.datetime | Unset) – Date-time string that adheres to RFC 3339. Example: 2020-03-18T15:00:00Z.

  • start_dispatch_time (datetime.datetime | Unset) – Date-time string that adheres to RFC 3339. Example: 2020-03-18T15:00:00Z.

  • end_dispatch_time (datetime.datetime | Unset) – Date-time string that adheres to RFC 3339. Example: 2020-03-18T15:00:00Z.

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

  • only_forecasts (TaskrunsOnlyForecasts | Unset)

  • task_run_count (str | Unset)

  • only_current (TaskrunsOnlyCurrent | Unset)

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