====/api/asset/detail====

===Usage===

This function is used to get detailed information about a particular asset.

This is part of the [[ardisdk:rest_language_agnostic_api|core API]].

This includes live information, media files and relationships that the asset has with its neighbours. It's the most complete information available about the asset.

If you only require properties, the function [[/api/asset/info]] is noticeably faster, as it doesn't have to fetch extended properties or media items. 

===Details==

^Detail^Value^
|Group|Asset|
|From Server Version|0.9.0|
|Permission|[[permission_guest|Guest]]|
|Methods|GET or POST|

==Parameters==

^Parameter^Notes^Meaning^
|**asset**|Number|The ID of the asset|
|**artag**|Number|The ID of the AR marker|
|**format**|String (xml)|Either 'xml' or 'json'|

Note that either **asset** or **artag** //must// be specified.

===Examples===

==Call==

<code>
http://ardiserver.com/api/getardetail?asset=5
</code>

==Success (XML)==

<code>
<?xml version="1.0" encoding="UTF-8"?>
<assets>
   <asset>
      <name>Site</name>
      <fullname>Site</fullname>
      <id>5</id>
      <description>This is your initial ARDI site</description>
      <isolation>
         <status>Unknown</status>
      </isolation>
      <upstreamalerts>no</upstreamalerts>
      <properties>
         <Address id="3" type="ADDRESS" name="Address" class="local" source="5" quality="good" group="">
            <address>18/2 Memorial Drive, Shellharbour City Center, NSW, Australia</address>
         </Address>
      </properties>
      <media />
      <alerts />
      <relationships>
         <related id="2" priority="301" name="Location" upname="Inside" downname="Contains">
            <to id="1" direction="upstream" name="Location" />
            <to id="43" direction="downstream" name="Switchroom" />
            <to id="44" direction="downstream" name="Workshop" />
            <to id="46" direction="downstream" name="Level One" />
            <to id="47" direction="downstream" name="Level Two" />
            <to id="49" direction="downstream" name="External" />
            <to id="94" direction="downstream" name="Mobile" />
         </related>
      </relationships>
      <zeroenergy>Yes</zeroenergy>
      <tags>
         <tag>Location</tag>
      </tags>
   </asset>
</assets>
</code>

==Success (JSON - 2026+)==

<code>
[
  {
    "isolation": "Unknown",
    "name": "Air Regulator",
    "fullname": "Air Regulator",
    "id": 32,
    "description": "",
    "properties": [
      {
        "name": "Equipment Tag",
        "id": 2,
        "origin": 32,
        "origintype": "local",
        "value": {
          "text": "",
          "_unlinkable": true
        },
        "group": ""
      },
      {
        "name": "Analytics",
        "id": -1,
        "origin": 32,
        "origintype": "local",
        "value": {
          "address": "/s/op/ceditor/menu?asset=32"
        },
        "group": ""
      },
      {
        "name": "Compare",
        "id": -1,
        "origin": 32,
        "origintype": "local",
        "value": {
          "address": "/s/op/compare/index?asset=32"
        },
        "group": ""
      },
      {
        "name": "Correlations",
        "id": -1,
        "origin": 32,
        "origintype": "local",
        "value": {
          "address": "/s/op/correlia/review/show?id=32"
        },
        "group": ""
      },
      {
        "name": "Description",
        "id": -1,
        "origin": 32,
        "origintype": "local",
        "value": {
          "address": "/s/op/descript?assetid=32"
        },
        "group": ""
      },
      {
        "name": "Data Explorer",
        "id": -1,
        "origin": 32,
        "origintype": "local",
        "value": {
          "address": "/s/op/dexplore/dash?id=32"
        },
        "group": ""
      }
    ],
    "media": [],
    "alerts": [],
    "relationships": {
      "name": "Type",
      "id": 3,
      "upname": "A Type Of",
      "downname": "Is Assigned To",
      "upstream": [
        [30, "Air Equipment"
        ]
      ],
      "downstream": [
        [164, "Mainline Air Regulator"
        ]
      ]
    },
    "tags": [
      "Types",
      "Equipment",
      "Air Equipment"
    ],
    "tagids": [3, 15, 30]
  }
]
</code>

See the [[old search json format]] for examples of the output before 2026.