QC units of measure

The units quality checkpoint results are recorded in.

catalog:readhttps://public-api.nutrasoft.ca/v1

Linked fromQC checkpointsqc_unit_of_measure_id

The QC unit of measure object

idinteger
codestring
is_globalboolean
True for a shared unit, false for one your account created.
namestringnullable

Operations

List QC units of measure

get/qc-units-of-measurecatalog:read

Units quality checkpoint results are recorded in, separate from the inventory units of measure.

Query parameters

searchstringnullable
Free-text match on name or code.
sortstringnullable
Comma-separated field:direction pairs, e.g. id:desc. Sortable: code, id, name. id is always added last, so paging is stable.
limitinteger
Rows to return. Maximum 200.
- >= 1
- <= 200
- default 50
offsetinteger
Rows to skip. Maximum 10000: to read further, narrow the filters or page with updated_since.
- >= 0
- <= 10000
- default 0

Returns

200 A page of QCUnitOfMeasure objects in data, with pagination.

Errors

400 401 403 429 500 503

GET /qc-units-of-measure

curl "https://public-api.nutrasoft.ca/v1/qc-units-of-measure?limit=50" \
  -H "Authorization: Bearer $NUTRASOFT_API_KEY"

Response200

{
  "data": [
    {
      "id": 123,
      "code": "SAMPLE-01",
      "is_global": false,
      "name": "Sample name"
    }
  ],
  "pagination": {
    "limit": 50,
    "offset": 0,
    "total": 1,
    "has_more": false
  },
  "order": "id:asc"
}

Retrieve a QC unit of measure

get/qc-units-of-measure/{qc_uom_id}catalog:read

Path parameters

qc_uom_idintegerrequired
The QC unit's id.
- > 0

Returns

200 One QCUnitOfMeasure object in data.

Errors

400 401 403 404 429 500 503

GET /qc-units-of-measure/{qc_uom_id}

curl "https://public-api.nutrasoft.ca/v1/qc-units-of-measure/123" \
  -H "Authorization: Bearer $NUTRASOFT_API_KEY"

Response200

{
  "data": {
    "id": 123,
    "code": "SAMPLE-01",
    "is_global": false,
    "name": "Sample name"
  }
}