An Industrial IOT Platform

Web API Documentation

Once Open-Plant (Full Version) is installed, Open-Plant provides Web API endpoints which return JSON data about tags, users, and most importantly data values from the connected devices. There are no special licenses for this. Web APIs are accessible even on the free version. The base Web API Address is 'https://127.0.0.1:33170/api' for secure https and 'http://127.0.0.1:33171/api' for unsecure http endpoints. If windows authentication is used '/wa' must be followed before api, such as 'https//127.0.0.1:33170/wa/api' and 'http://127.0.0.1:33171/wa/api'. 

All request must use the appropriate HTTP Method. Open-Plant limits this to GET, PUT, PATCH, POST and DELETE.

GENERAL APIS

USER APIS

TAG APIS

VALUE APIS

SAMPLE APIS

OPSCRIPT APIS

KV (Key-Value) STORE APIS

Key Value Store (KVStore) functions as a convenient database to store any type of data from strings, integer, numbers, date, time and even objects. When an object is stored, it is stored as a JSON string. Each item stored in the KVStore must be assigned a 'Key' and a 'KVGroup'. 

KVStore is almost similar to OP Parameters, except that it is not cached in server memory but stored directly in the Open-Plant Database. Accessing KVStore will result in a database operation, which may be slightly slower than accessing server memory. However, unlike OP Parameters, there is no limit to the size of a value.
Open-Plant is a revolutionary Industrial IOT Platform software, used to create and deploy Industrial IT apps/solutions. It is an all-encompassing solution offering both back-end and front-end components i.e. the full stack. From our user's experience, creating and deploying Industrial IT apps became 10x faster and 10x less cost. We serve the mining, energy, oil & gas, construction and manufacturing industry. 

Vlix

Perth, Australia

EMAIL

info@vlix.me
homedownloadbanbarsenvelopeangle-double-left