Represents a physical operating location in Pulse.
For example, a factory or production facility in Munich can be registered as a Site.
A site is the root of the manufacturing hierarchy. Production lines belong to a site.
The Site object
{
"code": "PLT001",
"name": "Munich"
}
Fields
| Field | Type | Description | Example |
|---|---|---|---|
code |
string | Unique business code used to identify the site in external systems and integrations. | "PLT001" |
name |
string | Human-readable name of the site. | "Munich" |
Important
code must be unique. Two sites cannot use the same code.
See Types and attributes for guidance on extensible master-data properties.
API resource
| Resource | Base path |
|---|---|
Site |
/manufacturing/food-beverage/v1/sites |
API methods
Create a site
POST /manufacturing/food-beverage/v1/sites/insert
Creates a new site.
Request
POST /manufacturing/food-beverage/v1/sites/insert
Content-Type: application/json
{
"code": "PLT001",
"name": "Munich"
}
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
code |
string | yes | Unique business code of the site. |
name |
string | yes | Human-readable name of the site. |
Update a site
PUT /manufacturing/food-beverage/v1/sites/update
Updates an existing site.
Request
PUT /manufacturing/food-beverage/v1/sites/update
Content-Type: application/json
{
"code": "PLT001",
"name": "Munich production site"
}
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
code |
string | yes | Unique business code of the site to update. |
name |
string | yes | Human-readable name of the site. |
Patch a site
PATCH /manufacturing/food-beverage/v1/sites/patch
Partially updates an existing site.
The fields to update are supplied in the properties object. The site is identified by its business code.
Request
PATCH /manufacturing/food-beverage/v1/sites/patch
Content-Type: application/json
{
"properties": {
"code": "PLT001",
"name": "Munich production site"
}
}
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
properties |
object | yes | Fields included in the partial update. |
properties.code |
string | yes | Unique business code of the site to update. |
properties.name |
string | yes | Human-readable name of the site. |
Retrieve a site
GET /manufacturing/food-beverage/v1/sites/select
Returns the site identified by its business code.
Request
GET /manufacturing/food-beverage/v1/sites/select?id=PLT001
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string | yes | Business code of the site to retrieve. |
Example response
{
"code": "PLT001",
"name": "Munich"
}
List sites
GET /manufacturing/food-beverage/v1/sites/query
Returns sites matching the supplied filters.
Sites can be filtered by code and name.
Request
GET /manufacturing/food-beverage/v1/sites/query?codes=PLT001&names=Munich
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
codes |
string or array of strings | no | Limits results to sites with the specified business codes. |
names |
string or array of strings | no | Limits results to sites with the specified names. |
Example response
[
{
"code": "PLT001",
"name": "Munich"
}
]
Delete a site
DELETE /manufacturing/food-beverage/v1/sites/delete
Deletes the site identified by its business code.
Request
DELETE /manufacturing/food-beverage/v1/sites/delete?id=PLT001
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string | yes | Business code of the site to delete. |