Measurement

Defines a measurable or commanded value that can be recorded in Food & Beverage operations.

For example, product temperature, fill weight, line speed, pressure, or a machine setpoint can each be defined as a Measurement.

A Measurement describes what the value means, how Pulse should interpret it, and whether it represents an observed value or a commanded setpoint.

Measurement definitions must exist before values are submitted through Readings or Settings.

The Measurement object

{
  "code": "freezer-door",
  "name": "Freezer door open",
  "unit": "",
  "valueType": "Boolean",
  "semanticType": "Ambient",
  "parameterClass": "Measurement",
  "aggregation": "Mode",
  "capture": "EventOnChange",
  "intervalSeconds": null,
  "minValue": null,
  "maxValue": null
}

Fields

Value types

Use valueType to describe the shape of values submitted for the measurement.

Value	Use for
Continuous	Numeric values such as temperature, pressure, weight, speed, or cost
Ordinal	Ordered categories such as low, normal, and high
Categorical	Unordered categories such as operating mode or selector position
Boolean	Two-state values such as open/closed or on/off

Measurement and setpoint values

The parameterClass field determines what kind of value the definition represents.

Measurement represents something observed from the process or equipment.

For example:

{
  "code": "product-temp",
  "name": "Product temperature",
  "unit": "C",
  "valueType": "Continuous",
  "semanticType": "Quality",
  "parameterClass": "Measurement",
  "aggregation": "Avg",
  "capture": "Sampled"
}

Values for these definitions are submitted through Readings.

Setpoint represents a value commanded by a person or control system.

For example:

{
  "code": "fill-target",
  "name": "Fill target",
  "unit": "g",
  "valueType": "Continuous",
  "semanticType": "Quality",
  "parameterClass": "Setpoint",
  "aggregation": "Last",
  "capture": "EventOnChange"
}

Values for these definitions are submitted through Settings.

Measured values and setpoints are kept separate because what a machine was commanded to do and what it actually did are different facts.

Capture modes

Sampled measurements are recorded repeatedly on an interval, such as a temperature reading every 120 seconds.

EventOnChange measurements are recorded only when their value changes, such as a door opening or a setpoint being changed.

There is no Derived capture mode. Values calculated from other measurements are produced by Pulse rather than submitted as captured values.

Value bounds

minValue and maxValue identify values that are physically or technically implausible.

For example, a temperature sensor reporting 900 C may indicate a broken instrument rather than a valid process measurement.

Plausible bounds are not process targets or product specification limits.

Use Product limits or Targets for expected or permitted operating ranges.

API resource

Resource	Base path
Measurement	/manufacturing/food-beverage/v1/measurements

API methods

Create a measurement

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

Creates a new measurement definition.

Request

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

{
  "code": "freezer-door",
  "name": "Freezer door open",
  "unit": "",
  "valueType": "Boolean",
  "semanticType": "Ambient",
  "parameterClass": "Measurement",
  "aggregation": "Mode",
  "capture": "EventOnChange",
  "intervalSeconds": null,
  "minValue": null,
  "maxValue": null
}

Parameters

Parameter	Type	Required	Description
code	string	yes	Unique business code of the measurement.
name	string	yes	Human-readable name of the measurement.
unit	string	no	Unit in which values are expressed.
valueType	string	yes	Kind of value carried by the measurement.
semanticType	string	yes	Business meaning of the measurement.
parameterClass	string	yes	Measurement or Setpoint.
aggregation	string	yes	Aggregation method used for multiple values.
capture	string	yes	Sampled or EventOnChange.
intervalSeconds	integer or null	no	Expected interval between sampled values, in seconds.
minValue	number or null	no	Optional lower plausible bound.
maxValue	number or null	no	Optional upper plausible bound.

Update a measurement

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

Updates an existing measurement definition.

Request

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

{
  "code": "freezer-door",
  "name": "Freezer door status",
  "unit": "",
  "valueType": "Boolean",
  "semanticType": "Ambient",
  "parameterClass": "Measurement",
  "aggregation": "Mode",
  "capture": "EventOnChange",
  "intervalSeconds": null,
  "minValue": null,
  "maxValue": null
}

Patch a measurement

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

Partially updates an existing measurement definition.

The fields to update are supplied in the properties object. The measurement is identified by its business code.

Request

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

{
  "properties": {
    "code": "freezer-door",
    "name": "Freezer door status",
    "capture": "EventOnChange"
  }
}

Parameters

Parameter	Type	Required	Description
properties	object	yes	Fields included in the partial update.
properties.code	string	yes	Unique business code of the measurement to update.
properties.name	string	no	New human-readable name.
properties.unit	string or null	no	New unit.
properties.valueType	string	no	New value type.
properties.semanticType	string	no	New semantic type.
properties.parameterClass	string	no	New parameter class.
properties.aggregation	string	no	New aggregation method.
properties.capture	string	no	New capture mode.
properties.intervalSeconds	integer or null	no	New expected interval in seconds.
properties.minValue	number or null	no	New lower plausible bound.
properties.maxValue	number or null	no	New upper plausible bound.

Retrieve a measurement

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

Returns the measurement identified by its business code.

Request

GET /manufacturing/food-beverage/v1/measurements/select?id=freezer-door

Parameters

Parameter	Type	Required	Description
id	string	yes	Business code of the measurement to retrieve.

Example response

{
  "code": "freezer-door",
  "name": "Freezer door open",
  "unit": "",
  "valueType": "Boolean",
  "semanticType": "Ambient",
  "parameterClass": "Measurement",
  "aggregation": "Mode",
  "capture": "EventOnChange",
  "intervalSeconds": null,
  "minValue": null,
  "maxValue": null
}

List measurements

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

Returns measurement definitions matching the supplied filters.

Request

GET /manufacturing/food-beverage/v1/measurements/query?parameterClasses=Measurement&semanticTypes=Ambient

Query parameters

Parameter	Type	Required	Description
codes	string or array of strings	no	Limits results to measurements with the specified business codes.
parameterClasses	string or array of strings	no	Limits results to measurements with the specified parameter classes.
semanticTypes	string or array of strings	no	Limits results to measurements with the specified semantic types.

Example response

[
  {
    "code": "freezer-door",
    "name": "Freezer door open",
    "unit": "",
    "valueType": "Boolean",
    "semanticType": "Ambient",
    "parameterClass": "Measurement",
    "aggregation": "Mode",
    "capture": "EventOnChange",
    "intervalSeconds": null,
    "minValue": null,
    "maxValue": null
  }
]

Delete a measurement

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

Deletes the measurement identified by its business code.

Request

DELETE /manufacturing/food-beverage/v1/measurements/delete?id=freezer-door

Parameters

Parameter	Type	Required	Description
id	string	yes	Business code of the measurement to delete.