Tools - RESTful API

Summary:

Lists tools available on the server.

URL:

http(s)://{server hostname}/api/tools

Methods summary

GET Method detail

Methods summary

• GET Methods - lists all tools available on the server.

GET Method detail

Lists all tools available on the server.

Response:

The list of tools are grouped into subgroups, where every entry has the following format:

Examples:

INPUT
curl -u admin:admin https://localhost/api/tools?media=json

OUTPUT
{
  "items" : [ {
    "subgroup" : "Administrator Tools",
    "tools" : [ {
      "id" : 79,
      "name" : "Event Administration"
    }, {
    ...removed for brevity...
    }, {
      "id" : 111,
      "name" : "UD Polling"
    } ]
  }, {
  ...removed for brevity...
  }, {
    "subgroup" : "Tools",
    "tools" : [ {
      "id" : 15,
      "name" : "Ticker"
    }, {
    ...removed for brevity...
    }, {
      "id" : 112,
      "name" : "Configuration Management"
    } ]
  ...removed for brevity...
  } ],
  "count" : 6
}

INPUT
curl -u admin:admin https://localhost/api/tools?media=xml

OUTPUT
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<items count="6">
  <item xsi:type="toolsGroup" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance">
    <subgroup>Administrator Tools</subgroup>
    <tools>
      <tools name="Event Administration" id="79"/>
    ...removed for brevity...
      <tools name="UD Polling" id="111"/>
    </tools>
  </item>
  ...removed for brevity...
  <item xsi:type="toolsGroup" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance">
    <subgroup>Tools</subgroup>
    <tools>
      <tools name="Ticker" id="15"/>
      ...removed for brevity...
      <tools name="Configuration Management" id="112"/>
    </tools>
  </item>
  ...removed for brevity...
</items>