Get RAPID Object Child Details

URL

/rw/rapid/modules/{module}

Method

GET

URL Params

resource=object-child Required

task={task_name} Required

startline={startline} Required

startcolumn={startcolumn} Required

endline={endline} Required

endcolumn={endcolumn} Required

startline & startcolumn: refers to the start of the object
endline & endcolumn: referes to the end of object extent
choose the entire extent of the object, to obtain the details(children) of the object

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&resource=object-child&startline=1&startcolumn=1&endline=16&endcolumn=9" rel="self"/>
<ul>
<li class="rap-mod-child" title="object-child">
<span class="object-type">"module"</span>
<span class="nam-beg-line">1</span>
<span class="nam-beg-col">8</span>
<span class="nam-end-line">1</span>
<span class="nam-end-col">11</span>
<span class="sys-mod-beg-line">0</span>
<span class="sys-mod-beg-col">0</span>
<span class="sys-mod-end-line">0</span>
<span class="sys-mod-end-col">0</span>
<span class="nostepin-mod-beg-line">0</span>
<span class="nostepin-mod-beg-col">0</span>
<span class="nostepin-mod-end-line">0</span>
<span class="nostepin-mod-end-col">0</span>
<span class="viewonly-mod-beg-line">0</span>
<span class="viewonly-mod-beg-col">0</span>
<span class="viewonly-mod-end-line">0</span>
<span class="viewonly-mod-end-col">0</span>
<span class="readonly-mod-beg-line">0</span>
<span class="readonly-mod-beg-col">0</span>
<span class="readonly-mod-end-line">0</span>
<span class="readonly-mod-end-col">0</span>
<span class="type-def-beg-line">1</span>
<span class="type-def-beg-col">44</span>
<span class="type-def-end-line">1</span>
<span class="type-def-end-col">43</span>
<span class="data-decl-beg-line">3</span>
<span class="data-decl-beg-col">2</span>
<span class="data-decl-end-line">14</span>
<span class="data-decl-end-col">69</span>
<span class="rout-decl-beg-line">14</span>
<span class="rout-decl-beg-col">70</span>
<span class="rout-decl-end-line">14</span>
<span class="rout-decl-end-col">69</span>
<span class="endmod-beg-line">16</span>
<span class="endmod-beg-col">1</span>
<span class="endmod-end-line">16</span>
<span class="endmod-end-col">9</span>
</li>
</ul>
</div>
</body>
</html>

Resources

object-type: type of the object for which extent details are obtained.
extent details are: startline(beg-line), startcolumn(beg-col), endline(end-line), endcolumn(end-col)
Note
- output varies with the object type under consideration
- object type examples : module, procedure declaration, data declaration, function declaration etc.

Error Response

Bad Request(400), see HTTP Status codes

Sample Call

curl --digest -u "Default User":robotics "http://localhost:4444/rw/rapid/modules/base?resource=object-child&task=T_ROB1&startline=1&startcolumn=1&endline=16&endcolumn=9"

Note

Not supported in bootserver mode