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).
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
.
Gets one or multiple Variables.
example:/getVar?format=ksx&path=/vendor/database_free
/getVar?format=ksx&path[0]=/vendor/database_free&path[1]=/vendor/database_size
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 vartype
s are given the last one will be used for the rest.
/setVar?format=ksx&path=/TechUnits/add1.IN1&newvalue=4.5
/setVar?format=ksx&path=/TechUnits/add1.IN1&newvalue=42&vartype=KS_VT_UINT
/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
/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
/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
/setVar?format=ksx&path=/TechUnits/bla.VecIntVariable&newvalue={1}%20{10}
Gets the engineering properties of an object. It has a few optional parameters:
requestType
filters some type of result: childrens (default, OT_DOMAIN
), variables (OT_VARIABLE
), links (OT_LINK
) or all (OT_ANY
)nameMask
filters for names (?
is an arbitrary character, *
is an arbitrary amount of any characters). Default is *
scopeFlags
filters for the scope (children
are normal children, parts
are some hard wired objects). Default is no restrictionrequestOutput
a list of answser columns: OP_NAME
,
, OP_TYPE
, OP_COMMENT
, OP_ACCESS
, OP_SEMANTIC
, OP_CREATIONTIME
, OP_CLASS
, OP_TECHUNIT
, OP_ASSOCIDENT
, OP_ROLEIDENT
. Default is all of them in this order./getEP?format=ksx&path=/TechUnits/add1
/getEP?format=ksx&path=/TechUnits/add1&requestType=OT_ANY
Instantiates new objects. Note: The indexes of the parts are not relevant, only the order matters. It has optional parameters:
placementHint
defines the placement of the new object in the parent domain: PMH_DEFAULT
= PMH_END
, PMH_BEGIN
, PMH_BEFORE
, PMH_AFTER
placePath
defines the path of the partner if the Hint was PMH_BEFORE
or PMH_AFTER
/createObject?format=ksx&path=/TechUnits/add1&factory=/acplt/iec61131stdfb/add
/createObject?format=ksx&Path[1]=/TechUnits/add1&path[2]=/TechUnits/add2&factory=/acplt/iec61131stdfb/add
Deletes objects.
example:/deleteObject?format=ksx&path=/TechUnits/add1
/deleteObject?format=ksx&path[1]=/TechUnits/add1&path[2]=/TechUnits/add2
Renames objects. Note: The indexes of the parts are not relevant, only the order matters. It has optional parameters:
placementHint
defines the placement of the object in the parent domain: PMH_DEFAULT
= PMH_END
, PMH_BEGIN
, PMH_BEFORE
, PMH_AFTER
placePath
defines the path of the partner if the Hint was PMH_BEFORE
or PMH_AFTER
/renameObject?format=ksx&path=/TechUnits/add1&newname=/TechUnits/add2
/renameObject?format=ksx&path[1]=/TechUnits/add1&path[2]=/TechUnits/sub1&newname[1]=/TechUnits/add2&newname[2]=/TechUnits/sub2
Links two pairs of objects with an OV association. It has optional parameters:
placementHint
defines the placement of the object in the association: PMH_DEFAULT
=PMH_END
, PMH_BEGIN
, PMH_BEFORE
, PMH_AFTER
placePath
defines the path of the partner if the Hint was PMH_BEFORE
or PMH_AFTER
/link?format=ksx&path=/TechUnits/add1.taskparent&element=/Tasks/UrTask
/link?format=ksx&path=/Tasks/UrTask.taskchild&element=/TechUnits/add1
/link?format=ksx&path[0]=/TechUnits/add1.taskparent&element[0]=/Tasks/UrTask&path[1]=/TechUnits/add2.taskparent&element[1]=/Tasks/UrTask
/link?format=ksx&path=/TechUnits/add1.taskparent&element=/Tasks/UrTask&placementHint=BEGIN
/link?format=ksx&path=/TechUnits/add1.taskparent&element=/Tasks/UrTask&placementHint=BEFORE&placePath=/TechUnits/sub1
Unlinks two pairs of objects with an OV association.
example:/unlink?format=ksx&path=/TechUnits/add1.taskparent&element=/UrTask
/unlink?format=ksx&path[0]=/TechUnits/add1.taskparent&element[0]=/UrTask&path[1]=/TechUnits/add2.taskparent&element[1]=/UrTask
Outputs logfile outputs of the server.
example:/getLogfile?format=ksx
/getLogfile?format=ksx&from=2013-12-24T13:15:00.000000&to=2016-12-31T22:45:00.000000&maxentries=30
Gives TCP Port of a Server (if this server is the KS-MANAGER).
example:/getServer?format=ksx&servername=MANAGER
/getServer?format=ksx&servername=MANAGER&serverversion=2