Generic endpoints

GET /session

The first request sent by the XMM frontend is ususally to this endpoint, which will feed the UI with session information such as logged in status, available modules and languages, etc.

Note the missing trailing slash.

Example response (shortened):

HTTP/1.1 200 OK
Content-Type: application/json

{
  "config": {
    "notifierURL": "http://localhost:8101/notifier"
  },
  "datatypes": [
    {
      "label": "Logisch",
      "reference": "boolean",
    },
    {
      "label": "Text einzeilig",
      "reference": "string",
    }
  ],
  "default_locale": "de",
  "editorstyles": [],
  "locales": [
    [
      "de",
      "Deutsch"
    ]
  ],
  "notifications": {
    "category": null,
    "unread": 0
  },
  "user": {
    "id": "5577fbbd2205e145670dbdf1",
    "label": "Julian Wachholz",
    "role_label": "Administratoren"
  },
  "version": "1.0.0"
}

GET /admin/counts/

Gets current number of instances for each available model in the admin section of the XMM.

Example Response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "blocktypes": 6,
  "models": 7,
  "nodetypes": 5,
  "notifications": 0,
  "pagetypes": 6,
  "tasks": 4,
  "units": 22,
  "userroles": 3,
  "users": 16
}

GET /admin/sysinfo/

Shows current system information such as library versions and server hardware resources.

Example Response (shortened):

HTTP/1.1 200 OK
Content-Type: application/json

{
  "sysinfo": [
    [
      "XMM Version",
      "1.0.0"
    ],
    [
      "Python Version",
      "3.5.1"
    ],
    [
      "MongoDB Server",
      "2.6.10"
    ],
    [
      "Elasticsearch Version",
      "1.7.5"
    ],
    [
      "System CPU",
      "8 cores@2200MHz"
    ],
    [
      "System RAM",
      "16GB"
    ]
  ]
}