iotoms Docs

Get a unit of measure

GET
/api/v1/catalog/uom/{id}

Returns one unit of measure by id, including its category, allowed decimal places, status and whether any item uses it.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

id*string

ID of the record (UUID).

Formatuuid

Header Parameters

X-TenantID*string

Your merchant's tenant code — the value typed in the Domain field on the iotoms login screen. See Concepts.

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when the request worked, ERROR when it did not.

message*string

Short human-readable message describing the result, for logs or display; do not parse it.

data?

The unit of measure as it is now stored.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/catalog/uom/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "code": "string",    "name": "string",    "category": "COUNT",    "decimalPrecision": 0,    "status": "ACTIVE",    "inUse": true  }}