Introduction to Tool APIs
-------------------------

This section describes API calls that are not related to a specific
model. The full URL would include the host name: *http://[hostname]*. 

The calls described here all contain ``/tool/`` in the URL
and the full list can be obtained by the GET call for ``choices``:

.. tabularcolumns:: |p{1.5cm}|p{1cm}|p{3cm}|p{5cm}|p{5cm}|

+------------+------+--------------------+-----------------------+----------------------------------+
| Task       | Call | URL                | Parameters            | Response                         |
+============+======+====================+=======================+==================================+
| List tools | GET  | /api/tool/choices/ | format=json           | JSON format of the list of tools |
|            |      |                    |                       | as ``title`` - ``value`` pairs.  |
|            |      |                    | hierarchy=[hierarchy] |                                  |
|            |      |                    |                       |                                  |
+------------+------+--------------------+-----------------------+----------------------------------+




.. tool/TestConnection
   tool/CascadeDelete
   tool/BulkLoad
   tool/Macro
   tool/Search
   tool/DataMove
   tool/Theme
   tool/Transaction
   tool/DataExtract
   tool/DataImport
   tool/RelationalQuery



Variables are enclosed in square brackets, e.g.:

* [hierarchy] is the hierarchy UUID
* [filename] refers to a file

Other parameters are described with the relevant API call.

.. |VOSS Automate| replace:: VOSS Automate
.. |Unified CM| replace:: Unified CM