The Pulse API is a REST API for submitting Food & Beverage integration data and retrieving Pulse results.
This page provides an index of the public API resource groups. Use Scalar for the complete operation-level reference, including request fields, parameters, schemas, responses, and the exact operations supported by each resource.
API groups
Using this reference
Use this page to identify the relevant API resource and its base path.
Open the resource documentation for integration guidance and examples. Use Scalar to inspect the complete generated API contract.
API conventions
Base route
Food & Beverage resources use the following base route:
{host}/manufacturing/food-beverage/v1/{resource}
For example:
/manufacturing/food-beverage/v1/products
/manufacturing/food-beverage/v1/runs
/manufacturing/food-beverage/v1/readings
Business codes
Food & Beverage integrations use business codes rather than Pulse internal numeric identifiers.
For example:
{
"code": "YOG-RUN-001",
"line": "YOGURT-LINE-01",
"product": "YOG-STRAWBERRY-150G"
}
References to related records also use their business codes.
Resource identity
Some resources are identified by a single business code. Others use a documented combination of business fields.
For example:
- Site:
code - Stage:
run + stage - Output:
run + kind + at - Reading:
subject + measure + sensor + at - Line time:
line + condition + from
For composite keys, optional key fields are included when present. For example, sensor is part of the Reading key when a sensor is supplied.
Select, update, patch, and delete operations use the business key documented for that resource.
Operations
Resources implemented through the current Food & Beverage service pattern use operation-specific paths such as:
POST /{resource}/insert
PUT /{resource}/update
PATCH /{resource}/patch
GET /{resource}/select
GET /{resource}/query
DELETE /{resource}/delete
The operations available for individual resources may differ. See the resource documentation for the exact contract.
Timestamps
Use ISO 8601 timestamps with an explicit UTC offset where a date and time is required.
For example:
2026-08-10T22:00:00+02:00
Master data
Master data contains the relatively stable business records referenced by Food & Beverage integrations.
See Master data.
| Resource | Description | Base path |
|---|---|---|
| Site | Physical operating location. | /manufacturing/food-beverage/v1/sites |
| Production line | Production line within a site. | /manufacturing/food-beverage/v1/lines |
| Machine | Machine, component, sensor, or wear part. | /manufacturing/food-beverage/v1/machines |
| Vessel | Tank, silo, or other process vessel. | /manufacturing/food-beverage/v1/vessels |
| Product | Finished product or other tracked production output. | /manufacturing/food-beverage/v1/products |
| Recipe | Recipe or formulation version used during production. | /manufacturing/food-beverage/v1/recipes |
| Material | Ingredient, packaging material, chemical, or other production material. | /manufacturing/food-beverage/v1/materials |
| Cost line | Non-material cost used in production or maintenance. | /manufacturing/food-beverage/v1/cost-lines |
| Supplier | Supplier associated with materials and incoming lots. | /manufacturing/food-beverage/v1/suppliers |
| Customer | Customer associated with Food & Beverage operations. | /manufacturing/food-beverage/v1/customers |
| Shift | Work period used as production context. | /manufacturing/food-beverage/v1/shifts |
| Crew | Team used as Labor and production context. | /manufacturing/food-beverage/v1/crews |
See Types and attributes for guidance on controlled classifications and extensible master-data properties.
Definitions and rules
Definitions and rules describe measurements, limits, classifications, and operational rules used by other Food & Beverage resources.
| Resource | Description | Base path |
|---|---|---|
| Measurements | Defines measurements and setpoints accepted by Pulse. | /manufacturing/food-beverage/v1/measurements |
| Product limits | Defines time-effective product specification limits. | /manufacturing/food-beverage/v1/product-limits |
| Targets | Defines expected operating ranges or target values. | /manufacturing/food-beverage/v1/targets |
| Clean regimes | Defines cleaning regimes used by cleaning activities and rules. | /manufacturing/food-beverage/v1/clean-regimes |
| Cleaning rules | Defines the cleaning required between two products. | /manufacturing/food-beverage/v1/cleaning-rules |
| Reasons | Defines hierarchical reason codes used across operational records. | /manufacturing/food-beverage/v1/reasons |
| Types | Defines controlled classifications and their allowed values. | /manufacturing/food-beverage/v1/types |
Production activities
Production activities describe the work performed during production, from incoming material lots through bulk processing, filling, packing, cleaning, and quality holds.
| Resource | Description | Base path |
|---|---|---|
| Lot | Records a traceable quantity of material received from a supplier. | /manufacturing/food-beverage/v1/lots |
| Batch | Records bulk production such as cooking, fermentation, or blending. | /manufacturing/food-beverage/v1/batches |
| Run | Records filling or packing production on a production line. | /manufacturing/food-beverage/v1/runs |
| Planned use | Defines resources a run, batch, or clean is expected to use. | /manufacturing/food-beverage/v1/planned-use |
| Stage | Records an execution step within a production run. | /manufacturing/food-beverage/v1/stages |
| Clean | Records cleaning work between two products. | /manufacturing/food-beverage/v1/cleans |
| Hold | Records a quality hold placed on finished stock. | /manufacturing/food-beverage/v1/holds |
Operational data
Operational data records what actually happened during production.
See Operational data.
| Resource | Description | Base path |
|---|---|---|
| Consumption | Records resources actually used by a run, batch, or clean. | /manufacturing/food-beverage/v1/consumption |
| Output | Records good output, waste, downgrade, and reject quantities. | /manufacturing/food-beverage/v1/output |
| Readings | Records measured values captured during production. | /manufacturing/food-beverage/v1/readings |
| Settings | Records commanded or configured machine values. | /manufacturing/food-beverage/v1/settings |
| Line time | Records non-running or constrained production-line intervals. | /manufacturing/food-beverage/v1/line-time |
| Events | Records discrete operational occurrences. | /manufacturing/food-beverage/v1/events |
Maintenance and quality
Maintenance and quality resources cover maintenance work, resources used during maintenance, and customer complaints linked back to production.
| Resource | Description | Base path |
|---|---|---|
| Work orders | Records preventive or corrective maintenance work. | /manufacturing/food-beverage/v1/work-orders |
| Parts and Labor | Records planned and actual maintenance resource use. | /manufacturing/food-beverage/v1/parts-and-labour |
| Complaints | Records customer complaints linked to products and traceable finished lots. | /manufacturing/food-beverage/v1/complaints |