Set Configuration

Endpoint

TASK_INTERFACE_API_ENDPOINT

Request Parameters

Parameter	Mandatory?	Data type	Description
`configname`	True	String	The name of the configuration that should be updated.
`configvalue`	True	String	The new value of the specified configuration.

Configurations

Configuration Name	Configuration Value
`preparationspan`	Integer value that specifies the maximum amount of Bins prepared, calculated as a percentage of the defined grid storage cells.
`prepareemptybin`	Integer value that specifies the amount of empty bins (content=0) prepared, calculated as a percentage of the defined grid storage cells.
`emptybincontent`	Integer value that specifies the content code used for specifying an empty bin. Multiple content codes can be specified by separating these with a comma (,).
`emptybinfactor`	String value used to override the default empty bin distribution. The value consists of the content code and the factor for this content code. These values are separated by a comma (,).

Request example

//Interface installation location(Ip adress)
string ip = "127.0.0.1";
//The URL to the task interface
string url = "http://" + ip + ":44000/api/v2/task";
//XML that will be POST'ed
string xmlData = string.Format(
@"<?xml version=""1.0""?>
<methodcall>
  <name>setconfiguration</name>
  <params>
    <configname>preparationspan</configname>
    <configvalue>10</configvalue>
  </params>
</methodcall>");
//POST to interface
HttpResponseMessage response = await new HttpClient().PostAsync(url, new StringContent(xmlData,
        Encoding.UTF8, "application/xml"));
string responseString = await response.Content.ReadAsStringAsync();
Console.WriteLine(responseString);

# Interface installation location (IP address)
ip = "127.0.0.1"
# The URL to the task interface
url = f"http://{ip}:44000/api/v2/task"
# XML that will be POST'ed
xmlData ="""<?xml version="1.0"?>
<methodcall>
  <name>setconfiguration</name>
  <params>
    <configname>preparationspan</configname>
    <configvalue>10</configvalue>
  </params>
</methodcall>"""
# POST to interface
response = requests.post(url, data=xmlData.encode('utf-8'), headers={"Content-Type": "application/xml"})
print(response.text)

const ip = "127.0.0.1";
const url = `http://${ip}:44000/api/v2/task`;
const xmlData = 
`<?xml version="1.0"?>
<methodcall>
  <name>setconfiguration</name>
  <params>
    <configname>preparationspan</configname>
    <configvalue>10</configvalue>
  </params>
</methodcall>`;

fetch(url, {
    method: 'POST',
    body: xmlData,
    headers: {
        'Content-Type': 'application/xml'
    }
})
    .then(response => response.text())
    .then(responseString => console.log(responseString));

<?xml version="1.0"?>
<methodcall>
  <name>setconfiguration</name>
  <params>
    <configname>preparationspan</configname>
    <configvalue>10</configvalue>
  </params>
</methodcall>

{
    "method": "setconfiguration",
    "params": {
        "configname": "preparationspan",
        "configvalue": "10"
    }
}

Response parameters

This method has no response parameters.

Response example

<?xml version="1.0"?>
<response>
  <params/>
</response>

OR

<?xml version="1.0"?>
<response>
  <fault>
    <code>1000</code>
  </fault>
</response>

Error Codes

Error Code	Description
1084	Invalid parameter configname.
1085	Invalid parameter configvalue.

Software version requirement

Software Release October 2022 and newer

Updated 23 days ago