Represents one value of a setpoint on a machine, recorded at the time it was set, for example the oven temperature setpoint changed to 180 °C. In the Excel templates, settings are registered on the Settings sheet.
A setting applies from its time until the next setting of the same setpoint on the same machine.
Settings are a shared entity. They work the same way in every manufacturing domain model.
The Setting object
{
"machine": "MC-01",
"measurement": "oven-setpoint",
"value": 180,
"at": "2026-09-10T06:00:00+02:00"
}
Fields
| Field | Type | Description | Example |
|---|---|---|---|
machine |
string | Business code of the machine the value was set on. | "MC-01" |
measurement |
string | Business code of the setpoint. | "oven-setpoint" |
value |
number, boolean, or string | The value that was set. Its type depends on the setpoint's kind of value. | 180 |
at |
string | When the value was set, as an ISO 8601 timestamp with a UTC offset. | "2026-09-10T06:00:00+02:00" |
A setting is identified by machine, measurement, and at together.
Rules
-
machinemust be the business code of an existing machine. -
measurementmust be a code registered in What you set. A measurement is refused: measured values are submitted as readings. - Codes the domain model records itself are refused.
-
valuemust match the setpoint's kind of value, in the same way as for readings. A value of the wrong type is refused. A number outside the setpoint's plausible range is kept, but marked as suspect.
API resource
| Resource | Base path |
|---|---|
Setting |
/manufacturing/v1/settings |
For the operations shared by all shared entities, see Shared entities API.
API methods
Create a setting
POST /manufacturing/v1/settings/insert
Records a new setting and returns its Pulse identifier.
Request
POST /manufacturing/v1/settings/insert
Content-Type: application/json
{
"machine": "MC-01",
"measurement": "oven-setpoint",
"value": 180,
"at": "2026-09-10T06:00:00+02:00"
}
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
machine |
string | yes | Business code of the machine. |
measurement |
string | yes | Business code of the setpoint. |
value |
number, boolean, or string | yes | The value that was set. |
at |
string | yes | When the value was set. |
Update a setting
PUT /manufacturing/v1/settings/update
Changes the value of an existing setting. The setting is identified by machine, measurement, and at, and must already exist.
Request
PUT /manufacturing/v1/settings/update
Content-Type: application/json
{
"machine": "MC-01",
"measurement": "oven-setpoint",
"value": 185,
"at": "2026-09-10T06:00:00+02:00"
}
Parameters
The parameters are the same as for creating a setting.
Patch a setting
PATCH /manufacturing/v1/settings/patch
Partially updates an existing setting.
The setting is identified by machine, measurement, and at in the properties object.
Request
PATCH /manufacturing/v1/settings/patch
Content-Type: application/json
{
"properties": {
"machine": "MC-01",
"measurement": "oven-setpoint",
"at": "2026-09-10T06:00:00+02:00",
"value": 185
}
}
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
properties |
object | yes | Fields included in the partial update. |
properties.machine |
string | yes | Machine of the setting to update. |
properties.measurement |
string | yes | Setpoint of the setting to update. |
properties.at |
string | yes | Time of the setting to update. |
properties.value |
number, boolean, or string | no | New value. |
Retrieve a setting
GET /manufacturing/v1/settings/select
Returns the setting identified by its key. If there is no such setting, the response is empty.
Request
GET /manufacturing/v1/settings/select?machine=MC-01&measurement=oven-setpoint&at=2026-09-10T06:00:00%2B02:00
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
machine |
string | yes | Machine of the setting. |
measurement |
string | yes | Setpoint of the setting. |
at |
string | yes | Time of the setting. |
Example response
{
"machine": "MC-01",
"measurement": "oven-setpoint",
"value": 180,
"at": "2026-09-10T06:00:00+02:00"
}
List settings
GET /manufacturing/v1/settings/query
Returns settings matching the supplied filters.
Request
GET /manufacturing/v1/settings/query?machines=MC-01&measurements=oven-setpoint
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
machines |
string or array of strings | no | Limits results to settings on the specified machines. |
measurements |
string or array of strings | no | Limits results to the specified setpoints. |
from |
string | no | Limits results to settings at or after this time. |
to |
string | no | Limits results to settings up to this time. |
Example response
[
{
"machine": "MC-01",
"measurement": "oven-setpoint",
"value": 180,
"at": "2026-09-10T06:00:00+02:00"
}
]
Delete a setting
DELETE /manufacturing/v1/settings/delete
Deletes the setting identified by its key. If there is no such setting, nothing happens.
Request
DELETE /manufacturing/v1/settings/delete?machine=MC-01&measurement=oven-setpoint&at=2026-09-10T06:00:00%2B02:00
Parameters
The parameters are the same as for retrieving a setting.