product-usage

Uoms List Post

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

Request

This endpoint expects an object.
aggregation_types
list of enumsOptional
List of aggregation types for filtering list of UOMs.
cursor
stringOptional
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
ids
list of stringsOptional
List of Unit of Measurement (UOM) DONs to be used in filtering complete list of UOMs defined in a Dev Org.
limit
integerOptional
The maximum number of UOMs to be returned in a response. The default is '50'.
metric_names
list of stringsOptional
List of metric names for filtering list of UOMs.
mode
enumOptional
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: afterbefore
part_ids
list of stringsOptional
List of part IDs for filtering list of UOMs.
product_ids
list of stringsOptional
List of product IDs for filtering list of UOMs.
sort_by
list of stringsOptional
Fields to sort the Unit Of Measuments (UOMs) by and the direction to sort them.
unit_types
list of enumsOptional
List of unit types for filtering list of UOMs.
Allowed values: booleannumber

Response

This endpoint returns an object
uoms
list of objects
The list of Unit of Measurement (UOM) objects.
next_cursor
stringOptional
The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.
prev_cursor
stringOptional
The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.
POST
1curl -X POST https://api.devrev.ai/uoms.list \
2 -H "Authorization: <apiKey>" \
3 -H "Content-Type: application/json" \
4 -d '{}'
200Successful
1{
2 "uoms": [],
3 "next_cursor": "next_cursor",
4 "prev_cursor": "prev_cursor"
5}