Get Units

This endpoint makes an HTTP GET request to retrieve the unit of measurement (UOM) data. The response of this request is documented as a JSON schema.

Return data description

Property	Description
unitCode	The identifier of this unit of measure. It is some random text for custom units (e.g. j5VEKvW-TD8femkRe02KV) and it is something semantic for provided units (e.g. fluid_ounce)
name	The full name of a unit to make it clear what it is.
abbreviation	The abbreviated name of a unit that is used for compact formatting such as fl oz. Can override the default abbreviation of a provided unit. E.g. if the default abbreviation of fluid ounce is fl oz, you can make it oz.
defaultAbbreviation	This is always the same as abbreviation for custom units. For provided units, this never changes. If you choose to alias the abbreviation, this will show the original, and the abbreivation property will be your alias.
category	Also known as the "physical quantity" of a unit, which tells you what exactly this is measuring. The possibilities are volume, weight, length, count. All custom units will have the category of count, as there is no way to setup custom conversion rates.
isCustom	Boolean which tells you if this is a custom unit or provided unit.

get/v2/uom

Request

Base URL
{{server}}:{{port}}
Auth
HTTP basic
TypeScript
https://skmtc.dev/limblecmms/apis/limble-api-v2/docs/v2/uom/get.ts
A function with typed inputs. Its response is checked against the schema.

unitCodesstring

This parameter is used to only get specific units. This parameter accepts a comma delimited list of unit codes.

limitinteger

This parameter is a result limiter. The default is 20 units. Supports up to 1000 results.

pageinteger

This parameter is used to paginate results based on the limit. Refer to Pagination section for more information.

nameStartsWithstring

Filter by units that have a name which starts with this string.

abbreviationStartsWithstring

Filter by units that have an abbreviation which starts with this string.

Get Units of Measure

unitCodestring

defaultAbbreviationstring

abbreviationstring

namestring

isCustomboolean

categorystring