Machine – Pulse

Represents a machine, equipment asset, component, sensor, or probe in Pulse.

For example, a filler can be registered as a Machine, while an individual filler head or temperature probe can be registered as a child Machine.

Machines can be organised hierarchically. A machine can belong to another machine, a production line, or a site.

The Machine object

{
  "code": "EQ010-H06",
  "name": "Filler 1 head 6",
  "parent": "EQ010",
  "measures": "fill-weight"
}

Fields

Field	Type	Description	Example
`code`	string	Unique business code used to identify the machine in external systems and integrations.	`"EQ010-H06"`
`name`	string	Human-readable name of the machine.	`"Filler 1 head 6"`
`parent`	string	Business code of the machine, production line, or site that contains this machine.	`"EQ010"`
`measures`	string or null	Measurement code produced by the machine when it represents a sensor or probe.	`"fill-weight"`

Important

code must be unique. Two machines cannot use the same code.

The entity referenced by parent must already exist before the machine is submitted. parent can reference another machine, a production line, or a site.

When measures is provided, the referenced measurement must already exist.

See Types and attributes for guidance on extensible master-data properties.

Machine hierarchy

Machines can contain other machines or components with no fixed hierarchy depth.

For example:

Production line
└── Filler
    └── Filler head 6
        └── Nozzle

Each machine references the entity directly above it through parent.

A machine can also belong directly to a site. For example, a cold room does not need to belong to a production line.

Sensors

A machine can also represent a sensor or probe.

When the machine produces a measurement, measures identifies the measurement it reads:

{
  "code": "TEMP-PROBE-01",
  "name": "Cold room temperature probe",
  "parent": "COLD-ROOM-01",
  "measures": "temperature"
}

For machines that do not produce measurements, measures can be omitted or set to null.

API resource

Resource	Base path
`Machine`	`/manufacturing/food-beverage/v1/machines`

API methods

Create a machine

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

Creates a new machine, component, or sensor.

Request

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

{
  "code": "EQ010-H06",
  "name": "Filler 1 head 6",
  "parent": "EQ010",
  "measures": "fill-weight"
}

Parameters

Parameter	Type	Required	Description
`code`	string	yes	Unique business code of the machine.
`name`	string	yes	Human-readable name of the machine.
`parent`	string	yes	Business code of the machine, production line, or site that contains the machine.
`measures`	string or null	no	measurement code produced by the machine when it represents a sensor or probe.

Update a machine

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

Updates an existing machine.

Request

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

{
  "code": "EQ010-H06",
  "name": "Filler 1 head 6",
  "parent": "EQ010",
  "measures": "fill-weight"
}

Changing parent moves the machine within the equipment hierarchy.

Parameters

Parameter	Type	Required	Description
`code`	string	yes	Unique business code of the machine to update.
`name`	string	yes	Human-readable name of the machine.
`parent`	string	yes	Business code of the machine, production line, or site that contains the machine.
`measures`	string or null	no	measurement code produced by the machine when it represents a sensor or probe.

Patch a machine

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

Partially updates an existing machine.

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

Request

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

{
  "properties": {
    "code": "EQ010-H06",
    "name": "Filler head 6",
    "parent": "EQ010",
    "measures": "fill-weight"
  }
}

Parameters

Parameter	Type	Required	Description
`properties`	object	yes	Fields included in the partial update.
`properties.code`	string	yes	Unique business code of the machine to update.
`properties.name`	string	no	New human-readable name of the machine.
`properties.parent`	string	no	New parent machine, production line, or site code.
`properties.measures`	string or null	no	New measurement code produced by the machine.

Retrieve a machine

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

Returns the machine identified by its business code.

Request

GET /manufacturing/food-beverage/v1/machines/select?id=EQ010-H06

Parameters

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

Example response

{
  "code": "EQ010-H06",
  "name": "Filler 1 head 6",
  "parent": "EQ010",
  "measures": "fill-weight"
}

List machines

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

Returns machines matching the supplied filters.

Machines can be filtered by code, name, and parent.

Request

GET /manufacturing/food-beverage/v1/machines/query?parents=EQ010

Query parameters

Parameter	Type	Required	Description
`codes`	string or array of strings	no	Limits results to machines with the specified business codes.
`names`	string or array of strings	no	Limits results to machines with the specified names.
`parents`	string or array of strings	no	Limits results to machines with the specified parents.

Example response

[
  {
    "code": "EQ010-H05",
    "name": "Filler 1 head 5",
    "parent": "EQ010",
    "measures": null
  },
  {
    "code": "EQ010-H06",
    "name": "Filler 1 head 6",
    "parent": "EQ010",
    "measures": "fill-weight"
  }
]

Delete a machine

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

Deletes the machine identified by its business code.

Request

DELETE /manufacturing/food-beverage/v1/machines/delete?id=EQ010-H06

Parameters

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