Returns suggested template for data type/ instruction when new data type/instruction is added.

URL

/rw/rapid/modules/{module}

Method

GET

URL Params

resource=rules-instr Required

task={task_name} Required

name={datatype_name | instruction_name} Required

data-type=true | false

line={line_num}

col={column_num}

parnum={parnum_value}

altnum={altnum_value}

Data Params

None

Success Response

HTTP_OK, see HTTP Status codes

Example Response

<html>
<head>
<title>rapid</title>
<base href= "http://localhost:7777/rw/rapid/" />
</head>
<body>
<div class="state">
<a href= "modules/MainModule?task=T_ROB1&resource=rules-instr" rel="self"/>
<ul>
<li class="rap-module-rulesinstr" title="header">
<span class="num-args">4</span>
<span class="mark">0</span>
<span class="last">1</span>
<span class="version">2</span>
<span class="select-param">0</span>
</li>
<li class="rap-module-rulesinstr" title="arg2">
<span class="arg-num">2</span>
<span class="required">TRUE</span>
<span class="arg-name">ToPoint</span>
<span class="dec-data">FALSE</span>
<span class="arg-symbol"/>
<span class="data-value">[[515.00,0.00,712.00],[0.707107,0,0.707107,0],[0,0,0,0],[9E+09,9E+09,9E+09,9E+09,9E+09,9E+09]]</span>
<span class="data-type">robtarget</span>
<span class="obj-type">CONST</span>
<span class="local">FALSE</span>
<span class="ndim">0</span>
</li>
<li class="rap-module-rulesinstr" title="arg4">
<span class="arg-num">4</span>
<span class="required">TRUE</span>
<span class="arg-name">Speed</span>
<span class="dec-data">FALSE</span>
<span class="arg-symbol">v1000</span>
<span class="data-value">[1000,500,5000,1000]</span>
<span class="data-type">speeddata</span>
<span class="obj-type">CONST</span>
<span class="local">FALSE</span>
<span class="ndim">0</span>
</li>
<li class="rap-module-rulesinstr" title="arg6">
<span class="arg-num">6</span>
<span class="required">TRUE</span>
<span class="arg-name">Zone</span>
<span class="dec-data">FALSE</span>
<span class="arg-symbol">%3cEXP%3e</span>
<span class="data-value"/>
<span class="data-type">zonedata</span>
<span class="obj-type"/>
<span class="local">FALSE</span>
<span class="ndim">0</span>
</li>
<li class="rap-module-rulesinstr" title="arg9">
<span class="arg-num">9</span>
<span class="required">TRUE</span>
<span class="arg-name">Tool</span>
<span class="dec-data">FALSE</span>
<span class="arg-symbol">tool0</span>
<span class="data-value">[TRUE,[[0,0,0],[1,0,0,0]],[-1,[0,0,0],[1,0,0,0],0,0,0]]</span>
<span class="data-type">tooldata</span>
<span class="obj-type">TASK PERS</span>
<span class="local">FALSE</span>
<span class="ndim">0</span>
</li>
</ul>
</div>
</body>
</html>

Resources

rap-module-rulesinstr rapid module suggested templete for data type or instruction.
arg-num Parameter number.
required TRUE for mandatory argument and FALSE for optional argument.
arg-name Parameter name
dec-data True if symbol declarataion needed
arg-symbol Argument symbol name or empty if literal
data-value Symbol initial value
data-type Symbol datatype
obj-type Object type like CONST, VAR and PERS.
local Declared locally if TRUE.
ndim Number of dimensions
num-args Number of arguments that are retrieved as part of the response.
mark Index value where it is started retrieving.
last All arguments are read if value is 1.
data-type(url parameter) Name parameter value is considered as data type when data-type value is true and default value is false.
parnum(url parameter) Formal parameter number to override rules
altnum(url parameter) Alternative parameter number to override rules and it can be used along with parnum to get optional parameters.
col(url parameter) column number
line(url parameter) row number.
name(url parameter) data type or instruction name.

Error Response

BAD_REQUEST(400)

NOT_FOUND(404), see HTTP Status codes

Robot controller errors, see Robot controller return codes

Sample Call

curl --digest -u "Default User":robotics "http://localhost/rw/rapid/modules/MainModule?resource=rules-instr&task=T_ROB1&name=movej"

Note

Not supported in bootserver mode