API - Lot Groups | Wisefish API

Overview

The list page that contains the lot groups.

Endpoint name	`lotGroups`
Source table	`WiFi Lot Group`
Fixed view	No filter
Requests allowed	GET, POST, PATCH, DELETE
Primary key	`Code`
Record ID	`code`
Procedures	None

Data

Field List

	Property	Type	format	Description
1	`systemId`	string	uuid	SystemId	non-editable
2	`code`	string	max 10	Code	Record ID primary key
3	`description`	string	max 50	Description	optional
4	`defaultLotHoldStatus`	string	enum	Options: blank, Hold, "QA Hold", "QA Lock", "Customs Hold"	optional
5	`productConsumptionAllowed`	boolean		Product Consumption Allowed	optional
6	`productProductionAllowed`	boolean		Product Production Allowed	optional
7	`rawMatConsumptionAllowed`	boolean		Raw Material Consumption Allowed	optional
8	`wipConsumptionAllowed`	boolean		WIP Consumption Allowed	optional
9	`wipProductionAllowed`	boolean		WIP Production Allowed	optional
10	`systemRowVersion`	integer		System row version. Increments every time the record is modified.	non-editable
11	`lastModified`	string	date-time	SystemModifiedAt	non-editable

Object Example

JSON

{
    "systemId": "b5e1c045-612a-f011-b020-f11f8541a8f7",
    "code": "WEEK-1",
    "description": "Week 1, 2025",
    "defaultLotHoldStatus": " ",
    "productConsumptionAllowed": false,
    "productProductionAllowed": false,
    "rawMatConsumptionAllowed": true,
    "wipConsumptionAllowed": true,
    "wipProductionAllowed": false,
    "systemRowVersion": 2581734,
    "lastModified": "2025-05-06T10:03:06.387Z"
}

Examples

Read lot groups

Read all lot groups

Reads all lot groups. The response is a list of lot group objects, as shown in Object Example.

JSON

GET .../lotGroups

Read one lot group

The Record ID is the lot group code, so one lot group is read with a GET request on the following format:

JSON

GET .../lotGroups('WEEK-1')

Read lot groups that allow raw material consumption

Filters on a boolean property and returns only the code and description of each lot group with $select.

JSON

GET .../lotGroups?$filter=rawMatConsumptionAllowed eq true&$select=code,description

Create, change and delete lot groups

Create a new Lot Group

Creates the lot group WEEK-2, where new lots get the hold status QA Hold by default.

Request:

JSON

POST .../lotGroups

Body:
{
    "code": "WEEK-2",
    "description": "Week 2, 2025",
    "defaultLotHoldStatus": "QA Hold",
    "rawMatConsumptionAllowed": true,
    "wipConsumptionAllowed": true
}

Response:

JSON

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#companies(cf9f7b85-dd11-ef11-9f8b-6045bde9cc61)/lotGroups/$entity",
    "@odata.etag": "W/\"JzE5OzM3NTQ5MjgxMDQ2NzMxOTg1NTIxOzAwOyc=\"",
    "systemId": "7c2d41a9-1f6e-f011-b02a-8bca792786d1",
    "code": "WEEK-2",
    "description": "Week 2, 2025",
    "defaultLotHoldStatus": "QA Hold",
    "productConsumptionAllowed": false,
    "productProductionAllowed": false,
    "rawMatConsumptionAllowed": true,
    "wipConsumptionAllowed": true,
    "wipProductionAllowed": false,
    "systemRowVersion": 2581790,
    "lastModified": "2025-05-13T09:12:44.120Z"
}

Change a lot group

Clears the default hold status of lot group WEEK-2 and allows WIP production. A PATCH request needs the If-Match header with the @odata.etag of the record (or *).

Request:

JSON

PATCH .../lotGroups('WEEK-2')
If-Match: *

Body:
{
    "defaultLotHoldStatus": " ",
    "wipProductionAllowed": true
}

Response:

JSON

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#companies(cf9f7b85-dd11-ef11-9f8b-6045bde9cc61)/lotGroups/$entity",
    "@odata.etag": "W/\"JzE5OzE4MzM2NTkwMjc0NDgxOTI2NjQxOzAwOyc=\"",
    "systemId": "7c2d41a9-1f6e-f011-b02a-8bca792786d1",
    "code": "WEEK-2",
    "description": "Week 2, 2025",
    "defaultLotHoldStatus": " ",
    "productConsumptionAllowed": false,
    "productProductionAllowed": false,
    "rawMatConsumptionAllowed": true,
    "wipConsumptionAllowed": true,
    "wipProductionAllowed": true,
    "systemRowVersion": 2581811,
    "lastModified": "2025-05-13T10:27:05.533Z"
}

Delete a lot group

Deletes lot group WEEK-2. On success the response is empty (HTTP status 204 No Content).

JSON

DELETE .../lotGroups('WEEK-2')