Production line – Pulse

Represents a production line within a site.

For example, a yogurt filling line, bottling line, or packaging line can be registered as a Production line.

A production line belongs to exactly one site.

The Production line object

{
  "code": "LINE001",
  "name": "Yogurt filling line 1",
  "parent": "PLT001"
}

Fields

Field	Type	Description	Example
`code`	string	Unique business code used to identify the production line in external systems and integrations.	`"LINE001"`
`name`	string	Human-readable name of the production line.	`"Yogurt filling line 1"`
`parent`	string	Business code of the site the production line belongs to.	`"PLT001"`

Important

code must be unique. Two production lines cannot use the same code.

The site referenced by parent must already exist before the production line is submitted.

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

API resource

Resource	Base path
`Production line`	`/manufacturing/food-beverage/v1/lines`

API methods

Create a production line

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

Creates a new production line.

Request

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

{
  "code": "LINE001",
  "name": "Yogurt filling line 1",
  "parent": "PLT001"
}

Parameters

Parameter	Type	Required	Description
`code`	string	yes	Unique business code of the production line.
`name`	string	yes	Human-readable name of the production line.
`parent`	string	yes	Business code of the site the production line belongs to.

Update a production line

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

Updates an existing production line.

Request

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

{
  "code": "LINE001",
  "name": "Yogurt filling line 1",
  "parent": "PLT002"
}

Changing parent moves the production line to another site.

Parameters

Parameter	Type	Required	Description
`code`	string	yes	Unique business code of the production line to update.
`name`	string	yes	Human-readable name of the production line.
`parent`	string	yes	Business code of the site the production line belongs to.

Patch a production line

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

Partially updates an existing production line.

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

Request

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

{
  "properties": {
    "code": "LINE001",
    "name": "Yogurt filling line 1A",
    "parent": "PLT002"
  }
}

Parameters

Parameter	Type	Required	Description
`properties`	object	yes	Fields included in the partial update.
`properties.code`	string	yes	Unique business code of the production line to update.
`properties.name`	string	no	New human-readable name of the production line.
`properties.parent`	string	no	Business code of the site the production line should belong to.

Retrieve a production line

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

Returns the production line identified by its business code.

Request

GET /manufacturing/food-beverage/v1/lines/select?id=LINE001

Parameters

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

Example response

{
  "code": "LINE001",
  "name": "Yogurt filling line 1",
  "parent": "PLT001"
}

List production lines

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

Returns production lines matching the supplied filters.

Production lines can be filtered by code, name, and parent site.

Request

GET /manufacturing/food-beverage/v1/lines/query?parents=PLT001

Query parameters

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

Example response

[
  {
    "code": "LINE001",
    "name": "Yogurt filling line 1",
    "parent": "PLT001"
  },
  {
    "code": "LINE002",
    "name": "Yogurt filling line 2",
    "parent": "PLT001"
  }
]

Delete a production line

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

Deletes the production line identified by its business code.

Request

DELETE /manufacturing/food-beverage/v1/lines/delete?id=LINE001

Parameters

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