Technical information

RMS NetLinx Virtual Device API
156
RMS Enterprise - NetLinx Programmer’s Guide
RMS Hotlist Query Commands (Cont.)
Query Command Description / Response Command
?HOTLIST.RECORD-
<start>(,<length>)(,<location-id>)
This command will query the RMS client hotlist record cache and return the requested hot-
list record(s).
The <start> argument can be either a '*' character or a number representing which index
position to start at. If the '*' character is assigned to the start parameter the query will return
all hotlist records. The collection is '1' based and should start at index 1 (not '0').
The <length> argument is optional and can be a number representing how many records to
return. If this argument is not specified, then a length of 1 is assumed.
The <location-id> argument is optional. If included the hotlist query will perform a lookup on
the specified location. If omitted, the hotlist query will perform a lookup on the client gate-
way's default location.
Examples:
Return all records:
SEND_COMMAND vdvRMS, '?HOTLIST.RECORD-*'
Return only first record:
SEND_COMMAND vdvRMS, '?HOTLIST.RECORD-1'
Return first 10 records:
SEND_COMMAND vdvRMS, '?HOTLIST.RECORD-1,10'
Return records 5-10 records:
SEND_COMMAND vdvRMS, '?HOTLIST.RECORD-5,5'
The hotlist record will be returned in the following command response format:
HOTLIST.RECORD-<location-id>,
<record-index>,
<record-count>,
<hotlist-record-id>,
<hotlist-type-id>,
<hotlist-type-name>,
<status-type-id>,
<status-type-name>,
<priority-level>,
<description>,
<relative-date-string>,
<relative-time-string>,
<asset-id>,
<asset-name>,
<asset-parameter-id>,
<asset-parameter-name>,
<asset-parameter-threshold-id>,
<asset-parameter-threshold-name>,
<asset-parameter-threshold-comparison-operator>,
<asset-parameter-threshold-value>
?HOTLIST.RECORD.ID-
<start>(,<length>)(,<location-id>)
This command will query the RMS client hotlist record cache and return the requested hot-
list record id(s).
The <start> argument can be either a '*' character or a number representing which index
position to start at. If the '*' character is assigned to the start parameter the query will return
all hotlist records. The collection is '1' based and should start at index 1 (not '0').
The <length> argument is optional and can be a number representing how many records to
return. If this argument is not specified, then a length of 1 is assumed.
The <location-id> argument is optional. If included the hotlist query will perform a lookup on
the specified location. If omitted, the hotlist query will perform a lookup on the client gate-
way's default location.
The hotlist record(s) will be returned in the following command response format:
HOTLIST.RECORD.ID-<location-id>,
<record-index>,
<record-count>,
<hotlist-record-id>