Get a list of actions that can be invoked on a RAPID symbols.

URL

/rw/rapid/symbols

Method

GET

URL Params

action=show Required

Returns action forms for this resource

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 xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>rapid</title>
<base href="http://127.0.0.1/rw/rapid/"/>
</head>
<body>
<div class="state">
    <a href="symbols" rel="self"/>
    <form action="/rw/rapid/symbols?action=search-symbols" id="search-symbols" method="post">
        <input checked="checked" name="view" type="radio" value="block"/>
        <input name="view" type="radio" value="scope"/>
        <input name="view" type="radio" value="stack"/>
        <input name="posl" type="text" value="0"/>
        <input name="posc" type="text" value="0"/>
        <input name="blockurl" type="text" value="RAPID"/>
        <input name="stack" type="text" value="0"/>
        <select name="recursive">
            <option value="true"/>
            <option value="false"/>
        </select>
        <select name="onlyused">
            <option value="true"/>
            <option value="false"/>
        </select>
        <select name="skipshared">
            <option value="true"/>
            <option value="false"/>
        </select>
        <input name="regexp" type="text" value=""/>
        <input name="symtyp" type="checkbox" value="atm"/>
        <input name="symtyp" type="checkbox" value="rec"/>
        <input name="symtyp" type="checkbox" value="ali"/>
        <input name="symtyp" type="checkbox" value="rcp"/>
        <input name="symtyp" type="checkbox" value="con"/>
        <input name="symtyp" type="checkbox" value="var"/>
        <input name="symtyp" type="checkbox" value="per"/>
        <input name="symtyp" type="checkbox" value="par"/>
        <input name="symtyp" type="checkbox" value="lab"/>
        <input name="symtyp" type="checkbox" value="for"/>
        <input name="symtyp" type="checkbox" value="fun"/>
        <input name="symtyp" type="checkbox" value="prc"/>
        <input name="symtyp" type="checkbox" value="trp"/>
        <input name="symtyp" type="checkbox" value="mod"/>
        <input name="symtyp" type="checkbox" value="tsk"/>
        <input name="symtyp" type="checkbox" value="any"/>
        <input name="dattyp" type="text" value=""/>
    </form>
</div>
</body>
</html>

Actions

search-symbols
view Search for symbols in {block | scope | stack}
posl Line position in module
posc Column position in module (if posl and posc are both 0 is the blockurl used instead)
blockurl Relative URL describing the block where the search should start. A relative url never has a leading '/'. The global block, with shared symbols, has the url 'RAPID'.
stack The stackframe to search when searching in stack. Current stackframe is always 1.
recursive True if the search should be recursive.
onlyused True if only used symbols should be returned.
skipshared True if shared symbols should be skipped
regexp
dattyp Search for symbols of 'data-type'
symtyp Search for symbol of symbol type:
- atm Atomic symbol. For example, the predefined symbol 'num' has type Atomic.
- rec Record type. For example, the predefined symbol 'RobTarget' has type Record.
- ali Alias type.
- rcp Record component.
- con Constant. For example, 'myvar' in the declaration 'CONST num myvar = 1;' has type Constant.
- var Variable. For example, 'myvar' in the declaration 'VAR num myvar;' has type Variable.
- per Persistent. For example, 'myvar' in the declaration 'PERS num myvar=1;' has type Persistent.
- par Parameter
- lab Label
- for For statement
- fun Function
- prc Procedure
- trp Trap
- mod Module
- tsk Task
- any Any type

Error Response

BAD_REQUEST(400)

HTTP Errors, see HTTP Status codes

See Robot controller return codes

Sample Call

curl --digest -u "Default User":robotics" "http://127.0.0.1/rw/rapid/symbols?action=show"

Notes

Not supported in bootserver mode