Technical information
RMS NetLinx Virtual Device API
144
RMS Enterprise - NetLinx Programmer’s Guide
RMS Asset Location - Command API
RMS Asset Location Query Commands
RMS Asset Metadata Properties - Command API
RMS Asset Metadata Properties Query Commands
RMS Asset Location Query Commands
Query Command Description / Response Commands
?ASSET.LOCATION-
<asset-client-key>
This command is used to query the RMS server for asset location information for a specific asset.
<asset-client-key>: The asset client key of the asset you wish to query must be included. This asset client
key is typically the D:P:S string in NetLinx systems.
The following response command will be returned in response to this query.
ASSET.LOCATION-<asset-client-key>,
<location-id>,
<location-name>,
<location-owner>,
<location-phone-number>,
<location-occupancy>,
<location-prestige-name>,
<location-timezone>,
<location-asset-licensed>
If no location can be found, then only the asset client key parameter will be returned:
ASSET.LOCATION-<asset-client-key>
RMS Asset Metadata Properties Query Commands
Query Command Description / Response Commands
?ASSET.METADATA
<asset-client-key>
This command is used to query for all asset metadata records for a specific asset from the RMS server.
Arguments:
<asset-client-key>: The asset client key of the asset you wish to query must be included. This asset client
key is typically the D:P:S string in NetLinx systems.
An ASSET.METADATA.RECORD.COUNT command string followed by a series of
ASSET.METADATA.RECORD commands will be returned in response to this query.
First a total count is returned.
ASSET.METADATA.RECORD.COUNT-
<asset-client-key>,
<metadata-record-count>
If the record count is greater than zero, then a series of the following command responses will be sent:
ASSET.METADATA.RECORD-
<asset-client-key>,
<record-index>,
<record-count>,
<metadata-key>,
<metadata-name>,
<metadata-value>,
<metadata-data-type>,
<metadata-read-only>
(,<metadata-hyperlink-name>)
(,<metadata-hyperlink-url>)
?ASSET.METADATA-
<asset-client-key>,
<metadata-key>
This command is used to query for a specific asset metadata property from the RMS server.
Arguments:
• <asset-client-key>: The asset client key of the asset you wish to query must be included. This asset
client key is typically the D:P:S string in NetLinx systems.
• <metadata-key>: This field is the asset metadata property key string used to uniquely identify the
metadata property scoped to this asset.
The asset metadata property record will be returned in the following response command format:
ASSET.METADATA-<asset-client-key>,
<metadata-key>,
<metadata-name>,
<metadata-value>,
<metadata-data-type>
<metadata-read-only>,
(,<metadata-hyperlink-name>)
(,<metadata-hyperlink-url>)