Introduction
The connector serves as a bridge between the TwinThread and Tulip systems, facilitating essential functionalities despite being a demo version. Key features include:
- Authentication Process: The connector outlines the method of authentication.
- Model Queries: It allows for querying models, each representing a a target / analysis.
- Association with Machines: The model is linked to a particular machine, referred to as an "Asset."
- Queries based on Asset IDs: Asset properties can be queried using the received Asset IDs.
- Queries of Property Values: Property values can be retrieved based on the received property ID.
- Property Value Updates: Values of specific properties can be updated based on the received property ID.
- Alert Query by Asset ID: Machine alerts can be fetched based on Asset ID.
Purpose
API Documentation
For more information, please contact TwinThread customer care.
Pre-requisites
Before users can start utilizing the connector effectively, they need to have access to the TwinThread and Tulip systems.
The connector is complemented by a demo application that initiates with a login interface. This application showcases the procedure for acquiring a Bearer token.
The token can be copied by the green Copy to Clipboard button.
Tulip Connection Details
The settings interface of the connector can be opened at the following path:
Require to provide the Bearer token to the connector for seamless functionality and access to subsequent features.
Connector Functions
- Get Bearer Token v1
- Purpose: Get Bearer token for the API requests
- Required Inputs
- Username
- Password
- Outputs
- Access token (Bearer)
- Token type
- Expires
- Simple Model Status v1
- Purpose: Get the name of the related Asset and it's execution time
- Required Input
- ModelID
- Outputs
- NextExecution
- currentProduct
- name
- Get Property List V4
- Purpose: Get the properties of the Asset
- Required Input
- Asset
- Outputs
- Agitator Speed
- Heat Energy
- Mixer Temperature
- Update Property - Number
- Purpose: Update a property of an Asset by property ID
- Required Input
- PropertyID
- PropertyValue
- ValueTimestamp
- List Asset Alerts
- Purpose: Get the list of the alerts of an asset
- Required Input
- Asset
- Outputs
- Priority
- Start Time
- alertId
- endTime
- Alert Type
- Description
Did you find what you were looking for?
You can also head to community.tulip.co to post your question or see if others have faced a similar question!