Back

Search

Search

Methods

Inventory

Orders

Macro /GetMacroConfigurations

Response: List<MacroRegister>



Get all the macro configurations for the user account

Parameters

NameTypeDescription
requestGetMacroConfigurationsRequest

HTTP Endpoint

Server /Macro / GetMacroConfigurations

Permissions

linnworks.core.permissions.Permissions.GlobalPermissions.Applications.MacroConfigurationNode

Example Code

Example Request

The following request format is required for this method.

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

request={}

Response

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

[
  {
    "MacroId": 1,
    "ApplicationName": "sample string 2",
    "MacroName": "sample string 3",
    "FriendlyName": "sample string 4",
    "Enabled": true,
    "Started": "2020-11-10T15:12:59.9167834+00:00",
    "Completed": "2020-11-10T15:12:59.9167834+00:00",
    "Executing": true,
    "CurrentState": "sample string 9",
    "Parameters": [
      {
        "MacroId": 1,
        "ParameterName": "sample string 2",
        "ParameterValue": "sample string 3"
      },
      {
        "MacroId": 1,
        "ParameterName": "sample string 2",
        "ParameterValue": "sample string 3"
      }
    ],
    "Specification": [
      {
        "Name": "sample string 1",
        "RepetitionType": 0,
        "OneTimeDate": "2020-11-10T15:12:59.9167834Z",
        "DailyFrequency": 0,
        "OccursFrequencyStartingDate": "2020-11-10T15:12:59.9167834Z",
        "OccursFrequencyEveryX": 1,
        "WeeklyDays": "sample string 2",
        "OccursFrequency": 0,
        "OccursOnceAtTime": "sample string 3",
        "OccursEveryHours": 1,
        "StartingTime": "sample string 4",
        "EndingTime": "sample string 5",
        "Enabled": true
      },
      {
        "Name": "sample string 1",
        "RepetitionType": 0,
        "OneTimeDate": "2020-11-10T15:12:59.9167834Z",
        "DailyFrequency": 0,
        "OccursFrequencyStartingDate": "2020-11-10T15:12:59.9167834Z",
        "OccursFrequencyEveryX": 1,
        "WeeklyDays": "sample string 2",
        "OccursFrequency": 0,
        "OccursOnceAtTime": "sample string 3",
        "OccursEveryHours": 1,
        "StartingTime": "sample string 4",
        "EndingTime": "sample string 5",
        "Enabled": true
      }
    ],
    "MacroType": "sample string 10"
  },
  {
    "MacroId": 1,
    "ApplicationName": "sample string 2",
    "MacroName": "sample string 3",
    "FriendlyName": "sample string 4",
    "Enabled": true,
    "Started": "2020-11-10T15:12:59.9167834+00:00",
    "Completed": "2020-11-10T15:12:59.9167834+00:00",
    "Executing": true,
    "CurrentState": "sample string 9",
    "Parameters": [
      {
        "MacroId": 1,
        "ParameterName": "sample string 2",
        "ParameterValue": "sample string 3"
      },
      {
        "MacroId": 1,
        "ParameterName": "sample string 2",
        "ParameterValue": "sample string 3"
      }
    ],
    "Specification": [
      {
        "Name": "sample string 1",
        "RepetitionType": 0,
        "OneTimeDate": "2020-11-10T15:12:59.9167834Z",
        "DailyFrequency": 0,
        "OccursFrequencyStartingDate": "2020-11-10T15:12:59.9167834Z",
        "OccursFrequencyEveryX": 1,
        "WeeklyDays": "sample string 2",
        "OccursFrequency": 0,
        "OccursOnceAtTime": "sample string 3",
        "OccursEveryHours": 1,
        "StartingTime": "sample string 4",
        "EndingTime": "sample string 5",
        "Enabled": true
      },
      {
        "Name": "sample string 1",
        "RepetitionType": 0,
        "OneTimeDate": "2020-11-10T15:12:59.9167834Z",
        "DailyFrequency": 0,
        "OccursFrequencyStartingDate": "2020-11-10T15:12:59.9167834Z",
        "OccursFrequencyEveryX": 1,
        "WeeklyDays": "sample string 2",
        "OccursFrequency": 0,
        "OccursOnceAtTime": "sample string 3",
        "OccursEveryHours": 1,
        "StartingTime": "sample string 4",
        "EndingTime": "sample string 5",
        "Enabled": true
      }
    ],
    "MacroType": "sample string 10"
  }
]