idmtools_platform_local.client.healthcheck_client module

class idmtools_platform_local.client.healthcheck_client.HealthcheckClient

Bases: idmtools_platform_local.client.base.BaseClient

path_url = 'healthcheck'
classmethod get_all() → List[Dict[str, Any]]

Get all experiments with options to filter by tags

Parameters
  • per_page – How many experiments to return per page

  • page – Which page

  • tags (Optional[List[Tuple[str, str]]]) – List of tags/values to filter experiment by

Returns

returns list of experiments

Return type

List[Dict[str, Any]]

classmethod get_one() → Dict[str, Any]

Convenience method to get one experiment

Parameters
  • id (str) – ID of the experiment

  • tags (Optional[List[Tuple[str, str]]]) – List of tags/values to filter experiment by

Returns

Dictionary containing the experiment objects

Return type

dict

classmethod delete(*args, **kwargs) → bool
classmethod post(*args, **kwargs) → bool