====/api/getconfiguration====

===Usage===

This function returns details about the ARDI database - specifically, information regarding properties, relationships, and detailed instructions on how to display both. This is part of the [[ardisdk:rest_language_agnostic_api|core API]].

===Details==

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

==Parameters==

^Parameter^Notes^Meaning^
|**format**|String (xml)|Either 'xml' or 'json'|

===Return Value===

The return value is an XML or JSON file that gives you information about...

^Element^Meaning^
|Profiles|A list of data profiles and their ID numbers.|
|Properties|A list of properties, their names and ID numbers, plus any special display options, such as a custom gradient or mapping between value and colour.|
|Relationships|A list of relationships, their names, ID numbers, colours and view options.|

===Examples===

==Request==

<code>
http://<servername>/s/<sitename>/api/getconfiguration
</code>

==Success (XML)==

<code>
<config>
  <relations>
    <relationship name="Location" id="2" upname="Inside" downname="Contains" passes="" colour="#FA68DA" type="heirachial" hideinwalker="yes"/>
    <relationship name="Type" id="3" upname="A Type Of" downname="Is Assigned To" passes="" colour="" type="category"/>
    <relationship name="Data" id="4" upname="Taken From" downname="Fed To" passes="" colour="" type="logical"/>
    <relationship name="Control" id="5" upname="Controled By" downname="Controls" passes="" colour="#c20ec5" type="logical"/>
...
  </relations>
  <properties>
    <property name="Equipment Tag" id="2" type="TAG"/>
    <property name="Address" id="3" type="ADDRESS"/>
    ...
    <property name="Temperature - AC Setpoint" id="23" type="MEASUREMENT">
       <display>
          <range type="fixed" min="17" max="27"/>
          <gradient stops="00ffff_65.4_%25__00ff00_84.3_%25__ffea00_100_%25"/>
       </display>
      </property>
      <property name="Water Usage" id="21" type="MEASUREMENT">
        <display>
          <range type="floating" min="0" max="100"/>
        </display>
      </property>
    </properties>
    <profiles>
       <profile name="Actual" id="1" port="8085"/>
    </profiles>
</config>
</code>

==Success (JSON - 2026+)==


<code>
{
   "relationships":  
   [   { 
      "name":"Location",
      "id": 2,
      "upname":"Inside",
      "downname":"Contains",
      "passes":"",
      "colour":"",
      "type":"heirachial"
   },
   {
      "name":"Natural Gas",
      "id":14,
      "upname":"sent gas from",
      "downname":"sends gas to",
      "passes":"53",
      "colour":"#dee77e",
      "type":"physical"
      } 
   ],
   ,
  "properties": [
    {
      "name": "Equipment Tag",
      "type": "TAG",
      "id": 2
    },
    {
      "name": "Address",
      "type": "ADDRESS",
      "id": 3
    },
  "profiles": [
    {
      "name": "Actual",
      "id": 1,
      "reqport": 8096
    }
  ]
  </code>
  
See the [[old search json format]] for examples of the output before 2026.