Get details of the Rapid Object
URL
/rw/rapid/modules/{module}
Method
GET
URL Params
- task = {task} Required
- startrow= {start row} Required
- startcol= {start column} Required
- destination={Inner|Outer|Outer2|Before|After|Statement|InnerStatement} Optional
Data Params
None
Success Response
HTTP_OK(200), see HTTP Status codes
Example Response
<?xml version="1.0" encoding="UTF-8"?>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>rapid</title>
<base href="http://localhost:4444/rw/rapid/"/>
</head>
<body>
<div class="state">
<a href= "modules/BASE?task=T_ROB1&startrow=3&startcol=2&destination=Inner" rel="self"/>
<ul>
<li class="rap-object" title="object"> <span class="start-row">3</span>
<span class="start-column">2</span>
<span class="end-row">3</span>
<span class="end-column">50</span>
<span class="type">41</span>
<span class="list-num">1</span>
<span class="list-len">7</span>
<span class="data-type-id">NONE</span>
<span class="data-type-instance">0</span>
<span class="expression-type">0</span>
</li>
</ul>
</div>
</body>
</html>
Resources
- rap-object
- start-row Starting position of the row.
- start-column Starting position of the column.
- end-row Ending position of the row.
- end-column Ending position of the column.
- type Type of the object.
- list-num List element number.
- list-len Number of list elements.
- data-type-id Symbol name.
- data-type-instance Symbol name instance number.
- expression-type Expression type.
Error Response
BAD_REQUEST (400), FORBIDDEN(403), 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/BASE?task=T_ROB1&startrow=3&startcol=2&destination=Inner"
Notes
Not supported in bootserver mode