API Referenceuoms

List UOMs (POST)

Beta
Gets the Unit of Measurements based on the given filters.

Headers

AuthorizationstringRequired
Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
aggregation_typeslist of enumsOptional
List of aggregation types for filtering list of UOMs.
cursorstringOptionalformat: "text"
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
idslist of stringsOptional
List of Unit of Measurement (UOM) DONs to be used in filtering complete list of UOMs defined in a Dev Org.
limitintegerOptional
The maximum number of UOMs to be returned in a response. The default is '50'.
metric_nameslist of stringsOptional
List of metric names for filtering list of UOMs.
modeenumOptional

The iteration mode to use. If “after”, then entries after the provided cursor will be returned, or if no cursor is provided, then from the beginning. If “before”, then entries before the provided cursor will be returned, or if no cursor is provided, then from the end. Entries will always be returned in the specified sort-by order.

Allowed values:
part_idslist of stringsOptional
List of part IDs for filtering list of UOMs.
product_idslist of stringsOptional
List of product IDs for filtering list of UOMs.
sort_bylist of stringsOptional
Fields to sort the Unit Of Measuments (UOMs) by and the direction to sort them.
unit_typeslist of enumsOptional
List of unit types for filtering list of UOMs.
Allowed values:

Response

Success.
uomslist of objects

The list of Unit of Measurement (UOM) objects.

next_cursorstring or nullformat: "text"
The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.
prev_cursorstring or nullformat: "text"
The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

Errors