The Webserver is running!

Powered by ACPLT/OV. This server supports KS commands. This page is only a quick reference.

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.

example: /setVar?format=ksx&path=/TechUnits/add1.IN1&newvalue=4.5
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[1]=1

GetEP

Gets the engineering properties of an object. Can give all childrens with the parameter requestType(default, OT_DOMAIN), variables (OT_VARIABLE), links (OT_LINK) or all (OT_ANY)

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

createObject

Instantiates new objects.

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.

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.

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&placehint=BEGIN
example: /link?format=ksx&path=/TechUnits/add1.taskparent&element=/Tasks/UrTask&placehint=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