GET

/api/settings

Parameters

c

Responses Example

Code: 200{“language” : “en” ,“ui Port” : 1881,“secureEnabled” : false,“tokenExpiresIn” : “1h” ,“smtp” : {...},}

POST

/api/settings

Parameters Example

{“language” : “en” ,“ui Port” : 1881,“secureEnabled” : false,“tokenExpiresIn” : “1h” ,

Responses

Code: 200

Note

Saved as file in ‘server/_appdata/mysettings.json’

GET

/api/project

Parameters

None

Responses

Code: 200{“version” : “1.00” ,“server” : {...},“hm i” : {“layout” : {...},“views” : [...]},“devices” : {...},“charts” : [...],“graphs” : [...],“alarms” : [...],“notifications” : [...],“scripts” : [...],“texts” : [...],“plugin” : [...]}

POST

/api/project

Parameters Example

{“version” : “1.00” ,“server” : {},“hm i” : {“layout” : {...},“views” : [{“MainView” : {...}]},“devices” : {},“charts” : [...],“graphs” : [...],“alarms” : [...],“notifications” : [...],“scripts” : [...],“texts” : [...],“plugin” : [...]}

Responses

Code: 200

Note

Used to build new project, clear all and set a new void project

POST

/api/projectData

Parameters Example

{“cmd” : “” ,“data” : ...} cmd: ‘set-device’ , ‘del-device’data: {...}cmd: ‘set-view’ , ‘del-view’data: {...}cmd: ‘layout’data: {...}cmd: ‘charts’data: [...]cmd: ‘graphs’data: [...]cmd: ‘set-text’ , ‘del-text’data: {...}cmd: ‘set-alarm’ , ‘del-alarm’data: {...}cmd: ‘set-notification’ , ‘del-notification’data: {...}cmd: ‘set-script’ , ‘del-script’data: {...}

Responses

Code: 200

Note

In server are saved in tables: general, views devices, texts, alarms, notifications, scripts.The tables structure: name (string), value (string) all the same:● general name=charts/layout/plugin/version and value=data● views name=data.id (view) and value=data● devices name=data.id (device) and value=data● alarms name=data.name (alarm) and value=data● notifications name=data.id (notification) and value=data● scripts name=data.id (script) and value=data

POST

/api/upload

Parameters Example

JSON file

Responses

Code: 200

GET

/api/device

Parameters Example

{“query” : “security” ,“name” : “My OPCUA”}

Responses

Code: 200{“mode” : “” ,“u id” : “username” ,“pwd” : “password” ,“client Id” : “123456”}

POST

/api/device

Parameters Example

{“query” : “security” ,“name” : “My OPCUA”“value” : {“mode” : “” ,“u id” : “username” ,“pwd” : “password” ,“client Id” : “123456”}}

Responses

Code: 200

GET

/api/alarms

Parameters

None

Responses

Code: 200[{“name” : “Alarm name” ,“type” : “”“ontime” : “” ,“offtime” : “” ,“acktime” : “” ,“status” : “” ,“text” : “” ,“group” : “” ,“bkcolor” : “” ,“color” : “” ,“toack” : “”

POST

/api/alarmack

Parameters

{“params” : “Alarm id”}

Responses

Code: 200

Note

‘Alarm id’ ‘is composed from name and type

POST

/api/signin

Parameters

{“username” : “admin” ,“password” : “123456”}

Responses

Code: 200

GET

/api/users

Parameters

None

Responses

Code: 200[{“username” : “username” ,“password” : “123456” ,“groups” : 3}]

POST

/api/users

Parameters

{“username” : “username” ,“fullname” : “fullname” ,“password” : “123456” ,“groups” : 3}

DELETE

/api/users

Parameters

{“param” : “username”}

Responses

Code: 200

GET

/api/plugins

Parameters

None

Responses

Code: 200[{“name” : “modbus-serial” ,“type” : “Modbus” ,“version” : “8.0.1” ,“current” : “8.0.1” ,“status” : “” ,“pkg” : true,“dinamic” : true}]

POST

/api/plugins

Parameters

{“name” : “modbus-serial” ,“type” : “Modbus” ,“version” : “8.0.1” ,“current” : “8.0.1” ,“status” : “” ,“pkg” : true,“dinamic” : true}

Responses

Code: 200

DELETE

/api/plugins

Responses

Code: 200

GET

/api/daq

Parameters

{“query” : {“gid” : “gauge id” ,“from” : “timestamp” ,“to” : “timestamp” ,“event” : “B” ,“sids” : [“tag id” , “” ]}}

Responses

Code: 200[{“id” : “tag id”“ts” : “timestamp” ,“value” : “12.5” ,}]

Note

Used to ask current or history tags value (DAQ):● ‘gid’ reference to the GUI component.● ‘timestamp’ milliseconds● ‘event’ can be ‘B’ or ‘F’ to step the range query in Back or Forward.● ‘sid’ list of tags id

GET

/api/logsdir

Parameters

None

Responses

Code: 200[“fuxa.log” ,“fuxa1.log” ,“fuxa-err.log” ,] ...

GET

/api/logs

Parameters

{

Responses

Download file content

POST

/api/sendmail

Parameters

{“msg” : {“from” : “pippo@frangoteam.org” ,“to” : “ciccio@frangoteam.org” ,“subject” : “test” ,“text” : “content” ,“html” : “html-content” ,},“smtp” : {“host” : “blabla.smtp.org” ,“port” : 587,“mailsender” : “pippo@frangoteram.org” ,“username” : “username” ,“password” : “password” ,}}

Responses

Code: 200

Note

Used to send mail from frontend, ‘smtp’ is optional and used for configuring and testing.

POST

/api/runscript

Parameters

{“script” : {“id” : “script id” ,“name” : “script name” ,“code” : “script code” ,“parameters” : [{“name” : “param name” ,“type” : “value” ,“value” : “12.5”},{...}]}}

Responses

Code: 200

Note

Used to run scripts from frontend, ‘code’ and ‘name’ are optional and used for configuring and testing.