.. include:: /Includes.rst.txt

========
Rest API
========

.. toctree::
   :hidden:
   :glob:

   rest/transactions
   rest/authentication
   rest/variableInstances
   rest/rawValuesViews
   rest/varValueCollection
   rest/snapshots
   rest/characteristics
   rest/rawValuesDB

Our REST Api is very fine granular and allows access to almost all our internal functions.

This part starts with a description of the api request transaction types in :ref:`transaction types<rest-transactions>` and continues with the api requests in a manner, that tries to order the queries sorted the way you might use them in an initial first setup and testing.

Start with :ref:`transaction types<rest-transactions>` and continue with :ref:`rest-authentication`.

.. note::
   All requests need to be called using your API url. |br|
   Usually it will look like this: `https://server:port/rest`