Skip to main content

Units of Measure API

Welcome to the Units of Measure API documentation. This API provides a set of functions for managing units of measure and conversions between them. Below is a list of available functions, each with a brief description and a link to its detailed documentation.

Function List​

newUnitOfMeasure​

Generates an empty non-persisted Units Of Measure object to provide the structure required by the API to save a new record into the database. This method must be combined with the saveUnitOfMeasure method in order to persist the record. Returns a JSON representation of the newly created unit of measure object.

saveUnitOfMeasure​

Creates or updates a Units Of Measure record in the system based on the provided parameters. Returns a JSON representation of the saved unit of measure.

doesUnitOfMeasureExist​

Checks if a Units Of Measure object with the given ID or name exists. Returns a boolean indicating whether the unit of measure exists.

findUnitsOfMeasure​

Retrieves Units Of Measure records based on the specified pagination, sort, and column constraint parameters. Returns a Query Result object.

getUnitOfMeasureOrCreateNew​

Retrieves a Units Of Measure record if an existing unit of measure exists with the specified name and symbol. Otherwise, creates a new Units Of Measure record with the specified name and symbol. Returns a JSON representation of the unit of measure property.

getUnitOfMeasure​

Retrieves a Units Of Measure record by its ID or name. Returns a JSON representation of the unit of measure. Returns nothing if no unit of measure is found.

getAllUnitsOfMeasure​

Retrieves a list of all Units Of Measure records in the system. Returns a list of JSON objects representing all units of measure.

getUnitOfMeasureReferences​

Retrieves a list of references to a Units Of Measure record by its ID. Returns a list of JSON objects.

validateUnitOfMeasure​

Validates the specified parameters for a Units Of Measure record and returns any validation errors. This only checks if the unit of measure object can be saved based on the attributes given. Returns a JSON object where keys are field names and values are lists of validation violation messages.

deleteUnitOfMeasure​

Deletes a Units Of Measure record by its ID. This cannot delete a unit of measure with references to it. If successful, an ApiResponse Object is returned with the success bool set True.

newUnitOfMeasureConversion​

Generates an empty non-persisted Unit Of Measure Conversions object to provide the structure required by the API to save a new record into the database. This method must be combined with the saveUnitOfMeasureConversion method in order to persist the record. Returns a JSON representation of the newly created unit of measure conversion object.

saveUnitOfMeasureConversion​

Creates or updates a Unit Of Measure Conversions record in the system based on the provided parameters. Returns a JSON representation of the saved unit of measure conversion.

doesConversionExist​

Checks if a Unit Of Measure Conversions object with the given parameters exists. Returns a boolean indicating whether the unit of measure conversion exists.

findUnitOfMeasureConversions​

Retrieves Unit Of Measure Conversions records based on the specified pagination, sort, and column constraint parameters. Returns a Query Result object.

getUnitOfMeasureConversion​

Retrieves a Unit Of Measure Conversions record by its ID. Returns a JSON representation of the unit of measure conversion assigned to value. Returns value is null if no unit of measure conversion is found.

getAllConversions​

Retrieves a list of all Unit Of Measure Conversions records in the system. Returns a list of JSON objects representing all unit of measure conversions.

getAllConversionsForMaterial​

Retrieves a list of all Unit Of Measure Conversions records in the system for a material. Returns a list of JSON objects representing all unit of measure conversions for a material.

getUnitOfMeasureConversionReferences​

Retrieves a list of references to a Unit Of Measure Conversions record by its ID. Returns a list of JSON objects.

validateUnitOfMeasureConversion​

Validates the specified parameters for a Unit Of Measure Conversions record and returns any validation errors. This only checks if the unit of measure conversion object can be saved based on the attributes given. Returns a JSON object where keys are field names and values are lists of validation violation messages.

deleteUnitOfMeasureConversion​

Deletes a Unit Of Measure Conversions record by its ID. This cannot delete a unit of measure conversion with references to it. If successful, an ApiResponse Object is returned with the success bool set True.

addConversion​

Adds a Unit Of Measure Conversions record from one unit of measure to another for the specified material with the specified conversion factor. Returns a JSON representation of the added unit of measure conversion object.

getConversionFor​

Retrieves a Unit Of Measure Conversions record by the given to and from unit of measure and material ID. Returns a JSON representation of the unit of measure conversion. Returns nothing if no unit of measure conversion is found.

getConversion​

Retrieves a Unit Of Measure Conversions record by its ID. Returns a JSON representation of the unit of measure conversion. Returns nothing if no unit of measure conversion is found.

convert​

Converts the specified amount from one unit of measure to the other. Returns the amount converted.

Explore each function’s documentation for detailed usage examples and additional information.