Create a Rapid program and define aliases for the IO signals. When the program is running, the API returns all the aliases which are defined in the program.

URL

/rw/rapid/aliasio

Method

GET

URL Params

start={start position} Optional

limit={number of aliasios} Optional

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="aliasio?start=0" rel="self"/>
<ul>
<li class="rap-alias-io" title="aliasio0"> 
<span class="alias-name">signaldi1</span>
<span class="signal-name">TestD1</span>
<span class="type">DI</span>
</li>
<li class="rap-alias-io" title="aliasio1">
<span class="alias-name">signaldi2</span>
<span class="signal-name">TestD2</span>
<span class="type">DI</span>
</li>
</ul>
</div>
</body>
</html>

Resources

rap-alias-io Rapid AliasIO resource
- alias-name IO signal alias name
- signal-name name of the IO signal
- type IO signal type {DI/ DO/ AI/ AO/ GI/ GO}

Error Response

BAD_REQUEST (400)

See Robot controller return codes

Sample Call

curl --digest -u "Default User":robotics" "http://127.0.0.1/rw/rapid/aliasio?start=0"

Notes

Not supported in bootserver mode