The Webserver is running!

Powered by ACPLT/OV. This server has some static files as a demo and supports KS commands. This page is only a quick reference.
A modern OV-Server (like this) can be explored by the Tool Henson (requires internet connection).

Supported KS commands

This server can generate answers in a TCL or KSX syntax. The TCL syntax is default. It is possible to select KSX with the HTTP accept header Accept: text/ksx or as a parameter in the GET request argument &format=ksx.

GetVar

Gets one or multiple Variables.

example: /getVar?format=ksx&path=/vendor/database_free
example: /getVar?format=ksx&path[0]=/vendor/database_free&path[1]=/vendor/database_size

SetVar

Sets one or multiple Variables. Note: The indexes of the parts are not relevant, only the order matters (second newvalue will be written into the second path). If fewer vartypes are given the last one will be used for the rest.

example: /setVar?format=ksx&path=/TechUnits/add1.IN1&newvalue=4.5
example: /setVar?format=ksx&path=/TechUnits/add1.IN1&newvalue=42&vartype=KS_VT_UINT
example: /setVar?format=ksx&path[0]=/TechUnits/add1.IN1&path[1]=/TechUnits/add2.IN1&path[2]=.IN2&newvalue[0]=3.2&newvalue[1]=2&newvalue[2]=1
example: /setVar?format=ksx&path[0]=/TechUnits/add1.IN1&newvalue[0]=3.2&path[1]=/TechUnits/add2.IN1&newvalue[1]=2&path[2]=.IN2&newvalue[2]=1
example: /setVar?format=ksx&path[0]=/TechUnits/add1.IN1&path[1]=/TechUnits/add2.IN1&newvalue[0]=3.2&newvalue[1]=2&vartype[0]=KS_VT_SINGLE
example: /setVar?format=ksx&path=/TechUnits/bla.VecIntVariable&newvalue={1}%20{10}

GetEP

Gets the engineering properties of an object. It has a few optional parameters:

example: /getEP?format=ksx&path=/TechUnits/add1
example: /getEP?format=ksx&path=/TechUnits/add1&requestType=OT_ANY

createObject

Instantiates new objects. Note: The indexes of the parts are not relevant, only the order matters. It has optional parameters:

example: /createObject?format=ksx&path=/TechUnits/add1&factory=/acplt/iec61131stdfb/add
example: /createObject?format=ksx&Path[1]=/TechUnits/add1&path[2]=/TechUnits/add2&factory=/acplt/iec61131stdfb/add

deleteObject

Deletes objects.

example: /deleteObject?format=ksx&path=/TechUnits/add1
example: /deleteObject?format=ksx&path[1]=/TechUnits/add1&path[2]=/TechUnits/add2

renameObject

Renames objects. Note: The indexes of the parts are not relevant, only the order matters. It has optional parameters:

example: /renameObject?format=ksx&path=/TechUnits/add1&newname=/TechUnits/add2
example: /renameObject?format=ksx&path[1]=/TechUnits/add1&path[2]=/TechUnits/sub1&newname[1]=/TechUnits/add2&newname[2]=/TechUnits/sub2

linkObject

Links two pairs of objects with an OV association. It has optional parameters:

example: /link?format=ksx&path=/TechUnits/add1.taskparent&element=/Tasks/UrTask
equivalent: /link?format=ksx&path=/Tasks/UrTask.taskchild&element=/TechUnits/add1
example: /link?format=ksx&path[0]=/TechUnits/add1.taskparent&element[0]=/Tasks/UrTask&path[1]=/TechUnits/add2.taskparent&element[1]=/Tasks/UrTask
example: /link?format=ksx&path=/TechUnits/add1.taskparent&element=/Tasks/UrTask&placementHint=BEGIN
example: /link?format=ksx&path=/TechUnits/add1.taskparent&element=/Tasks/UrTask&placementHint=BEFORE&placePath=/TechUnits/sub1

unlinkObject

Unlinks two pairs of objects with an OV association.

example: /unlink?format=ksx&path=/TechUnits/add1.taskparent&element=/UrTask
example: /unlink?format=ksx&path[0]=/TechUnits/add1.taskparent&element[0]=/UrTask&path[1]=/TechUnits/add2.taskparent&element[1]=/UrTask

getLogfile

Outputs logfile outputs of the server.

example: /getLogfile?format=ksx
example: /getLogfile?format=ksx&from=2013-12-24T13:15:00.000000&to=2016-12-31T22:45:00.000000&maxentries=30

getServer

Gives TCP Port of a Server (if this server is the KS-MANAGER).

example: /getServer?format=ksx&servername=MANAGER
example: /getServer?format=ksx&servername=MANAGER&serverversion=2