Skip to content

GitLab

  • Menu
Projects Groups Snippets
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • A api
  • Project information
    • Project information
    • Activity
    • Members
  • Packages & Registries
    • Packages & Registries
    • Package Registry
    • Container Registry
    • Infrastructure Registry
  • Wiki
    • Wiki
  • Activity
Collapse sidebar
  • ironapi
  • api
  • Wiki
  • Api
  • Introduction

Introduction · Changes

Page history
update authored May 25, 2021 by Andrea Pavlovic's avatar Andrea Pavlovic
Hide whitespace changes
Inline Side-by-side
API/Introduction.md
View page @ c2b47ae8
......@@ -2,7 +2,7 @@
The API to the database is generated automatically. This is possible because all relevant ACL and consistency checks are implemented in the database.
Which data endpoints are available to a user is publicized in the [[Universe]] endpoint, which is available one a user has logged in.
Which data endpoints are available to a user is publicized in the [Universe](Universe) endpoint, which is available one a user has logged in.
It is a JSON structure describing the structure of the database and listing all data endpoints with their options as available to the user.
......@@ -15,4 +15,4 @@ The main data endpoints are
* [Queries](Queries) - /data/$module/$entity/query - retrieve data from an entity (=table)
* [Transitions](Transitions) - /data/$module/$entity/$instance/transitions/$transition_name - change data of instance (=row)
[Plugins](Plugins) - /plugins/$plugin_name - plugins are similar to functions. They are used when queries and transitions are insufficient, e.g. because a query is too complex or calls get combined for performance reasons. The plugin parameters are defined in the universe, the reply structure is currently not documented there.
\ No newline at end of file
[Plugins](Plugins) - /plugins/$plugin_name - plugins are similar to functions. They are used when queries and transitions are insufficient, e.g. because a query is too complex or calls get combined for performance reasons. The plugin parameters are defined in the universe, the reply structure is currently not documented there.
Clone repository
  • API
    • Available Endpoints
    • Changing Passwords
    • Form Input Types
    • Introduction
    • Logout
    • Plugins
    • Queries
    • Queries
      • Attributes
      • Context
      • Query Examples
      • Query Search Options
      • Referenced Instances
      • Saved Queries
    • Schema_Changes
    • Storing Files
View All Pages