Get active UI instruction parameters

URL

/rw/rapid/uiinstr/active/params/{stackurl}

Method

GET

URL Params

See Common URL parameters

Data Params

None*

Success Response

HTTP_OK(200), if there is an active UI instruction.

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/rw/rapid/uiinstr/active/"/>
</head>
<body>
<div class="state">
<a href= "params" rel="self"/>
<ul>
<li class="rap-uiparams-li" title="Result">
<span class="value">0</span>
<a href="params/RAPID/T_ROB1/%25%2499/Result" rel="self"/>
</li>
<li class="rap-uiparams-li" title="TPCompleted">
<span class="value">FALSE</span>
<a href="params/RAPID/T_ROB1/%25%2499/TPCompleted" rel="self"/>
</li>
<li class="rap-uiparams-li" title="Header">
<span class="value">"UIMsgBox Header"</span>
</li>
<li class="rap-uiparams-li" title="MsgArray">
<span class="value">["Message Line 1","Message Line 2","Message Line 3","Message Line 4","Message Line 5"]</span>
</li>
<li class="rap-uiparams-li" title="Wrap">
<span class="value">FALSE</span>
</li>
<li class="rap-uiparams-li" title="Buttons">
<span class="value">2</span>
</li>
<li class="rap-uiparams-li" title="Icon">
<span class="value">1</span>
</li>
<li class="rap-uiparams-li" title="DIpass">
<span class="value">FALSE</span>
</li>
<li class="rap-uiparams-li" title="DOpass">
<span class="value">FALSE</span>
</li>
<li class="rap-uiparams-li" title="InstrUsingIMessageBox">
<span class="value">"UIMsgBox"</span>
</li>
</ul>
</div>
</body>
</html>

Resources

rap-uiparam-li UI instruction parameter
title Parameter name
value Parameter value

Error Response

BAD_REQUEST(400), NOT_FOUND(404), see HTTP Status codes

See Robot controller return codes

Sample Call

curl --digest -u "Default User":robotics "http://127.0.0.1/rw/rapid/uiinstr/active/params/RAPID/T_ROB1/%25%2499"

Notes

Not supported in bootserver mode