Check

Represents a quality check you perform on your product, for example pH, fat content, moisture, or fill weight. In the Excel template, checks are registered on the What you check sheet.

A check defines a code for a quality result. The results themselves are submitted as readings, in the same way as values of What you measure.

Use What you check for results about the product, and What you measure for conditions such as temperatures and pressures.

The Check object

{
  "code": "ph",
  "name": "pH",
  "unit": null,
  "valueType": 0,
  "plausibleMin": 0,
  "plausibleMax": 14
}

Fields

If you leave out valueType, it is 0 (continuous). A check has no reading interval: each result is recorded when it is taken.

Where checks are used

• Readings: quality results are submitted as readings with the check's code as measurement.
• Machines and sensors: a machine's measures field can name a check, for example an in-line pH sensor.
• Product limits: a product limit can set the allowed range of a check for a product.

Register checks before production lines and machines, because machines can name the checks they perform.

Reserved codes

Some codes are used by Pulse itself, for example for yield, OEE, and quality percentages that Pulse calculates, and for the analysis of incoming lots (incoming-fat, incoming-protein, incoming-ph, incoming-brix). These codes are not returned by this resource. Do not use them for your own checks: a code that is already in use is refused.

API resource

API methods

Create a check

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

Creates a new check and returns its Pulse identifier.

Request

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

{
  "code": "ph",
  "name": "pH",
  "valueType": 0,
  "plausibleMin": 0,
  "plausibleMax": 14
}

Parameters

Update a check

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

Updates an existing check. The check 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/food-beverage/v1/checks/update
Content-Type: application/json

{
  "code": "ph",
  "name": "pH value",
  "valueType": 0,
  "plausibleMin": 0,
  "plausibleMax": 14
}

Parameters

The parameters are the same as for creating a check. code identifies the check to update.

Patch a check

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

Partially updates an existing check.

The fields to update are supplied in the properties object. The check 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/food-beverage/v1/checks/patch
Content-Type: application/json

{
  "properties": {
    "code": "ph",
    "plausibleMin": 2
  }
}

Parameters

Retrieve a check

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

Returns the check identified by its business code. If no check has this code, the response is empty.

Request

GET /manufacturing/food-beverage/v1/checks/select?id=ph

Parameters

List checks

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

Returns checks matching the supplied filters.

Request

GET /manufacturing/food-beverage/v1/checks/query?codes=ph

Query parameters

Delete a check

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

Deletes the check identified by its business code. If no check has this code, nothing happens.

Request

DELETE /manufacturing/food-beverage/v1/checks/delete?id=ph

Parameters