Qodex.ai

MindConnect API

Number of APIs: 21

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 data point can not be mapped to multiple properties within same property set under same entity.

  • A property set can have mappings from many agents' many data points to its properties.

  • 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.

Event Mappings

Creating and managing mappings for agent's events to assets.

An event uploaded by an agent will be checked against the event mappings to determine the asset the event will be stored in.

If there are no event mappings matching an event, that event will be stored in the agent asset.

Multiple mappings can match for an event uploaded. In such a case, all matching mappings will be applied for the event.

Multiple event mappings can be directed to the same asset.

Maximum 50 event mappings can be created per agent.

Maximum 5 event mappings can be created per agent, which are mapped to a single event type resource.

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

  1. dataPointMappings - Create single mapping POST {{baseUrl}}/dataPointMappings

  2. diagnosticActivations-{id} - Get a diagnostic messages of specific activation resource GET {{baseUrl}}/diagnosticActivations/:id/messages?filter=<string>&size=20&page=0&sort=<string>

  3. /exchange POST {{baseUrl}}/exchange

  4. Get Diagnostic Information GET {{baseUrl}}/diagnosticInformation?filter=<string>&size=20&page=0&sort=<string>

  5. diagnosticActivations-{id} - Gets a diagnostic activation. GET {{baseUrl}}/diagnosticActivations/:id

  6. dataPointMappings-{id} - Delete a mapping DELETE {{baseUrl}}/dataPointMappings/:id

  7. dataPointMappings - Get mappings. GET {{baseUrl}}/dataPointMappings?filter=<string>&size=20&page=0&sort=<string>

  8. dataPointMappings-{id} - Get a mapping by id GET {{baseUrl}}/dataPointMappings/:id

  9. eventMappings-{id} - Get a mapping by id GET {{baseUrl}}/eventMappings/:id

  10. eventMappings-{id} - Update a mapping PATCH {{baseUrl}}/eventMappings/:id