mindconnect.clients package

Submodules

mindconnect.clients.diagnostic_activations_client module

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

class DiagnosticActivationsClient(rest_client_config=None, mindsphere_credentials=None)

Bases: object

diagnostic_activations_get(request_object)

Gets diagnostic activations

Get diagnostic activations. Agents are allowed to get their own activation. Users with sufficient scopes are allowed to get all activations in the same tenant as in the token.

Parameters:request_object (DiagnosticActivationsGetRequest) – It contains the below parameters –>
( size - The maximum number of elements in a page. ),
( page - The (0-based) index of page. ),
( sort - The order of returned elements. Multiple fields could be used separated by commas (e.g. ‘’field1,field2’’). Descending order could be requested by appending ‘’,desc’’ at the end of parameter.(e.g. ‘’field1,field2,desc’’)’ ) Returns:PagedDiagnosticActivation

diagnostic_activations_id_delete(request_object)

Deletes a diagnostic activation

Delete a diagnostic activation. Agents are allowed to delete their own activation. Users with sufficient scopes are allowed to delete any activation in the same tenant as in the token.

Parameters:request_object (DiagnosticActivationsIdDeleteRequest) – It contains the below parameters –>
( id* - Unique identifier of diagnostic activation resource. ) Returns:None

diagnostic_activations_id_get(request_object)

Gets a diagnostic activation.

Get a diagnostic activation with given id. Agents are allowed to get their own activation. Users with sufficient scopes are allowed to get any activation in the same tenant as in the token.

Parameters:request_object (DiagnosticActivationsIdGetRequest) – It contains the below parameters –>
( id* - Unique identifier of diagnostic activation resource. ) Returns:DiagnosticActivation

diagnostic_activations_id_messages_get(request_object)

Get a diagnostic messages of specific activation resource

Get a diagnostic messages of specific activation resource. Agents are allowed to get their own activations’ messages. Users with sufficient scopes are allowed to get any activations messages in the same tenant as in the token.

Parameters:request_object (DiagnosticActivationsIdMessagesGetRequest) – It contains the below parameters –>
( id* - Unique identifier of diagnostic activation resource. ),
( filter - JSON based filter. Diagnostic messages can be filtered by the following fields - correlationId - message - source - timestamp - severity ),
( size - The maximum number of elements in a page. ),
( page - The (0-based) index of page. ),
( sort - The order of returned elements. Multiple fields could be used separated by commas (e.g. ‘’field1,field2’’). Descending order could be requested by appending ‘’,desc’’ at the end of parameter.(e.g. ‘’field1,field2,desc’’)’ ) Returns:PagedDiagnosticInformationMessages

diagnostic_activations_id_put(request_object)

Update status of Diagnostic Activation

Updates status of Diagnostic Activation.

Parameters:request_object (DiagnosticActivationsIdPutRequest) – It contains the below parameters –>
( id* - Unique identifier of diagnostic activation resource. ),
( diagnosticActivationStatus* - Object describing updated diagnostic activation status. ) Returns:DiagnosticActivation

diagnostic_activations_post(request_object)

Creates a new diagnostic activation

Create a new diagnostic activation. Agents are allowed to create activation for itself only. Users with sufficient scopes are allowed to create activations of the agents in the same tenant as in the token.

Parameters:request_object (DiagnosticActivationsPostRequest) – It contains the below parameters –>
( diagnosticActivation* - Object describing new diagnostic activation resource. ) Returns:DiagnosticActivation

mindconnect.clients.mappings_client module

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

class MappingsClient(rest_client_config=None, mindsphere_credentials=None)

Bases: object

data_point_mappings_get(request_object)

Get mappings.

Retrieves a list of mappings.

Parameters:request_object (DataPointMappingsGetRequest) – It contains the below parameters –>
( filter - Filter as JSON object. ),
( size - The maximum number of elements in a page. ),
( page - The (0-based) index of page. ),
( sort - The order of returned elements. Multiple fields could be used separated by commas (e.g. ‘’field1,field2’’). Descending order could be requested by appending ‘’,desc’’ at the end of parameter.(e.g. ‘’field1,field2,desc’’)’ ) Returns:PagedMapping

data_point_mappings_id_delete(request_object)

Delete a mapping

Deletes a mapping.

Parameters:request_object (DataPointMappingsIdDeleteRequest) – It contains the below parameters –>
( id* - Unique identifier of the mapping resource. ) Returns:None

data_point_mappings_id_get(request_object)

Get a mapping by id

Gets a mapping by given id.

Parameters:request_object (DataPointMappingsIdGetRequest) – It contains the below parameters –>
( id* - Unique identifier of the mapping resource. ) Returns:Mapping

data_point_mappings_post(request_object)

Create single mapping

Creates a single mapping.

Parameters:request_object (DataPointMappingsPostRequest) – It contains the below parameters –>
( mapping* - Object describing new mapping resource. ) Returns:Mapping

mindconnect.clients.record_recovery_client module

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

class RecordRecoveryClient(rest_client_config=None, mindsphere_credentials=None)

Bases: object

recoverable_records_get(request_object)

Get all recoverable records

Gets all recoverable records

Parameters:request_object (RecoverableRecordsGetRequest) – It contains the below parameters –>
( filter - JSON based filter. ),
( size - The maximum number of elements in a page. ),
( page - The (0-based) index of page. ),
( sort - The order of returned elements. Multiple fields could be used separated by commas (e.g. ‘’field1,field2’’). Descending order could be requested by appending ‘’,desc’’ at the end of parameter.(e.g. ‘’field1,field2,desc’’)’ ) Returns:PagedRecoverableRecords

recoverable_records_id_delete(request_object)

Delete a recoverable record

Deletes a recoverable record.

Parameters:request_object (RecoverableRecordsIdDeleteRequest) – It contains the below parameters –>
( id* - Unique identifier of the recoverable record. ) Returns:None

recoverable_records_id_download_link_get(request_object)

Get download link of record payload.

Gets download link of record payload

Parameters:request_object (RecoverableRecordsIdDownloadLinkGetRequest) – It contains the below parameters –>
( id* - Unique identifier of the recoverable record. ) Returns:str

recoverable_records_id_replay_post(request_object)

Re-play a recoverable record

Re-play a recoverable record.

Parameters:request_object (RecoverableRecordsIdReplayPostRequest) – It contains the below parameters –>
( id* - Unique identifier of the recoverable record. ) Returns:None

Module contents