Batches

A Batch (also called a Lot) is a group of work order lines that are associated with each other, either for easy picking or for historical records.

Attributes

  • id string

  • name string

  • type integer

  • priority integer

Endpoints

List Batches

get /api/batches

Get the batches from the PPG database and return a JSON response.

Arguments

  • name string

  • limit integer

  • offset integer

  • countOnly boolean

    Will return items, but only those after the integer amount.

  • id uuid

    Unique identifier for the batch.

Request with curl
curl "http://[Your IP]/api/batches" \ -X get \-H "Content-Type: application/json" \-H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{ "batches": [{ "id": "string", "name": "string", "type": "integer", "priority": "integer", }] }] }

Show Batch

get /api/batches/[id]

Get a single batch from the PPG database and return a JSON response.

Request with curl
curl "http://[Your IP]/api/batches/[id]" \ -X get \-H "Content-Type: application/json" \-H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{ "batches": [{ "id": "string", "name": "string", "type": "integer", "priority": "integer", }] }] }

Create Batch

put /api/batches

Create a batch and get a response.

Body Parameters

  • name string REQUIRED

    The name of the material.

  • id UUID REQUIRED

  • type integer

Request with curl
curl "http://[Your IP]/api/batches" \ -X put \ -H "Content-Type: application/json" \-H "Authorization: Bearer [Your JWT Access Token]" \ -d '{ "name": "string", "id": "UUID", }'
Example Response
{ "batch": { "id": "string", "name": "string", "type": "integer", "priority": "integer", } }