Robot Web Services
3HAC050973-001 Revision:M, Application Manual - Robot Web Services
Get elog messages in domain

Get a list of all elog messages in the given domain.

Also supports getting the number of events in the given domain, language specific elog messages and title only filter

URL

/rw/elog/{domain-number}

Method

GET

URL Params

See Common URL parameters

  • lang=[alphanumeric] Optional, a two letter language code e.g. en, sv, de, hi etc.
    • This option returns all the elog messages in the specified language.
    • example: lang=de
  • resource={count|info|title}**Optional**
    • count Returns the number of events in the given domain.
      • example: resource=count
    • info In addition to returning a list of all elog domain, this option returns the size of elog buffer and Number of event logs for each elog domain.
      • example: resource=info
    • title When this parameter is provided, only the elog message title is returned. Allowed only along with lang query parameter.
      • example: lang=de&resource=title
  • order={lifo|fifo} Optional
    • Return the elog messages in fifo or lifo order
    • example: order=fifo
  • elogseqnum=[numeric] Optional
    • Return the elog messages starting from the specified sequence number
    • example: elogseqnum=8

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>Elog</title>
    <base href="http://localhost/rw/elog/"/>
  </head>
  <body>

    <div class="state">      
      <a href="0" rel="self"></a>    
      <a href= "0?action=show" rel="action"/>
      <ul>                        
        <li class="elog-message-li" title="/rw/elog/0/5">
            <a href="0/5" rel="self"></a>          
            <span class="msgtype">1</span>
            <span class="code">10015</span>
            <span class="src-name">MC0</span>
            <span class="tstamp">2013-09-08 T 11:22:09</span>
            <span class="argc">0</span> 
        </li>
        <li class="elog-message-li" title="/rw/elog/0/4">
            <a href="0/4" rel="self"></a>          
            <span class="msgtype">1</span>
            <span class="code">10013</span>
            <span class="src-name">MC0</span>
            <span class="tstamp">2013-09-08 T 11:22:09</span>
            <span class="argc">0</span> 
        </li>
        <li class="elog-message-li" title="/rw/elog/0/3">
            <a href="0/3" rel="self"></a>          
            <span class="msg-type">1</span>
            <span class="code">10002</span>
            <span class="src-name">MC0</span>
            <span class="tstamp">2013-09-08 T 11:22:07</span>
            <span class="argc">2</span> 
            <span class="arg1" type="string">TRAFO</span>
            <span class="arg2" type="string">trafo_dm1</span>
        </li>
      </ul>       
    </div>
  </body>
</html>

Resources

  • elog-message-li
    • msg-type=[numeric]{0|1|2|3}** The elog message type
      • 0 Any event type. For search and trigger conditions only. Cannot be used when writing an event.
      • 1 State change, or informational event.
      • 2 Warning Event
      • 3 Error Event.
    • code=[numeric] The elog message code
    • src-name=[numeric] The elog message source
    • tstamp=[datetime] The time stamp when the event log was generated
    • argc=[numeric] The number of arguments present in this elog message
    • arg[n], type=[numeric] The argument's position e.g. arg1, arg2 etc..The type of argument can be float, string or long
    • title=[alphanumeric] The elog message title in the specified langauge. Available only when lang parameter is provided
    • desc=[alphanumeric] The elog message description in the specified langauge. Available only when lang parameter is provided
    • conseqs=[alphanumeric] The elog message consequences in the specified langauge. Available only when lang parameter is provided
    • causes=[alphanumeric] The elog message causes in the specified langauge. Available only when lang parameter is provided
    • actions=[alphanumeric] The elog message actions in the specified langauge. Available only when lang parameter is provided
  • elog-domain
    • numevts=[numeric] The number of elog messages in this domain
    • buffsize=[numeric] Size of elog buffer for this domain

Error Response

NOT_FOUND(404)

See Robot controller return codes

Sample Call

curl --digest -u "Default User":robotics "http://localhost/rw/elog/0"

curl --digest -u "Default User":robotics "http://localhost/rw/elog/0?resource=count"

curl --digest -u "Default User":robotics "http://localhost/rw/elog/0?lang=de&amp;resource=title"

curl --digest -u "Default User":robotics "http://localhost/rw/elog/0?lang=de"

curl --digest -u "Default User":robotics "http://localhost/rw/elog/0?order=fifo"

curl --digest -u "Default User":robotics "http://localhost/rw/elog/0?elogseqnum=8"

curl --digest -u "Default User":robotics "http://localhost/rw/elog/0?resource=info"

Notes

Not supported in bootserver mode