Back

Search

Search

Methods

Inventory

Orders

Dashboards /ExecuteCustomPagedScript

Response: CustomScriptResult



Use this call to retrieve Query Data report
Contact support with Query Data report name and we will provide you with parameters.

Parameters

NameTypeDescription
scriptIdInt32Used to specify custom paged script id
parametersScriptParameter[]Used to specify custom paged script conditional parameters
entriesPerPageInt32Used to specify number of entries per page in report
pageNumberInt32Used to specify custom paged script page number

HTTP Endpoint

Server /Dashboards / ExecuteCustomPagedScript

Permissions


Example Code

Example Request

The following request format is required for this method.

POST https://eu-ext.linnworks.net//api/Dashboards/ExecuteCustomPagedScript 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

scriptId=1¶meters=[
  {
    "Type": "sample string 1",
    "Name": "sample string 2",
    "Description": "sample string 3",
    "DefaultValue": "sample string 4",
    "DropDownQuery": "sample string 5",
    "DatabaseType": "sample string 6",
    "DatabaseTypeLength": 7,
    "AvailableValues": [
      {},
      {}
    ],
    "Value": {}
  },
  {
    "Type": "sample string 1",
    "Name": "sample string 2",
    "Description": "sample string 3",
    "DefaultValue": "sample string 4",
    "DropDownQuery": "sample string 5",
    "DatabaseType": "sample string 6",
    "DatabaseTypeLength": 7,
    "AvailableValues": [
      {},
      {}
    ],
    "Value": {}
  }
]&entriesPerPage=1&pageNumber=1

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": {}
    }
  ]
}