Robot Web Services
3HAC050973-001 Revision:M, Application Manual - Robot Web Services
Get Routineargs information

Gets the routine argument information at a given position.

URL

/rw/rapid/modules/{module}/routine

Method

GET

URL Params

  • resource=routine-args Required
  • mark={mark} (index of the element)
  • limit={numberofelements}
  • task={task} Required
  • row={row} Required
  • column={column} Required

See Common URL parameters

Data Params

None

Success Response

HTTP_OK(200)

see HTTP Status codes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<html>
<head>
<title>rapid</title>
<base href= "http://localhost:7777/rw/rapid/" />
</head>
<body>
<div class="state">
<a href= "modules/MainModule/routine?resource=routine-args&task=T_ROB1&row=4&column=9" rel="self"/>
<a href= "modules/MainModule/routine?resource=routine-args&mark=3&limit=3&task=T_ROB1&row=4&column=9" rel="next"/>
<ul>
<li class="rap-routine-args" title="arg0">
<span class="param-no">0</span>
<span class="alternate-arg">0</span>
<span class="start-row">4</span>
<span class="start-col">9</span>
<span class="end-row">4</span>
<span class="end-col">16</span>
<span class="rap-objtype">ObjectNameReference</span>
<span class="data-type">NONE</span>
<span class="list-num">0</span>
<span class="list-len">0</span>
</li>
<li class="rap-routine-args" title="arg1">
<span class="param-no">1</span>
<span class="alternate-arg">0</span>
<span class="start-row">4</span>
<span class="start-col">18</span>
<span class="end-row">4</span>
<span class="end-col">21</span>
<span class="rap-objtype">RequiredArgument</span>
<span class="data-type">num</span>
<span class="list-num">1</span>
<span class="list-len">503</span>
</li>
<li class="rap-routine-args" title="arg2">
<span class="param-no">2</span>
<span class="alternate-arg">0</span>
<span class="start-row">4</span>
<span class="start-col">24</span>
<span class="end-row">4</span>
<span class="end-col">30</span>
<span class="rap-objtype">RequiredArgument</span>
<span class="data-type">string</span>
<span class="list-num">2</span>
<span class="list-len">503</span>
</li>
</ul>
</div>
</body>
</html>

Resources

  • next Link to next page (Will be absent if there is no next page)
  • rap-routine-args RAPID routine argument list item
  • param-no Param number
  • alternate-arg Alternate argument number
  • start-row Starting row of argument
  • start-col Starting column of argument
  • end-row Ending row of argument
  • end-col Ending column of argument
  • rap-objtype Rap object type
  • data-type Argument data type
  • list-num List number of argument
  • list-len Total number of arguments

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/MainModule/routine?resource=routine-args&mark=3&limit=3&task=T_ROB1&row=4&column=9"

Notes

Routineargs will show a list of arguments based on the mark and limit.

Default value of mark is 0.

Absence of next link indicates last page.

You will get routine argument information only on lines having proceure call.

Not supported in bootserver mode.