.. cloudplan API documentation master file, created by
   sphinx-quickstart on Wed Oct 10 09:17:39 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to cloudplan's API documentation!
=========================================

Getting Started
---------------

If you are new you can check out the  :doc:`quickstart`



Authentication
--------------

Each API call is authenticated with a ``session id``, that can be obtained with the :doc:`api/user/login` request and has to be sent in the HTTP header::

    session_id: 5BBC7AEA7AAF01733BC25ED64DBC9D38



Layout
------

The `cloudplan API` on a high level is divided into modules that concern different things like `users` or `folder`. 

The api functions are executed in the context of the currently logged in user (determined through the session id). So a `api/user/me` request will return information about yourself, the current user.


.. toctree::
   :maxdepth: 2
   :caption: API Modules:

   api/file/index
   api/folder/index
   api/user/index
   api/weblink/index
   api/workflow/index
   api/organisation/index
   api/docclass/index
   api/search/index
   api/tables/index

.. toctree::
   :maxdepth: 1
   :caption: Other

   quickstart
   tutorials/index
   api/index
   misc/node_errors

.. Indices and tables
.. ==================

.. * :ref:`genindex`
.. * :ref:`search`
.. * :ref:`modindex`