List Generic Action
---------------------

.. tabularcolumns:: |p{4cm}|p{10.5cm}|

+---------------+---------------------------------------------------------------------------------+
| Action        | list                                                                            |
+===============+=================================================================================+
| title         | List the resources of a given type in the system.                               |
+---------------+---------------------------------------------------------------------------------+
| method        | GET                                                                             |
+---------------+---------------------------------------------------------------------------------+
| URL           | /api/<resource_type>/<resource_name>/                                           |
+---------------+---------------------------------------------------------------------------------+
| Parameters    | hierarchy=[hierarchy], format=json. The schema is returned irrespective         |
|               | of whether the parameter ``&schema=true`` is sent.                              |
+---------------+---------------------------------------------------------------------------------+
| Response      | The <resource_type>/<resource_name> schema and all instances in JSON format.    |
| method        |                                                                                 |
+---------------+---------------------------------------------------------------------------------+
| support_async | false                                                                           |
+---------------+---------------------------------------------------------------------------------+
| class         | list                                                                            |
+---------------+---------------------------------------------------------------------------------+





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