Documentation
=============

The Open Object API consists of two main resources: :ref:`Objecttypes` & :ref:`Objects`.
Objecttypes contains the object definitions and Objects the instances of these Objecttypes.

Designed in line with the `Common Ground`_ model, they can be used by other APIs that need
to store object specific data.

Open Object is and only uses :ref:`introduction_open-source`.

.. _`Common Ground`: https://commonground.nl/

Getting started
---------------

To get you started, you might find some of these links relevant:

* New to this project? Have a look at the :ref:`introduction_index`
* New to the API? Read up on the :ref:`api_index`.
* Want to get started now? Follow the :ref:`installation_quickstart`
* Want to know how the admin interface works? Go to the :ref:`admin_index`


.. _Objecttypes:

Objecttypes
-----------

Standardize various types of objects in an accessible way and without the need to create
a whole new API for each (simple) object.

.. _Objects:

Objects
-------

Easily store and expose various objects and make them
available in a standardized format. It can be used by any
organization to manage relevant objects. An organization can also choose to use it
to expose objects to the public as *Open Data*.


.. toctree::
   :maxdepth: 2
   :hidden:

   introduction/index
   api/index
   admin/index
   installation/index
   manual/index
   examples/index
   changelog