mindconnect package

Subpackages

• mindconnect.clients package
  • Submodules
  • mindconnect.clients.diagnostic_activations_client module
  • mindconnect.clients.mappings_client module
  • mindconnect.clients.record_recovery_client module
  • Module contents
• mindconnect.models package
  • Submodules
  • mindconnect.models.badrequest module
  • mindconnect.models.conflict module
  • mindconnect.models.data_point_mappings_get_request module
  • mindconnect.models.data_point_mappings_id_delete_request module
  • mindconnect.models.data_point_mappings_id_get_request module
  • mindconnect.models.data_point_mappings_post_request module
  • mindconnect.models.diagnostic_activation module
  • mindconnect.models.diagnostic_activation_status module
  • mindconnect.models.diagnostic_activations_get_request module
  • mindconnect.models.diagnostic_activations_id_delete_request module
  • mindconnect.models.diagnostic_activations_id_get_request module
  • mindconnect.models.diagnostic_activations_id_messages_get_request module
  • mindconnect.models.diagnostic_activations_id_put_request module
  • mindconnect.models.diagnostic_activations_post_request module
  • mindconnect.models.diagnostic_information module
  • mindconnect.models.diagnostic_information_message module
  • mindconnect.models.error module
  • mindconnect.models.forbidden module
  • mindconnect.models.mapping module
  • mindconnect.models.notfound module
  • mindconnect.models.order module
  • mindconnect.models.paged_diagnostic_activation module
  • mindconnect.models.paged_diagnostic_information module
  • mindconnect.models.paged_diagnostic_information_messages module
  • mindconnect.models.paged_mapping module
  • mindconnect.models.paged_recoverable_records module
  • mindconnect.models.pay_load_too_large module
  • mindconnect.models.recoverable_records module
  • mindconnect.models.recoverable_records_get_request module
  • mindconnect.models.recoverable_records_id_delete_request module
  • mindconnect.models.recoverable_records_id_download_link_get_request module
  • mindconnect.models.recoverable_records_id_replay_post_request module
  • mindconnect.models.unauthorized module
  • mindconnect.models.validity module
  • Module contents

Module contents

MindConnect API

MindConnect API provides following data ingestion functionalities: # Data Point Mappings Creating and managing mappings between an agent’s data points and an entity’s dynamic property to be able to upload TimeSeries data. Each agent has data points with unique ids. The mapping is between to this id to an entity’s dynamic property set’s property. - A data point can be mapped to many property of many property set of many entities. - A property cannot be mapped from more than one data point. - A propertyset can have mappings from many agents’ many data points to its properties. - The unit of the datapoint has to be same with the unit of the property. - The type of the datapoint has to be same with the type of the property. Whenever data source configuration of an agent is updated via Agent Management API; all mappings with __keepMapping__ attribute set gets their validity attribute updated and all mappings with __keepMapping__ attribute unset are deleted. # Exchange Exchanging time series, events, files and data source configuration data. Combination of different data types can be uploaded via exchange endpoint within multipart body. Maximum size of exchange body is 10MBs. # Diagnostic Activations Management of Diagnostic Activations and querying Diagnostic Messages of time series, event, file and data source configuration requests. - Maximum 5 agents per tenant can be activated for data ingestion tracking. - For non-agents, the required permission allows to manage diagnostic activation resources of agents in the same tenant as in the token. - For agents, only the diagnostic activation related to the agent can be managed. Agents are forbidden to view/change the resources of other agents in the same tenant. - Agents are allowed to update activation for itself only. Users with sufficient scopes are allowed # noqa: E501