Robot Web Services
3HAC050973-001 Revision:M, Application Manual - Robot Web Services
Get all attributes of the given domain type

Returns a list of attributes supported by this domain type with their properties.

URL

/rw/cfg/{domain}/{type}/attributes

Method

GET

URL Params

None

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>cfg</title>
    <base href="http://localhost/rw/cfg/"/>
</head>
<body>
    <div class="state">
    <a href="eio/INDUSTRIAL_NETWORK/attributes" rel="self"/>
    <ul>
        <li class="cfg-dt-attribute-li" title="Name">
            <span class="name">Name</span>
            <span class="type">string</span>
            <span class="numbers">1</span>
            <span class="min"/>
            <span class="max"/>
            <span class="init"/>
            <span class="mandatory">false</span>
        </li>
        <li class="cfg-dt-attribute-li" title="Connection">
            <span class="name">Connection</span>
            <span class="type">string</span>
            <span class="numbers">1</span>
            <span class="min"/>
            <span class="max"/>
            <span class="init"/>
            <span class="mandatory">false</span>
        </li>
        <li> ... </li>
    </ul>               
    </div>
</body>
</html>

Resources

  • cfg-dt-attribute-li
    • name=[string] Attribute name.
    • type=[string] The type of attribute. Can be {char | string | long | ulong | short | ushort | bool | float | byte}.
    • numbers=[numeric] Array size if an array, otherwise 1
    • mini=[alphanumeric] Min value for range checking. The min length, if the attribute is a string.
    • max=[alphanumeric] Max value for range checking. The max length, if the attribute is a string.
    • init=[aplhanumeric] Default value of this attribute
    • mandatory=[true|false] A boolean indicating if this attribute is mandatory.

Error Response

BAD_REQUEST(400)

Robot controller errors, See Robot controller return codes

Sample Call

curl --digest -u "Default User":robotics "http://localhost/rw/cfg/eio/INDUSTRIAL_NETWORK/attributes"

Notes

Not supported in bootserver mode