/api/asset/search
Usage
This function is used to search for an asset based on a query string.
This search follows the same rules as searching in the ARDI web interface, meaning that the system will explore all asset properties - including part numbers, ERNs, names, descriptions etc. - when searching.
If using the API to create a bridge between ARDI and another 3rd party system, we suggest creating a property in ARDI to store the 3rd party systems unique ID for the asset. This allows extremely precise lookups in the future.
Details
Detail | Value |
---|---|
Group | Asset |
From Server Version | 0.9.0 |
Permission | Guest |
Methods | GET or POST |
Parameters
Parameter | Notes | Meaning |
---|---|---|
q | String [Required] | The query string to search for |
format | String (xml) | Either 'xml' or 'json' |
Examples
Call
http://ardiserver.com/s/sitename/api/asset/search?q=AN62993
Success (XML)
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <results> <asset id="175" name="AN6-2993 Drive" ern="" fullname="Main Office Lower Ground Slurry System Primary Pump AN6-2993 Drive"/> <asset id="178" property="5" name="Primary Pump" ern="PU12-92B" fullname="Main Office Lower Ground Slurry System Primary Pump"/> </results>
Success (JSON)
{ "results": [{ "asset": [{ "id": "175", "name": "AN6-2993 Drive", "ern": "", "fullname": "Main Office Lower Ground Slurry System Primary Pump AN6-2993 Drive" }, { "id": "178", "name": "Primary Pump", "ern": "PU12-92B", "fullname": "Main Office Lower Ground Slurry System Primary Pump" }] }] }