Types of measurements where you input a standardised value to apply to your space. You can have multiple options of the same type for different situations.
What can you do?
Available Resources
- Retrieve a list of created unit of measures;
- Retrieve information of a specific unit of measure;
- Retrieve a list of unit of measure types;
- Update unit of measure information;
- Create a unit of measure;
- Delete a unite of measure.
Domain Object
UnitOfMeasure
Parameter | Type | Description | Request | Response | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | PUT | POST | DELETE | GET | PUT | POST | DELETE | |||||
name | String | The name of a unit of measure | Yes | Yes | Yes | Yes | Yes | |||||
key | String | The reference to the unit of measure in your system | Yes | Yes | Yes | Yes | Yes | |||||
description | String | The description of a unit of measure | Optional | Optional | Yes | Yes | Yes | |||||
isoCode | String | An alphabetical or numerical code to identify a unit of measure | Optional | Optional | Yes | Yes | Yes | |||||
symbol | String | The symbol of a unit of measure | Optional | Optional | Yes | Yes | Yes | |||||
multiplier | Double | Is used to multiply the value from the standardised one that is being used | Yes | Yes | Yes | Yes | Yes | |||||
unitOfMeasureType | Enum
| The type of a unit of measure | Yes | Yes | Yes | Yes | Yes | |||||
metadata | Array [Object] | A list of Metadata | Yes | Yes | Yes | Yes | Yes | |||||
accountId | String | Unique identifier of your account | Yes | Yes | Yes | |||||||
created | DateTime | ISO8601 timestamp for when a Unit Of Measure was created. All records are stored in UTC time zone. | Yes | Yes | Yes | |||||||
id | String | Unique system identifier of a Unit Of Measure | Yes | Yes | Yes | |||||||