API v1.15.0+

Once a key has been created in the Settings->General->Misc->API section, the API can be used to execute Data+ Server functions.

Header

Field	Value
content-type	application/json
authorization	[apiKey]

Mail

The default mail settings of the server will be used.

POST/api/mail/send

Send a mail.

Body

Field	Value	Type
to	Mail destination (comma separated for multiple)	string
from	Mail sender display name	string
subject	Subject of the mail	string
content	Content of the mail	string
html (optional)	Determines if the content should be send as HTML rather than plain text	boolean

Example

{
    "to":"recipient@company.com",
    "from":"no-reply@company.com",
    "subject":"Test eMail",
    "content":"Dear recipient \n This is a test message"
}

Task

GET/api/task/info

Get information of all tasks, returns a list of QMC TaskOperational Objects.

GET/api/task/info/[taskId]

Get information of a specific task, returns a list of QMC TaskOperational Objects (which should be 1).

POST/api/task/start

Start a reload task.

Body

Field	Value	Type
taskId	Id of the task to start	string

Example request

{
    "taskId":"0ea90134-09c0-4c50-a0f5-a9bd677e61cc"
}

Status v2.2.0+

GET/api/status

Get status information of the server and installed services.

Example response

{
    "lastError": {
        "date": 0,
        "text": ""
    },
    "database": {
        "connected": true,
        "error": ""
    },
    "qlikConnection": {
        "connected": true,
        "error": ""
    },
    "license": {
        "valid": true,
        "expires": 1924902000000
    },
    "currentConnections": 1,
    "services": [
        {
            "name": "Database Backup Service",
            "status": "Not Installed",
            "lastError": {
                "text": "",
                "date": 0
            }
        }
    ]
}

Database v2.5.0+

GET /api/db/getEntries

Get entries of table

Query

Field	Value	Type
table	db table name	string
limit (optional)	rows to return (max 10000)	number
offset (optional)	get rows with offset x	number
columns (optional)	comma separated list of columns to return	string

http://localhost:7766/api/db/getEntries?table=test&limit=10&offset=0&columns=id,col1

{
    "data": [
        {
            "id": "2024|;|A",
            "col1": "5"
        },
        {
            "id": "2022|;|A",
            "col1": "4"
        }
    ],
    "count": 2,
    "offset": 0,
    "limit": 10,
    "total": 2
}

Qlik data connection setup

POST /api/db/table/{tableName}/insert

Insert a single entry in a table. If no id is provided, the next db_id will be used.

v2.8.2+

Body

Field	Value	Type
id (optional)	row id, will be generated if not provided	string
columName1	value for the column	string
...	value for the column	string

{
   "id":"123",
   "col1": "test"
}

{
    "id":"123",
    "col1": "test"
}

POST /api/db/table/{tableName}/update

Update a single entry in a table.

v2.8.2+

Body

Field	Value	Type
id	row to update	string
columName1	value for the column	string
...	value for the column	string

{
   "id":"123",
   "col1": "test",
   "col2": "test2"
}

status:200

POST/api/db/table/{tableName}/upsert

Updates or inserts (if id does not exist) a single entry in a table.

v2.8.2+

Body

Field	Value	Type
id	row to update/insert	string
columName1	value for the column	string
...	value for the column	string

{
   "id":"123",
   "col1": "test",
   "col2": "test2"
}

status:200

POST /api/db/table/{tableName}/commentHistoryEntry

Adds a comment history entry for an existing field. If the current content is not the expected format, it will be replaced with the posted single entry comment history.

v2.9.0+

Body

Field	Value	Type
id	row to update	string
column	column to update	string
text	Entry text	string
user	Entry user	string
imgUrl (optional)	Entry img	string

{
   "id":"A",
   "column": "col1",
   "text": "Some text for the entry",
   "user": "User 1"
}

status:200

POST/api/db/table/{tableName}/bulk/insert

Inserts multiple entries in a table. If no id is provided, the next db_id will be used.

v2.8.2+

Body [Array]

Field	Value	Type
id (optional)	row id, will be generated if not provided	string
columName1	value for the column	string
...	value for the column	string

[
   {
   "id":"123",
   "col1": "test"
   },{
   "col1": "test2"
   }
]

[
    {
    "id":"123",
    "col1": "test"
    },{
    "id":"2",
    "col1": "test2"
    }
]

POST/api/db/table/{tableName}/bulk/update

Updates multiple entries in a table.

v2.8.2+

Body [Array]

Field	Value	Type
id	row to update	string
columName1	value for the column	string
...	value for the column	string

[
   {
   "id":"123",
   "col1": "test"
   },{
   "id":"2",
   "col1": "test2"
   }
]

status:200

POST/api/db/table/{tableName}/bulk/upsert

Updates or inserts (if id does not exist) multiple entries in a table.

v2.8.2+

Body [Array]

Field	Value	Type
id	row to update	string
columName1	value for the column	string
...	value for the column	string

[
   {
   "id":"123",
   "col1": "test"
   },{
   "id":"nonExistingId",
   "col1": "test2"
   }
]

status:200

DELETE/api/db/deleteEntries

Delete table entries with the provided ids.

Using ["*"] for ids will delete all rows and reset the db_id counter.

Body

Field	Value	Type
table	db table name	string
ids	list of ids to delete	array

{
   "table": "test",
   "ids": ["1","2"]
}

status:200