logo
Documentation Powered by ReDoc

EasyDose QMCoreNode API (0.0.1)

Download OpenAPI specification:Download

E-mail: support@bms-austria.com License: Apache 2.0

Basic API specification for EasyDoseQM Versions >= 1.6.102

Authentication

qmcorenode_auth

EasyDoseQM uses a session based authentication scheme with tokens. The session token is returned as cookie within the response of the authentication request. Use this token (cookie) in all requests.

Security Scheme Type API Key
Cookie parameter name: EDQM

users

User management. Currently only contains calls to authenticate users.

Authenticate user and start a new session

Send credentials to the server and authenticate the user. The session token is returned in the response cookie. This cookie must be used in all subsequent requests to the server.

Request Body schema: application/json
username
string
password
string

Responses

Request samples

Content type
application/json
{
  • "username": "username",
  • "password": "password"
}

Response samples

Content type
application/json
{
  • "userid": 0,
  • "username": "string",
  • "modarray": [
    ],
  • "permission": "string",
  • "language": "string",
  • "fullname": "string",
  • "canChangePassword": true
}

Sign out the current user and destroy server-side session

Removes the session information from the server.

Authorizations:
qmcorenode_auth

Responses

query

Data management. Query and analyze server data.

Query data from server

Sends the query information to the server for processing. The result will be cached on the server (default 300 seconds).

Authorizations:
qmcorenode_auth
Request Body schema: application/json
fields
required
Array of strings (Fields)
object (Filter)
Array of objects (Sort)
force
boolean

do not use cached data (optional)

skip
integer

skip rows from the result set (optional)

take
integer

number of rows to fetch from result set (optional)

Responses

Request samples

Content type
application/json
{
  • "fields": [
    ],
  • "filter": {
    },
  • "sort": [
    ],
  • "force": true,
  • "skip": 0,
  • "take": 0
}

Response samples

Content type
application/json
{
  • "meta": { },
  • "result": [
    ],
  • "count": 0
}

Analyze data from server

Sends the analysis information to the server for processing. An analysis is equivalent to a SQL query using aggregate functions. The "group by" clause is the "x" parameter. And the "y" parameter holds all aggregated fields. The result will be cached on the server (default 300 seconds).

Authorizations:
qmcorenode_auth
Request Body schema: application/json
fields
required
Array of strings (Fields)
object (Filter)
Array of objects (Sort)
force
boolean

do not use cached data (optional)

skip
integer

skip rows from the result set (optional)

take
integer

number of rows to fetch from result set (optional)

x
string

Category of the analysis (X-Axis)

object (QueryYAxis)

Contains fieldnames each with an array of aggregates

Responses

Request samples

Content type
application/json
{
  • "fields": [
    ],
  • "filter": {
    },
  • "sort": [
    ],
  • "force": true,
  • "skip": 0,
  • "take": 0,
  • "x": "string",
  • "y": {
    }
}

Response samples

Content type
application/json
{
  • "meta": { },
  • "result": [
    ],
  • "count": 0
}