Setup rule

Defines how long a changeover from one setup family to another is expected to take.

For example, changing a turning cell from small shafts to flanges may be expected to take 35 minutes, while the reverse changeover takes 20. In the Excel template, setup rules are registered on the Setup rules sheet.

Setup rules are declared between setup families rather than individual parts, because a job shop rarely runs the same pair of parts twice.

The Setup rule object

{
  "after": "SHAFT-SMALL",
  "before": "FLANGE",
  "expectedMinutes": 35,
  "where": "TURN-CELL-01",
  "from": "2026-09-01T00:00:00+02:00"
}

Fields

Setup families

after and before are values of the classification Setup family (setup-family). Register them first as Types (shared). Parts and fixtures name their setup family the same way.

Rules

• after and before are required and must be existing setup families.
• where is optional. When it is given, it must be an existing work centre. The same pair of families can have a shop-wide rule and a different rule for each work centre.
• A rule holds one version. Submitting a rule for the same after, before, and where replaces its expected minutes and from.

API resource

API methods

Create a setup rule

POST /manufacturing/metal-machining/v1/setup-rules/insert

Creates a Setup rule and returns its Pulse identifier. If a rule with the same after, before, and where exists, it is updated instead.

Request

POST /manufacturing/metal-machining/v1/setup-rules/insert
Content-Type: application/json

{
  "after": "SHAFT-SMALL",
  "before": "FLANGE",
  "expectedMinutes": 35,
  "where": "TURN-CELL-01",
  "from": "2026-09-01T00:00:00+02:00"
}

Parameters

Update a setup rule

PUT /manufacturing/metal-machining/v1/setup-rules/update

Updates the rule identified by after, before, and where. If no such rule exists, it is created.

Request

PUT /manufacturing/metal-machining/v1/setup-rules/update
Content-Type: application/json

{
  "after": "SHAFT-SMALL",
  "before": "FLANGE",
  "expectedMinutes": 30,
  "where": "TURN-CELL-01",
  "from": "2026-10-01T00:00:00+02:00"
}

Parameters

The parameters are the same as for creating a setup rule.

Patch a setup rule

PATCH /manufacturing/metal-machining/v1/setup-rules/patch

Partially updates an existing Setup rule.

The rule is identified by properties.after, properties.before, and, for a work-centre rule, properties.where. Leave out where to patch the shop-wide rule. Fields you leave out keep their current values.

Request

PATCH /manufacturing/metal-machining/v1/setup-rules/patch
Content-Type: application/json

{
  "properties": {
    "after": "SHAFT-SMALL",
    "before": "FLANGE",
    "where": "TURN-CELL-01",
    "expectedMinutes": 30
  }
}

Parameters

Retrieve a setup rule

GET /manufacturing/metal-machining/v1/setup-rules/select

Returns the rule identified by after, before, and where. If no rule matches, the response is empty.

Request

GET /manufacturing/metal-machining/v1/setup-rules/select?after=SHAFT-SMALL&before=FLANGE&where=TURN-CELL-01

Query parameters

List setup rules

GET /manufacturing/metal-machining/v1/setup-rules/query

Returns Setup rules matching the supplied filters.

Request

GET /manufacturing/metal-machining/v1/setup-rules/query?afters=SHAFT-SMALL&wheres=TURN-CELL-01

Query parameters

Delete a setup rule

DELETE /manufacturing/metal-machining/v1/setup-rules/delete

Deletes the rule identified by after, before, and where. If no rule matches, nothing happens.

Request

DELETE /manufacturing/metal-machining/v1/setup-rules/delete?after=SHAFT-SMALL&before=FLANGE&where=TURN-CELL-01

Query parameters