Shared Entities API

The shared entities are available through their own base route. It is the same for every manufacturing domain model, so an integration uses it alongside the base route of its domain model.

Base route

{host}/manufacturing/v1/{resource}

For example:

/manufacturing/v1/sites
/manufacturing/v1/materials
/manufacturing/v1/readings

Authentication is the same as for the domain model resources. See Authentication.

Resources

Operations

Every shared resource supports the same operations:

POST   /{resource}/insert
PUT    /{resource}/update
PATCH  /{resource}/patch
GET    /{resource}/select
GET    /{resource}/query
DELETE /{resource}/delete

• Insert returns the Pulse identifier of the new record as a number.
• Select and delete identify the record by its business key. For most resources, this is its code. Types, readings, settings, and parts and labour use a combination of fields, described on their pages.
• Patch changes only the properties you send. The record's code is required in the properties: it identifies the record and cannot be changed. Properties you leave out keep their current values.
• Query returns the records that match the filters you send. The filters are described on each resource's page.

Business codes

Shared entities use business codes rather than Pulse internal identifiers. References to other records, including records of the domain model, also use business codes.

For example, a material refers to its group by the group's code:

{
  "code": "STEEL-S355",
  "name": "Structural steel S355",
  "unit": "kg",
  "group": "MG-RAW"
}

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

.NET client

The .NET client of each domain model includes the services for the shared entities. For setting up the client and the list of its services, see the .NET client page of your domain model:

• Food & Beverage .NET client
• Metal & Machining .NET client