### DownloadFile Request Example Source: https://wiki.leitart.de/FileService/DownloadFile Example JSON payload for the POST /downloadFile request. ```json { "file":"C:\\fileTest\\folder1\\fileName.png", } ``` -------------------------------- ### DownloadFile Response Example Source: https://wiki.leitart.de/FileService/DownloadFile Example response format for a successful file download request. ```text Status: 200 ``` -------------------------------- ### Get Table Entries Request Source: https://wiki.leitart.de/DataPlusServer/API/Database Example URL for fetching table entries with limit, offset, and column filtering. ```http http://localhost:7766/api/db/table/test/get?limit=10&offset=0&columns=id,col1 ``` -------------------------------- ### UploadFile Request Example Source: https://wiki.leitart.de/QmcService/UploadFile Example request structure including URL query parameters, headers, and body. ```http https://server:7545/uploadFile?library=test&overwrite=true&name=someName.png Header:{ "accessToken":"123456789" } Body: [file] ``` -------------------------------- ### TaskInfo Response Example Source: https://wiki.leitart.de/QmcService/TaskInfo A concrete example of the JSON response returned when querying task information. ```json [{ "id": "ff13ba37-0f1d-479c-980d-3b3217d91db2", "operational": { "id": "caaea48d-e5f6-4233-83e0-e98bd8a0f043", "lastExecutionResult": { "id": "813bd3a7-118a-40a6-b4ec-b0c573d9797b", "executingNodeName": "qlik.server", "status": 8, "startTime": "2022-06-21T11:35:24.055Z", "stopTime": "2022-06-21T11:35:25.181Z", "duration": 1126, "fileReferenceID": "8c89c07b-4f85-44c1-ba7a-7330c98441dd", "scriptLogAvailable": false, "details": [ { "id": "67daedce-f8c2-4d5d-a9d3-6194427a4cd9", "detailsType": 2, "message": "Message from ReloadProvider: Reload failed in Engine. Check engine or script logs.", "detailCreatedDate": "2022-06-21T11:35:25.165Z", "privileges": null }, { "id": "4d458681-8671-4e1a-a528-427b29ad2f1c", "detailsType": 2, "message": "Max retries reached (0)", "detailCreatedDate": "2022-06-21T11:35:25.181Z", "privileges": null }, { "id": "d6261a10-32d3-4c7f-bffb-0cf9bb73f065", "detailsType": 2, "message": "Changing task state to Triggered", "detailCreatedDate": "2022-06-21T11:35:24.055Z", "privileges": null }, { "id": "d2051352-4a83-458a-ae03-362d48b1269d", "detailsType": 2, "message": "Changing task state from Triggered to Started", "detailCreatedDate": "2022-06-21T11:35:24.196Z", "privileges": null }, { "id": "349add2a-db8d-4fb0-9d2b-be64254dfc14", "detailsType": 2, "message": "Reference to scriptlog added", "detailCreatedDate": "2022-06-21T11:35:25.134Z", "privileges": null }, { "id": "5a18d013-1064-4f83-82b6-290ebe592366", "detailsType": 2, "message": "Trying to start task. Sending task to slave scheduler qlik.server", "detailCreatedDate": "2022-06-21T11:35:24.117Z", "privileges": null }, { "id": "30985c5d-369d-490a-b846-03556bbc301e", "detailsType": 2, "message": "Changing task state from Started to FinishedFail", "detailCreatedDate": "2022-06-21T11:35:25.165Z", "privileges": null } ], "scriptLogLocation": "qlik.server\\Script\\27bcc7bc-4ec1-493e-a5d9-5630e3444872.20220621T133524.380+0200.51EB46E544B63FB4255A.log", "scriptLogSize": 4850, "privileges": null }, "nextExecution": "2022-06-22T10:35:24.000Z", "privileges": null }, "name": "test", "taskType": 0, "enabled": true, "taskSessionTimeout": 1440, "maxRetries": 0, "privileges": null }] ``` -------------------------------- ### POST /api/task/start Source: https://wiki.leitart.de/DataPlusServer/API/Reload Starts a reload task. ```APIDOC ## POST /api/task/start ### Description Starts a reload task. ### Method POST ### Endpoint /api/task/start ### Parameters #### Request Body - **taskId** (string) - Required - Id of the task to start ### Request Example { "taskId":"0ea90134-09c0-4c50-a0f5-a9bd677e61cc" } ``` -------------------------------- ### Insert Table Entry Example Source: https://wiki.leitart.de/DataPlusServer/API/Database Example request body and response for inserting a new entry into a table. ```json { "id":"123", "col1": "test" } ``` ```json { "id":"123", "col1": "test" } ``` -------------------------------- ### List files via GET Source: https://wiki.leitart.de/DataPlusServer/API/Files Retrieves a list of files and directories at the specified path. ```http /api/files/list?path=folder1/subfolder2 ``` ```json [ { "name": "test2.png", "lastModified": 1760972736000, "isDirectory": false },{ "name": "subsubFolder", "isDirectory": true } ] ``` -------------------------------- ### GET /taskStart Source: https://wiki.leitart.de/QmcService/TaskStart Initiates a Qlik reload task using the provided task ID and user context. ```APIDOC ## GET /taskStart ### Description Starts a reload task in the Qlik environment. ### Method GET ### Endpoint /taskStart ### Parameters #### Header - **AccessToken** (string) - Required - AccessToken_taskStart set in the Config #### Request Body - **taskId** (string) - Required - The Qlik Reload TaskId - **user** (string) - Required - The User starting the Task ### Response #### Success Response (200) - Status: 200 ``` -------------------------------- ### Update Table Entry Example Source: https://wiki.leitart.de/DataPlusServer/API/Database Example request body and response for updating an existing table entry. ```json { "id":"123", "col1": "test", "col2": "test2" } ``` ```text status:200 ``` -------------------------------- ### Retrieve all Nprinting connections Source: https://wiki.leitart.de/NprintingService/Connections Example response body returned by the POST /connections endpoint. ```json Status: 200 [{ "connectionString" : "aeiou", "created" : "2000-01-23T04:56:07.000+00:00", "lastUpdate" : "2000-01-23T04:56:07.000+00:00", "appId" : "aeiou", "name" : "aeiou", "connectionStatus" : "Unknown", "description" : "aeiou", "notificationsEnabled" : true, "cacheStatus" : "NeverGenerated", "id" : "00000000-0000-0000-0000-000000000000", "source" : "aeiou" }] ``` -------------------------------- ### StartDownload Response Example Source: https://wiki.leitart.de/NprintingService/StartDownload The successful response returns a JSON object containing the report metadata and the initial status of the download request. ```json Status: 200 { "reportType" : "Excel", "requestType" : "report", "created" : "2000-01-23T04:56:07.000+00:00", "id" : "00000000-0000-0000-0000-000000000000", "title" : "title", "outputFormat" : "pdf", "status" : "queued" } ``` -------------------------------- ### Load Inline Data for Dropdown Example Source: https://wiki.leitart.de/DataPlusTable/Examples/dropdownWithFilteredData Initial data load script to populate the Category and Vehicle fields for the dropdown demonstration. ```Qlik Load * inline [ Category, Vehicle Personal, Bike Personal, Car Public, Bus Public, Train ]; ``` -------------------------------- ### Get Server Status Response Source: https://wiki.leitart.de/DataPlusServer/API/Status Example JSON response returned by the GET /api/status endpoint. ```json { "version": "2.2.0", "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 } } ], "mail": { "currentQueue": 0, "dailyMaxQueue": 0, "dailyMessages": 0, }, "api": { "requests": { "dailyMax_1": 0, "dailyMax_5": 0, "current_5": 0, }, "db_row_updates": { "dailyMax_1": 0, "dailyMax_5": 0, "current_5": 0, } } } ``` -------------------------------- ### GET /api/status Source: https://wiki.leitart.de/DataPlusServer/API/Status Retrieves the current status information of the server and its installed services. ```APIDOC ## GET /api/status ### Description Get status information of the server and installed services. ### Method GET ### Endpoint /api/status ### Response #### Success Response (200) - **version** (string) - Server version - **lastError** (object) - Information about the last error encountered - **database** (object) - Database connection status - **qlikConnection** (object) - Qlik connection status - **license** (object) - License validity and expiration - **currentConnections** (number) - Number of active connections - **services** (array) - List of installed services and their status - **mail** (object) - Mail queue and message statistics - **api** (object) - API request and database row update metrics #### Response Example { "version": "2.2.0", "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 } } ], "mail": { "currentQueue": 0, "dailyMaxQueue": 0, "dailyMessages": 0 }, "api": { "requests": { "dailyMax_1": 0, "dailyMax_5": 0, "current_5": 0 }, "db_row_updates": { "dailyMax_1": 0, "dailyMax_5": 0, "current_5": 0 } } } ``` -------------------------------- ### GET /api/task/info Source: https://wiki.leitart.de/DataPlusServer/API/Reload Get information of all tasks, returns a list of QMC TaskOperational Objects. ```APIDOC ## GET /api/task/info ### Description Get information of all tasks, returns a list of QMC TaskOperational Objects. ### Method GET ### Endpoint /api/task/info ``` -------------------------------- ### GET /api/reload/taskList Source: https://wiki.leitart.de/DataPlusServer/API/Reload Get information of all tasks, returns a list of QMC TaskOperational Objects. ```APIDOC ## GET /api/reload/taskList ### Description Get information of all tasks, returns a list of QMC TaskOperational Objects. ### Method GET ### Endpoint /api/reload/taskList ``` -------------------------------- ### UploadFile Response Example Source: https://wiki.leitart.de/QmcService/UploadFile Standard successful response returned by the API. ```text ok ``` -------------------------------- ### Regex Replace Request Example Source: https://wiki.leitart.de/FileService/file_edit_regexreplace Example JSON body for the regex replace request, specifying the target file and the regex find/replace pattern. ```json { "file":"C:\\test\\test.txt", "regexReplace":[{ "find":"(dogs)", "replace":"cats" } ] } ``` -------------------------------- ### Configure Upload File Types Source: https://wiki.leitart.de/DataPlusFlow/Steps Examples of allowed file type configurations for the Upload File step using extensions or MIME types. ```text * .png,.jpg application/pdf,image/* ``` -------------------------------- ### Example Request Body Source: https://wiki.leitart.de/FileService/file_edit_encodeuri The JSON payload required to specify the target file path. ```json { "file":"C:\\test\\test.txt" } ``` -------------------------------- ### Get download URL via GET Source: https://wiki.leitart.de/DataPlusServer/API/Files Generates a secure download URL for a file. Note that local file system drivers require Data+ API authentication. ```http /api/files/getDownloadUrl?path=folder1/subfolder2/test2.png ``` ```json { "downloadUrl": "https://***.s3.eu-central-1.amazonaws.com/folder1/subfolder2/test2.png?****", "type":"ext_noAuth" } ``` -------------------------------- ### JSON Array Key Conversion Example Source: https://wiki.leitart.de/DataPlusForms/Changelog Demonstrates the structure resulting from the conversion of dot-notation keys containing array indices. ```json { "entries": [{ "ABC": "value" }] } ``` -------------------------------- ### API Response JSON Example Source: https://wiki.leitart.de/MultiUseButton/ButtonActions Example JSON structure for an API response. Use the Response Value Path to extract specific data, such as 'software.0.name' to retrieve 'Qlik'. ```json { "software": [ { "name": "Qlik" } ] } ``` -------------------------------- ### Combine status and start time with a rule Source: https://wiki.leitart.de/DataPlusTable/Examples/StartStopButtons Use this Qlik expression to dynamically display the status and start time within a single column. Avoid using this approach with 'has value' triggers if the table is affected by selections to maintain performance. ```Qlik Expression =If('$(status)'='running','$(status) since $(start_time)','$(status)') ``` -------------------------------- ### Check file existence via GET Source: https://wiki.leitart.de/DataPlusServer/API/Files Verifies if a file exists at the provided path. ```http /api/files/exists?path=folder1/subfolder2/test2.png ``` ```json { "exists": true } ``` -------------------------------- ### Example Response Status Source: https://wiki.leitart.de/FileService/file_edit_encodeuri The expected HTTP status code upon successful execution. ```text Status: 200 ``` -------------------------------- ### UploadFile Request Body Example Source: https://wiki.leitart.de/FileService/UploadFile Example JSON structure for the body object within the FormData request. ```json { "folder":"C:\\fileTest\\folder1", "name":"testFile", "replace":true } ``` -------------------------------- ### GET /api/task/info/{taskId} Source: https://wiki.leitart.de/DataPlusServer/API/Reload Get information of a specific task, returns a list of QMC TaskOperational Objects. ```APIDOC ## GET /api/task/info/{taskId} ### Description Get information of a specific task, returns a list of QMC TaskOperational Objects (which should be 1). ### Method GET ### Endpoint /api/task/info/{taskId} ### Parameters #### Path Parameters - **taskId** (string) - Required - The ID of the task ``` -------------------------------- ### POST /startTask Source: https://wiki.leitart.de/NprintingService/StartTask Starts a task in Nprinting. This endpoint allows triggering a specific task by its ID, with an optional test mode to log the action without execution. ```APIDOC ## POST /startTask ### Description Starts a task in Nprinting. ### Method POST ### Endpoint /startTask ### Parameters #### Request Body - **taskId** (string) - Required - Task Id to start - **test** (boolean) - Optional - Only log the action but don’t execute it for testing purposes - **ApiToken** (string) - Required - ApiToken set in the Config ### Response #### Success Response (200) - **data** (object) - Contains task execution details including id, type, task, created, lastUpdate, completed, progress, status, result, and priority. #### Response Example { "data": { "id": "test", "type": "Qlik.NPrinting.Task.PublishReportsEngineTask", "task": "taskId", "created": "0001-01-01T00:00:00Z", "lastUpdate": "0001-01-01T00:00:00Z", "completed": null, "progress": 0.0, "status": "Enqueued", "result": null, "priority": 500.0 } } ``` -------------------------------- ### Get upload URL via GET Source: https://wiki.leitart.de/DataPlusServer/API/Files Generates a secure upload URL for a file. Local file system drivers require Data+ API authentication. ```http /api/files/getUploadUrl?path=folder1/subfolder2/test2.png ``` ```json { "uploadUrl": "https://***.s3.eu-central-1.amazonaws.com/folder1/subfolder2/test2.png?****", "type":"ext_noAuth" } ``` -------------------------------- ### Add Comment History Entry Example Source: https://wiki.leitart.de/DataPlusServer/API/Database Example request body and response for adding a comment history entry to a specific field. ```json { "id":"A", "column": "col1", "text": "Some text for the entry", "user": "User 1" } ``` ```text status:200 ``` -------------------------------- ### GET /getAllTasks Source: https://wiki.leitart.de/QmcService/GetAllTasks Retrieves all reload tasks of the connected Qlik server. ```APIDOC ## GET /getAllTasks ### Description Get all reload tasks of the connected Qlik server. ### Method GET ### Endpoint /getAllTasks ### Parameters #### Header - **AccessToken** (string) - Required - AccessToken_taskStart set in the Config ### Response #### Success Response (200) - **Response** (array) - A list of task objects containing details such as id, name, enabled status, and operational information. #### Response Example [ { "id": "ff13ba37-0f1d-479c-980d-3b3217d91db2", "operational": { "id": "caaea48d-e5f6-4233-83e0-e98bd8a0f043", "lastExecutionResult": { "id": "813bd3a7-118a-40a6-b4ec-b0c573d9797b", "executingNodeName": "qlik.server", "status": 8, "startTime": "2022-06-21T11:35:24.055Z", "stopTime": "2022-06-21T11:35:25.181Z", "duration": 1126, "scriptLogAvailable": false, "scriptLogLocation": "qlik.server\\Script\\27bcc7bc-4ec1-493e-a5d9-5630e3444872.20220621T133524.380+0200.51EB46E544B63FB4255A.log", "scriptLogSize": 4850 }, "nextExecution": "2022-06-22T10:35:24.000Z" }, "name": "test", "taskType": 0, "enabled": true, "taskSessionTimeout": 1440, "maxRetries": 0 } ] ``` -------------------------------- ### GET /api/info Source: https://wiki.leitart.de/DataPlusServer/API/Info Retrieves configuration and permission information for the currently authenticated API key. ```APIDOC ## GET /api/info ### Description Access information for the used API-Key, including system status and permissions for databases and files. ### Method GET ### Endpoint /api/info ### Response #### Success Response (200) - **name** (string) - The name of the API key configuration. - **mail** (boolean) - Indicates if mail functionality is enabled. - **status** (boolean) - The current status of the API key. - **task** (boolean) - Indicates if task functionality is enabled. - **db** (array) - List of database table permissions. - **files** (array) - List of file folder permissions. #### Response Example { "name": "API [test]", "mail": false, "status": true, "task": true, "db": [ { "table": "test", "delete": true, "read": true, "update": true } ], "files": [ { "folder": "testFolder", "create": true, "delete": true, "overwrite": true, "read": true } ] } ``` -------------------------------- ### Execute Custom JSON Code Source: https://wiki.leitart.de/DataPlusFlow/Steps Example of a return object for the Code step, which executes custom logic. ```json return { "result": "Hello World" } ``` -------------------------------- ### Trigger Reload Response Source: https://wiki.leitart.de/DataPlusServer/API/Reload Example response returned after successfully triggering a reload. ```json { "status": "Triggered", "avgDuration": 1679, "lastReload": { "duration": 1284, "endTime": "2025-12-15T10:09:51.785Z", "logLocation": "https://***.eu.qlikcloud.com/api/v1/apps/0ea90134-09c0-4c50-a0f5-a9bd677e61cc/reloads/logs/693fde6d71aadf3f91af3026", "success": true } } ``` -------------------------------- ### GET /api/files/list Source: https://wiki.leitart.de/DataPlusServer/API/Files Retrieves a list of files and folders at the specified path. ```APIDOC ## GET /api/files/list ### Description Retrieves a list of files and folders at the specified path. ### Method GET ### Endpoint /api/files/list ### Parameters #### Query Parameters - **path** (string) - Required - The folder path to list. ### Response #### Success Response (200) - **name** (string) - The name of the file or folder. - **lastModified** (number) - The last modified timestamp. - **isDirectory** (boolean) - Indicates if the item is a directory. ``` -------------------------------- ### Bulk Insert Request and Response Source: https://wiki.leitart.de/DataPlusServer/API/Database Example request body for inserting multiple rows and the corresponding successful response. ```json [ { "id":"123", "col1": "test" },{ "col1": "test2" } ] ``` ```json [ { "id":"123", "col1": "test" },{ "id":"2", "col1": "test2" } ] ``` -------------------------------- ### Start Reload Task Request Body Source: https://wiki.leitart.de/DataPlusServer/API/Reload JSON payload structure for the POST /api/task/start endpoint. ```json { "taskId":"0ea90134-09c0-4c50-a0f5-a9bd677e61cc" } ``` -------------------------------- ### Bulk Update Request and Response Source: https://wiki.leitart.de/DataPlusServer/API/Database Example request body for updating multiple rows and the corresponding status response. ```json [ { "id":"123", "col1": "test" },{ "id":"2", "col1": "test2" } ] ``` ```text status:200 ``` -------------------------------- ### Save to JSON with Dot Notation Source: https://wiki.leitart.de/DataPlusForms/Data Example of how dot notation maps form values into a nested JSON structure. ```json { "car": { "style": { "color": "{value}" } } } ``` -------------------------------- ### Search Table Entries Request Body Source: https://wiki.leitart.de/DataPlusServer/API/Database Examples of filter objects for the search endpoint, supporting simple, OR, and complex logical conditions. ```json { "filter": { "id": "A" } } ``` ```json { "filter": { "id": { "IN":["A","B"] } } } ``` ```json { "filter": { "AND": { "col1":"some condition", "id": { "IN": ["A","B"] } } } } ``` -------------------------------- ### Create a folder via POST Source: https://wiki.leitart.de/DataPlusServer/API/Files Creates a new directory at the specified path. ```json { "path":"folder1/subfolder2" } ``` ```text status:200 ``` -------------------------------- ### POST /startDownload Source: https://wiki.leitart.de/NprintingService/StartDownload Initiates the download process for an on-demand report. Users must provide the API token, report ID, output format, selections, and connection ID. ```APIDOC ## POST /startDownload ### Description Starts downloading an on-demand report. For checking the status of the download, refer to the /checkDownload endpoint. ### Method POST ### Endpoint /startDownload ### Request Body - **ApiToken** (string) - Required - The ApiToken set in the Config - **reportId** (string) - Required - The ReportID - **outputFormat** (string) - Required - The OutputFormat (e.g., pdf) - **selections** (string) - Required - The Qlik Selections - **connectionId** (string) - Required - The ConnectionID ### Response #### Success Response (200) - **reportType** (string) - The type of report - **requestType** (string) - The type of request - **created** (string) - The creation timestamp - **id** (string) - The unique identifier for the request - **title** (string) - The title of the report - **outputFormat** (string) - The format of the output - **status** (string) - The current status of the request #### Response Example { "reportType": "Excel", "requestType": "report", "created": "2000-01-23T04:56:07.000+00:00", "id": "00000000-0000-0000-0000-000000000000", "title": "title", "outputFormat": "pdf", "status": "queued" } ``` -------------------------------- ### Load database records for Data+ Table Source: https://wiki.leitart.de/DataPlusTable/Examples/DataPlus_Message Connects to the Data+ server and selects specific columns from the public orders table. ```qlik LIB CONNECT TO 'Data+ Server'; LOAD id, user, customer, article, count, fullfilled; [orders]: SELECT "id", "user", "customer", "article", "count", "fullfilled" FROM "public"."orders"; ``` -------------------------------- ### Configure Optional Server Parameters Source: https://wiki.leitart.de/DataPlusServer/Installation Add these fields to the server.cfg file to customize security, upload limits, and database SSL settings. A service restart is required for changes to take effect. ```json "noSecurityHeaders":true ``` ```json "uploadLimit":"100mb" ``` ```json "DupTablePageSize":30000 ``` ```json "db_sslmode": "require" ``` ```json "db_rejectUnauthorized": true ``` ```json "db_sslCa": "C:\\Certificates\\root.crt" ``` -------------------------------- ### GET /api/files/getUploadUrl Source: https://wiki.leitart.de/DataPlusServer/API/Files Generates an upload URL for a file. ```APIDOC ## GET /api/files/getUploadUrl ### Description Generates an upload URL for a file. ### Method GET ### Endpoint /api/files/getUploadUrl ### Parameters #### Query Parameters - **path** (string) - Required - The file path. - **overwrite** (boolean) - Optional - Whether to overwrite existing files. ### Response #### Success Response (200) - **uploadUrl** (string) - The URL to upload the file. - **type** (string) - The type of the upload link. ``` -------------------------------- ### GET /api/files/getDownloadUrl Source: https://wiki.leitart.de/DataPlusServer/API/Files Generates a download URL for a file. ```APIDOC ## GET /api/files/getDownloadUrl ### Description Generates a download URL for a file. ### Method GET ### Endpoint /api/files/getDownloadUrl ### Parameters #### Query Parameters - **path** (string) - Required - The file path. ### Response #### Success Response (200) - **downloadUrl** (string) - The URL to download the file. - **type** (string) - The type of the download link. ``` -------------------------------- ### GET /api/files/exists Source: https://wiki.leitart.de/DataPlusServer/API/Files Checks if a file exists at the specified path. ```APIDOC ## GET /api/files/exists ### Description Checks if a file exists at the specified path. ### Method GET ### Endpoint /api/files/exists ### Parameters #### Query Parameters - **path** (string) - Required - The file path to check. ### Response #### Success Response (200) - **exists** (boolean) - Whether the file exists. ``` -------------------------------- ### POST /api/files/createFolder Source: https://wiki.leitart.de/DataPlusServer/API/Files Creates a new folder. ```APIDOC ## POST /api/files/createFolder ### Description Creates a new folder. ### Method POST ### Endpoint /api/files/createFolder ### Parameters #### Request Body - **path** (string) - Required - The path of the folder to create. ``` -------------------------------- ### Initialize Board Rows Source: https://wiki.leitart.de/DataPlusTable/Examples/Chess Load the row identifiers into the data model to represent the 8 ranks of the chess board. ```qlik Rows: Load * Inline [ Row 8 7 6 5 4 3 2 1 ]; ``` -------------------------------- ### POST /createFile Source: https://wiki.leitart.de/FileService/CreateFile Creates a new file at the specified path with the provided data. ```APIDOC ## POST /createFile ### Description Creates a new file at the specified path with the provided data. Supports optional encoding and a test mode. ### Method POST ### Endpoint /createFile ### Parameters #### Header - **accessToken** (string) - Required - Access token set in the Config #### Request Body - **file** (string) - Required - File name to create (full path) - **data** (string) - Required - The data to save to the created file - **encoding** (string) - Optional - Encoding to save in (e.g. ascii) - **test** (boolean) - Optional - Only log the file action but don’t execute it for testing purposes ### Response #### Success Response (200) - **body** (string) - "success" ### Response Example "success" ``` -------------------------------- ### Reload app with progress display configuration Source: https://wiki.leitart.de/DataPlusTable/CheatSheet JSON configuration for triggering app reloads and displaying progress indicators. ```JSON [ {"trigger":{"id":"DataSaved","settings":{},"ruleValueOptions":[]},"condition":{},"actions":[{"id":"ReloadApp","settings":{"reload_partial":{"valueBool":false},"reload_weight":{"valueNum":1},"reload_variables":{"keyValueList":[]},"defaultResponseNotification":{"valueBool":true}}}],"enabled":true,"name":"Trigger reload","group":"Reload App","hideWarning":false},{"trigger":{"id":"ReloadTriggered","settings":{},"ruleValueOptions":[]},"condition":{"conditionBlock":{"type":"eval","invert":false,"eval":{"listSeperator":",","operator":"=","operator2":"=","value1":{"type":"reloadTriggered.status","data":{},"dataType":"string","hasColumn":false,"hasDbColumn":false,"hasDataType":false,"hasDateFormat":false,"hasQlikVariable":false,"hasValue":false,"hasIndex":false},"value2":{"type":"custom.static","data":{"value":"Triggered"},"dataType":"string","hasColumn":false,"hasDbColumn":false,"hasDataType":false,"hasDateFormat":false,"hasQlikVariable":false,"hasValue":true,"hasIndex":false}}}},"actions":[{"id":"ProgressDisplay","settings":{"progressDisplay_type":{"value":"Percent"},"progressDisplay_text":{"ruleValue":{"type":"custom.static","hasValue":true,"data":{"dataType":"string","value":"Reloading"}}},"progressDisplay_duration":{"ruleValue":{"type":"reloadTriggered.avgDuration","hasValue":false,"data":{"dataType":"string","value":""},"dataType":"number","hasColumn":false,"hasDbColumn":false,"hasDataType":false,"hasDateFormat":false,"hasQlikVariable":false,"hasIndex":false}},"progressDisplay_HideOnComplete":{"valueBool":false},"progressDisplay_icon":{"ruleValue":{"type":"custom.static","hasValue":true,"data":{"dataType":"string"}}},"progressDisplay_iconColor":{"ruleValue":{"type":"custom.static","hasValue":true,"data":{"dataType":"string"}}},"progressDisplay_round":{"valueBool":false},"progressDisplay_barColor":{"ruleValue":{"type":"custom.static","hasValue":true,"data":{"dataType":"string"}}}}}],"enabled":true,"name":"Show reload display","group":"Reload App","hideWarning":false},{"trigger":{"id":"AppReload","settings":{},"ruleValueOptions":[]},"condition":{},"actions":[{"id":"ProgressDisplay","settings":{"progressDisplay_type":{"value":"Hide"},"progressDisplay_text":{"ruleValue":{"type":"custom.static","hasValue":true,"data":{"dataType":"string","value":"Reloading"}}},"progressDisplay_duration":{"ruleValue":{"type":"custom.static","hasValue":true,"data":{"dataType":"string"}}},"progressDisplay_HideOnComplete":{"valueBool":false},"progressDisplay_icon":{"ruleValue":{"type":"custom.static","hasValue":true,"data":{"dataType":"string"}}},"progressDisplay_iconColor":{"ruleValue":{"type":"custom.static","hasValue":true,"data":{"dataType":"string"}}},"progressDisplay_round":{"valueBool":false},"progressDisplay_barColor":{"ruleValue":{"type":"custom.static","hasValue":true,"data":{"dataType":"string"}}}}}],"enabled":true,"name":"Hide Progress display on app reload","group":"Reload App","hideWarning":false} ] ``` -------------------------------- ### Simple Dropdown Configuration Source: https://wiki.leitart.de/AdvancedSelector/Dropdown Defines a basic dropdown using a field for the value and a set expression for the label. ```text Value: Num Label: Only({1}Num) ``` -------------------------------- ### POST /checkDownload/{requestID} Source: https://wiki.leitart.de/NprintingService/CheckDownload Initiates the download process for a specific report request and returns the current status. ```APIDOC ## POST /checkDownload/{requestID} ### Description Start downloading an on-demand report. ### Method POST ### Endpoint /checkDownload/{requestID} ### Parameters #### Path Parameters - **requestID** (string) - Required - The unique identifier for the report request. #### Request Body - **ApiToken** (string) - Required - The API token configured for the service. ### Response #### Success Response (201) - **File** (binary) - The downloaded report file. #### Success Response (200) - **status** (string) - Returns 'running' if the report is still being generated. ### Response Example { "status": "running" } ``` -------------------------------- ### Get Table Entries Response Source: https://wiki.leitart.de/DataPlusServer/API/Database Standard JSON response structure for table retrieval requests. ```json { "data": [ { "id": "2024|;|A", "col1": "5" }, { "id": "2022|;|A", "col1": "4" } ], "count": 2, "offset": 0, "limit": 10, "total": 2 } ``` -------------------------------- ### POST /copyFile Source: https://wiki.leitart.de/FileService/CopyFile Copies a file from a source folder to a destination folder. ```APIDOC ## POST /copyFile ### Description Copy a file from one folder to another. ### Method POST ### Endpoint /copyFile ### Parameters #### Request Body - **file** (string) - Required - Path to file - **fromFolder** (string) - Required - Folder to copy from - **toFolder** (string) - Required - Folder to copy to - **test** (boolean) - Optional - Only log the file action but don’t execute it for testing purposes ### Response #### Success Response (200) - **Response** (string) - "success" ``` -------------------------------- ### POST /connections Source: https://wiki.leitart.de/NprintingService/Connections Retrieves a list of all connections available in Nprinting. ```APIDOC ## POST /connections ### Description Retrieves all connections from Nprinting. ### Method POST ### Endpoint /connections ### Request Body - **ApiToken** (string) - Required - The ApiToken set in the Config. ### Response #### Success Response (200) - **connectionString** (string) - Connection string - **created** (string) - Creation timestamp - **lastUpdate** (string) - Last update timestamp - **appId** (string) - Application ID - **name** (string) - Connection name - **connectionStatus** (string) - Status of the connection - **description** (string) - Connection description - **notificationsEnabled** (boolean) - Whether notifications are enabled - **cacheStatus** (string) - Status of the cache - **id** (string) - Unique identifier - **source** (string) - Source of the connection #### Response Example [ { "connectionString": "aeiou", "created": "2000-01-23T04:56:07.000+00:00", "lastUpdate": "2000-01-23T04:56:07.000+00:00", "appId": "aeiou", "name": "aeiou", "connectionStatus": "Unknown", "description": "aeiou", "notificationsEnabled": true, "cacheStatus": "NeverGenerated", "id": "00000000-0000-0000-0000-000000000000", "source": "aeiou" } ] ``` -------------------------------- ### Retrieve API Information Source: https://wiki.leitart.de/DataPlusServer/API/Info Returns a JSON object containing API status, database permissions, and file system access rights. ```json { "name": "API [test]", "mail": false, "status": true, "task": true, "db": [ { "table": "test", "delete": true, "read": true, "update": true } ], "files": [ { "folder": "testFolder", "create": true, "delete": true, "overwrite": true, "read": true } ] } ``` -------------------------------- ### Response Running Source: https://wiki.leitart.de/NprintingService/CheckDownload Indicates the request is currently being processed. ```json Status: 200 { status: 'running' } ``` -------------------------------- ### GET /api/db/table/{tableName}/get Source: https://wiki.leitart.de/DataPlusServer/API/Database Retrieves entries from a specified database table with support for pagination and column filtering. ```APIDOC ## GET /api/db/table/{tableName}/get ### Description Retrieves rows from the specified table. Supports limiting the number of rows, setting an offset, and selecting specific columns. ### Method GET ### Endpoint /api/db/table/{tableName}/get ### Parameters #### Path Parameters - **tableName** (string) - Required - The name of the table to query. #### Query Parameters - **limit** (number) - Optional - Number of rows to return (max 10000). - **offset** (number) - Optional - Get rows with offset x. - **columns** (string) - Optional - Comma separated list of columns to return. ### Request Example http://localhost:7766/api/db/table/test/get?limit=10&offset=0&columns=id,col1 ### Response #### Success Response (200) - **data** (array) - List of table entries. - **count** (number) - Number of rows returned. - **offset** (number) - Current offset. - **limit** (number) - Current limit. - **total** (number) - Total number of rows available. #### Response Example { "data": [ { "id": "2024|;|A", "col1": "5" }, { "id": "2022|;|A", "col1": "4" } ], "count": 2, "offset": 0, "limit": 10, "total": 2 } ``` -------------------------------- ### POST /taskInfo Source: https://wiki.leitart.de/QmcService/TaskInfo Retrieves detailed information about a specific Qlik reload task. ```APIDOC ## POST /taskInfo ### Description Retrieves configuration and operational status information for a Qlik reload task identified by the provided taskId. ### Method POST ### Endpoint /taskInfo ### Parameters #### Request Body - **taskId** (string) - Required - The Qlik Reload TaskId ### Request Example { "taskId": "your-task-id-here" } ### Response #### Success Response (200) - **Response** (array) - A list of task objects containing configuration and operational details. #### Response Example [ { "id": "ff13ba37-0f1d-479c-980d-3b3217d91db2", "operational": { "id": "caaea48d-e5f6-4233-83e0-e98bd8a0f043", "lastExecutionResult": { "id": "813bd3a7-118a-40a6-b4ec-b0c573d9797b", "status": 8, "startTime": "2022-06-21T11:35:24.055Z", "stopTime": "2022-06-21T11:35:25.181Z", "duration": 1126 }, "nextExecution": "2022-06-22T10:35:24.000Z" }, "name": "test", "taskType": 0, "enabled": true } ] ``` -------------------------------- ### POST /downloadFile Source: https://wiki.leitart.de/FileService/DownloadFile Downloads a file from the specified path. ```APIDOC ## POST /downloadFile ### Description Download a file from the server. ### Method POST ### Endpoint /downloadFile ### Parameters #### Header - **accessToken** (string) - Required - The access token set in the Config. #### Request Body - **file** (string) - Required - The full path of the file to download. ### Request Example { "file": "C:\\fileTest\\folder1\\fileName.png" } ### Response #### Success Response (200) - **File** (binary) - The requested file content. #### Response Example Status: 200 ``` -------------------------------- ### POST /proxy Source: https://wiki.leitart.de/QmcService/Proxy Proxies a request to the Qlik QRS connected to the service, automatically injecting the required authentication headers. ```APIDOC ## POST /proxy ### Description Proxy a request to the Qlik QRS connected to this service. This service will automatically add the required authentication for communicating with the QRS. ### Method POST ### Endpoint /proxy ### Parameters #### Request Body - **path** (string) - Required - The QRS path (e.g. /user) - **method** (string) - Required - HTTP Method (GET, POST, PATCH, DELETE) - **data** (any) - Optional - Data used as body on the Request ### Response The original response from the QRS will be forwarded. ``` -------------------------------- ### Text Field Dialog Default Entry Source: https://wiki.leitart.de/DataPlusTable/Columns Example expression for a default entry button in a text field dialog to append the current user and timestamp. ```Qlik Expression =' ---------------------- '&OSUser()&' '&now(1)&' ' ``` -------------------------------- ### XML Generation with Loops Source: https://wiki.leitart.de/MultiUseButton/CreateText Template for generating XML structures using loop markers and column data replacement. ```text =' $#(startLoop) $c(Alpha) $c(Num) $#(endLoop)
' ``` ```xml A 1 B 2 C 3 D 4 ...
``` -------------------------------- ### Filtered Dropdown Configuration Source: https://wiki.leitart.de/DataPlusForms/FormElements Advanced dropdown configuration using set analysis to filter values based on current selections. ```Qlik Value: =only({}City) Label: =aggr(only({}City),City) ``` -------------------------------- ### Move or rename a file via POST Source: https://wiki.leitart.de/DataPlusServer/API/Files Updates the path of a file using source and destination paths. ```json { "sourcePath":"folder1/subfolder2/test2.png", "destinationPath":"folder1/subfolder2/test2_new.png" } ``` ```text status:200 ``` -------------------------------- ### Response Download Source: https://wiki.leitart.de/NprintingService/CheckDownload Indicates a successful request resulting in a file download. ```http Status: 201 ``` -------------------------------- ### Fieldname Replacement Syntax Source: https://wiki.leitart.de/DataPlusForms/FormElements Syntax used to trigger automatic replacement of fieldnames with their corresponding values. ```Qlik $f(fieldName) ```