Back

Search

Search

Methods

Inventory

Orders

RulesEngine /GetRequiredFieldsByRuleId

Response: RulesFields



Use this call to get a list of fields and keys used by a given rule.

Parameters

NameTypeDescription
pkRuleIdInt32The rule id

HTTP Endpoint

Server /RulesEngine / GetRequiredFieldsByRuleId

Permissions

GlobalPermissions.OrderBook.RulesEngineNode

Example Code

Example Request

The following request format is required for this method.

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

pkRuleId=1

Response

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

{
  "FieldNames": [
    "sample string 1",
    "sample string 2"
  ],
  "FieldKeys": {
    "sample string 1": [
      "sample string 1",
      "sample string 2"
    ],
    "sample string 2": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "IdName": "sample string 1"
}