Represents something you set, for example a target temperature, a speed setting, or a target fill weight. In the Excel templates, setpoints are registered on the What you set sheet.
A setpoint defines a code for a commanded value. The values themselves are submitted as settings.
Values that are measured rather than commanded, such as an actual temperature, are registered as measurements instead.
Setpoints are a shared entity. They work the same way in every manufacturing domain model.
The Setpoint object
{
"code": "oven-setpoint",
"name": "Oven temperature setpoint",
"unit": "°C",
"valueType": 0,
"plausibleMin": 0,
"plausibleMax": 400
}
Fields
| Field | Type | Description | Example |
|---|---|---|---|
code |
string | Unique business code of the setpoint. Settings refer to it. | "oven-setpoint" |
name |
string | Human-readable name of the setpoint. | "Oven temperature setpoint" |
unit |
string or null | Unit of the values. Leave it empty for yes/no values and categories. | "°C" |
valueType |
integer | Kind of value, as a number. See Kinds of value. | 0 |
plausibleMin |
number or null | Lowest value that can plausibly be set. Values below it are kept, but marked as suspect. | 0 |
plausibleMax |
number or null | Highest value that can plausibly be set. Values above it are kept, but marked as suspect. | 400 |
Important
code must be unique across setpoints, measurements, and the other codes Pulse uses for values. A code that is already used for something else, for example a measurement, is refused.
A setpoint has no reading interval: a new value is recorded each time the setting changes, and the last value applies until the next one. If you leave out valueType, it is 0 (continuous).
Each domain model reserves some codes for values it calculates or records itself. These codes cannot be registered as setpoints, and they are not returned by this resource.
API resource
| Resource | Base path |
|---|---|
Setpoint |
/manufacturing/v1/setpoints |
For the operations shared by all shared entities, see Shared entities API.
API methods
Create a setpoint
POST /manufacturing/v1/setpoints/insert
Creates a new setpoint and returns its Pulse identifier.
Request
POST /manufacturing/v1/setpoints/insert
Content-Type: application/json
{
"code": "oven-setpoint",
"name": "Oven temperature setpoint",
"unit": "°C",
"valueType": 0,
"plausibleMin": 0,
"plausibleMax": 400
}
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
code |
string | yes | Unique business code of the setpoint. |
name |
string | yes | Human-readable name of the setpoint. |
unit |
string or null | no | Unit of the values. |
valueType |
integer | no | Kind of value, as a number. Default: 0 (continuous). |
plausibleMin |
number or null | no | Lowest plausible value. |
plausibleMax |
number or null | no | Highest plausible value. |
Update a setpoint
PUT /manufacturing/v1/setpoints/update
Updates an existing setpoint. The setpoint must already exist.
An update replaces all fields. Fields you leave out are removed, and valueType returns to 0 (continuous). To change only some fields, use patch.
Request
PUT /manufacturing/v1/setpoints/update
Content-Type: application/json
{
"code": "oven-setpoint",
"name": "Oven temperature setpoint, zone 1",
"unit": "°C",
"valueType": 0,
"plausibleMin": 0,
"plausibleMax": 400
}
Parameters
The parameters are the same as for creating a setpoint. code identifies the setpoint to update.
Patch a setpoint
PATCH /manufacturing/v1/setpoints/patch
Partially updates an existing setpoint.
The fields to update are supplied in the properties object. The setpoint is identified by its business code, which cannot be changed. Fields you leave out keep their current values. To remove a value, send it as null.
Request
PATCH /manufacturing/v1/setpoints/patch
Content-Type: application/json
{
"properties": {
"code": "oven-setpoint",
"plausibleMax": 350
}
}
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
properties |
object | yes | Fields included in the partial update. |
properties.code |
string | yes | Business code of the setpoint to update. |
properties.name |
string | no | New name. |
properties.unit |
string or null | no | New unit, or null to remove it. |
properties.valueType |
integer | no | New kind of value, as a number. |
properties.plausibleMin |
number or null | no | New lowest plausible value, or null to remove it. |
properties.plausibleMax |
number or null | no | New highest plausible value, or null to remove it. |
Retrieve a setpoint
GET /manufacturing/v1/setpoints/select
Returns the setpoint identified by its business code. If no setpoint has this code, the response is empty.
Request
GET /manufacturing/v1/setpoints/select?id=oven-setpoint
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string | yes | Business code of the setpoint to retrieve. |
Example response
{
"code": "oven-setpoint",
"name": "Oven temperature setpoint",
"unit": "°C",
"valueType": 0,
"plausibleMin": 0,
"plausibleMax": 400
}
List setpoints
GET /manufacturing/v1/setpoints/query
Returns setpoints matching the supplied filters.
Request
GET /manufacturing/v1/setpoints/query?codes=oven-setpoint
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
codes |
string or array of strings | no | Limits results to setpoints with the specified business codes. |
Example response
[
{
"code": "oven-setpoint",
"name": "Oven temperature setpoint",
"unit": "°C",
"valueType": 0,
"plausibleMin": 0,
"plausibleMax": 400
}
]
Delete a setpoint
DELETE /manufacturing/v1/setpoints/delete
Deletes the setpoint identified by its business code. If no setpoint has this code, nothing happens.
Request
DELETE /manufacturing/v1/setpoints/delete?id=oven-setpoint
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string | yes | Business code of the setpoint to delete. |