Back

Search

Search

Methods

Inventory

Orders

Dashboards /ExecuteCustomScriptQuery

Response: CustomScriptResult



Use this call to retrieve a custom report from Query Data.
Apps using this call will not be allowed to Application Store.

Parameters

NameTypeDescription
scriptStringCustom SQL script query text
cancellationTokenCancellationTokenTerminates execution if task was cancelled on client

HTTP Endpoint

Server /Dashboards / ExecuteCustomScriptQuery

Permissions


Example Code

Example Request

The following request format is required for this method.

POST https://eu-ext.linnworks.net//api/Dashboards/ExecuteCustomScriptQuery HTTP/1.1
Host: eu-ext.linnworks.net
Connection: keep-alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.linnworks.net
Accept-Language: en
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/42.0.2311.90 Safari/537.36
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Referer: https://www.linnworks.net/
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE

script=sample string 1&cancellationToken={
  "IsCancellationRequested": false,
  "CanBeCanceled": false,
  "WaitHandle": {
    "Handle": {
      "value": 1352
    },
    "SafeWaitHandle": {
      "IsInvalid": false,
      "IsClosed": false
    }
  }
}

Response

This is an example response. Results may vary depending on your data.

{
  "IsError": true,
  "ErrorMessage": "sample string 2",
  "TotalResults": 1,
  "Columns": [
    {
      "Index": 1,
      "Name": "sample string 2",
      "Type": "sample string 3"
    },
    {
      "Index": 1,
      "Name": "sample string 2",
      "Type": "sample string 3"
    }
  ],
  "Results": [
    {
      "sample string 1": {},
      "sample string 3": {}
    },
    {
      "sample string 1": {},
      "sample string 3": {}
    }
  ]
}