Returns any active UI instruction resource

URL

/rw/rapid/uiinstr/active

Method

GET

URL Params

See Common URL parameters

Data Params

None*

Success Response

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

Error Response

BAD REQUEST(400),NOT_FOUND(404) see HTTP Status codes

Robot controller errors, see Robot controller return codes

Sample Rapid Code

Example 1:

MODULE MainModule
VAR num NumTest := 10;
CONST string NumTestStr := "";

PROC main()
TPErase;
TPWrite"A1234567890123456789012345678901234567890123456789012345678901234567890123456789";
TPWrite"B1234567890123456789012345678901234567890123456789012345678901234567890123456789";
TPWrite"C1234567890123456789012345678901234567890123456789012345678901234567890123456789";
TPWrite"D1234567890123456789012345678901234567890123456789012345678901234567890123456789";
TPWrite"E1234567890123456789012345678901234567890123456789012345678901234567890123456789";
TPWrite"F1234567890123456789012345678901234567890123456789012345678901234567890123456789";
TPReadFK reg1, "Show the layout","","","","","OK";
TPReadNum NumTest, NumTestStr;

ENDPROC

ENDMODULE

Example 2:

UIMsgBox \Header:="UIMsgBox Header", "Message Line 1"
\MsgLine2:="Message Line 2" \MsgLine3:="Message Line 3" \MsgLine4:="Message Line 4"
\MsgLine5:="Message Line 5" \Buttons:=btnOKCancel \Icon:=iconInfo \Result:=answer;

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/"/>
</head>
<body>
<div class="state">
<a href="active" rel="self"/>
<ul>
<li class="rap-uiactive-li">
<span class="instr">TPReadNum</span>
<span class="event">SEND</span>
<span class="stack">RAPID/T_ROB1/%$104</span>
<span class="execlv">NORMAL</span>
<span class="msg"/>
<a href="active/params/RAPID/T_ROB1/%25%24104" rel="params"/>
<a href="active/param/RAPID/T_ROB1/%25%2499/Result" rel="param"/>
</li>
</ul>
</div>
</body>
</html>

Resources

rap-uiactive-li The pending UI instruction resource
instr - Instruction is one of {IAlphaEntry | IListView | IMessageBox | IMsgBox | INumEntry | INumTune | IShow | TPErase | TPReadFK | TPReadNum | TPShow | TPWrite}.
event - Event is one of {SEND | POST | ABORT}.
stack - The stack url, a link to the UI instruction parameters.
execlv - Rapid task execution level.
msg - Line of text
params - Link to UI message parameters. The parameters are defined in the RAPID manual.
param - Link to UI message parameter.

Error Response

Not Found(404), see HTTP Status codes

Sample Call

curl --digest -u "Default User":robotics "http://127.0.0.1/rw/rapid/uiinstr/active"

Notes

Not supported in bootserver mode