Setting

Records a commanded or configured value applied to a Machine.

For example, a filler may be configured with a target fill weight, or a machine may be given a speed or temperature setpoint.

Settings represent values explicitly configured on equipment rather than values measured from the process.

The Setting object

{
  "machine": "EQ010",
  "measure": "fill-target",
  "value": 130,
  "at": "2026-08-10T22:10:00+02:00"
}

Fields

Record changes

Submit a Setting when the configured value changes.

For example, these are two separate Setting records:

{
  "machine": "EQ010",
  "measure": "fill-target",
  "value": 130,
  "at": "2026-08-10T22:10:00+02:00"
}

and:

{
  "machine": "EQ010",
  "measure": "fill-target",
  "value": 128,
  "at": "2026-08-11T02:15:00+02:00"
}

Each record preserves the configured value together with the time at which it was applied.

There is normally no need to repeatedly submit the same unchanged value on a timer.

Value type

The Measurement definition determines how value is interpreted.

For example:

{
  "value": 130
}

for a numeric setpoint,

{
  "value": true
}

for a Boolean setpoint, or:

{
  "value": "high"
}

for a categorical setpoint.

Values must be compatible with the Measurement's declared value type.

Plausibility

Numeric Measurements can define plausible bounds through minValue and maxValue.

When a numeric Setting falls outside those bounds, Pulse retains the submitted value but marks it as bad-quality data internally.

This preserves the configured value while allowing suspicious values to be identified during analysis.

Settings and readings

Settings describe what the Machine was commanded or configured to do.

Readings describe what was actually measured.

Commanded value → Setting
Measured value  → Reading

Keeping them separate allows Pulse to compare the configured value with the observed result.

For example:

fill-target Setting  → 128 g
fill-weight Reading  → 131.2 g

The difference between the two provides context for process performance and variation.

Corrections

A Setting is identified by:

machine + measure + at

Use update or patch to correct the configured value while keeping the same composite key.

For example, to correct:

EQ010 / fill-target / 2026-08-10T22:10:00+02:00

submit the same key with a new value.

Reference protection

A Machine referenced by an existing Setting cannot be deleted while the Setting still references it.

API resource

Resource	Base path
Setting	/manufacturing/food-beverage/v1/settings

API methods

Submit a setting

POST /manufacturing/food-beverage/v1/settings/insert

Records one commanded or configured Machine value.

Request

POST /manufacturing/food-beverage/v1/settings/insert
Content-Type: application/json

{
  "machine": "EQ010",
  "measure": "fill-target",
  "value": 130,
  "at": "2026-08-10T22:10:00+02:00"
}

Parameters

Parameter	Type	Required	Description
machine	string	yes	Business code of the Machine.
measure	string	yes	Business code of a Measurement declared as a Setpoint.
value	number, string, or boolean	yes	Configured value.
at	string	yes	Date and time when the Setting was applied.

Update a setting

PUT /manufacturing/food-beverage/v1/settings/update

Updates the value of an existing Setting.

The Setting is identified by machine, measure, and at.

Request

PUT /manufacturing/food-beverage/v1/settings/update
Content-Type: application/json

{
  "machine": "EQ010",
  "measure": "fill-target",
  "value": 128,
  "at": "2026-08-10T22:10:00+02:00"
}

Patch a setting

PATCH /manufacturing/food-beverage/v1/settings/patch

Partially updates an existing Setting.

The Setting is identified by properties.machine, properties.measure, and properties.at. All three are required.

PATCH changes the value; the composite key itself remains unchanged.

Request

PATCH /manufacturing/food-beverage/v1/settings/patch
Content-Type: application/json

{
  "properties": {
    "machine": "EQ010",
    "measure": "fill-target",
    "at": "2026-08-10T22:10:00+02:00",
    "value": 128
  }
}

Parameters

Parameter	Type	Required	Description
properties	object	yes	Fields included in the partial update.
properties.machine	string	yes	Machine business code identifying the Setting.
properties.measure	string	yes	Measurement business code identifying the Setting.
properties.at	string	yes	Timestamp identifying the Setting.
properties.value	number, string, or boolean	no	New configured value.

Retrieve a setting

GET /manufacturing/food-beverage/v1/settings/select

Returns the Setting identified by its composite business key.

Request

GET /manufacturing/food-beverage/v1/settings/select?machine=EQ010&measure=fill-target&at=2026-08-10T22:10:00%2B02:00

Query parameters

Parameter	Type	Required	Description
machine	string	yes	Business code of the Machine.
measure	string	yes	Business code of the Measurement.
at	string	yes	Date and time of the Setting.

Example response

{
  "machine": "EQ010",
  "measure": "fill-target",
  "value": 130,
  "at": "2026-08-10T22:10:00+02:00"
}

List settings

GET /manufacturing/food-beverage/v1/settings/query

Returns Settings matching the supplied filters.

Request

GET /manufacturing/food-beverage/v1/settings/query?machines=EQ010&measures=fill-target

Query parameters

Parameter	Type	Required	Description
machines	string or array of strings	no	Limits results to the specified Machines.
measures	string or array of strings	no	Limits results to the specified Setpoint Measurements.
from	string	no	Limits results to Settings applied at or after the specified date and time.
to	string	no	Limits results to Settings applied at or before the specified date and time.

Multiple values can be supplied by repeating the query parameter:

GET /manufacturing/food-beverage/v1/settings/query?machines=EQ010&machines=EQ011

Delete a setting

DELETE /manufacturing/food-beverage/v1/settings/delete

Deletes the Setting identified by its composite business key.

Request

DELETE /manufacturing/food-beverage/v1/settings/delete?machine=EQ010&measure=fill-target&at=2026-08-10T22:10:00%2B02:00

Query parameters

Parameter	Type	Required	Description
machine	string	yes	Business code of the Machine.
measure	string	yes	Business code of the Measurement.
at	string	yes	Date and time of the Setting.