GET /api/v202305/unit

Retrieves all units with optional unit system filtering

GetUnitsV202305
Returns the complete list of units (commodity and weather) available in the system. Use the filter parameter to restrict results by unit system (metric, imperial, etc.).

Request Headers

Header Value Required Description
ECI-ApiKey string Yes Your API key. See Authentication.
Content-Type application/json Yes All requests must specify JSON content type.

Query Parameters

Name Description Type Required
filter Optional unit system filter string (string) Optional

Filters

Filter Description Type Operators
unitTypeCode Unit Type Code String equals not equals one of like not like not one of
unitTypeId Integer equals not equals less than between one of greater than less than equal greater than equal not one of
unitTypeInfo Unit Type Name String equals not equals one of like not like not one of

Responses

200 OK The request succeeded and the response body contains the requested data.

Response Body Parameters

Array of:

Unit
Property Description Type
unitCode Must be between 0 and 16 characters string
unitDisplayName Must be between 0 and 64 characters string
unitId integer (int32)
unitInfo Must be between 0 and 32 characters string
unitType UnitType
UnitType properties
Property Description Type
unitTypeCode string
unitTypeId integer (int32)
unitTypeInfo string
Example Response application/json 
[
  {    "unitCode": "string",    "unitDisplayName": "string",    "unitId": 1,    "unitInfo": "string",    "unitType": {      "unitTypeCode": "string",      "unitTypeId": 1,      "unitTypeInfo": "string"
    }
  }
]