v1

latestSwagger 2.02026-07-13137761.0 MB

Measurement family

Get list of measurement families

This endpoint allows you to get a list of measurement families.

get/api/rest/v1/measurement-families

Response

Return the measurement families

codestring required

Measurement family code

standard_unit_codestring required

Unit code used as the standard unit for this measurement family

Example response

{
  "code": "AREA",
  "labels": {
    "en_US": "Area",
    "fr_FR": "Surface"
  },
  "standard_unit_code": "SQUARE_METER",
  "units": {
    "SQUARE_MILLIMETER": {
      "code": "SQUARE_MILLIMETER",
      "labels": {
        "en_US": "Square millimeter",
        "fr_FR": "Millimètre carré"
      },
      "convert_from_standard": [
        {
          "operator": "mul",
          "value": "0.000001"
        }
      ],
      "symbol": "mm²"
    },
    "SQUARE_CENTIMETER": {
      "code": "SQUARE_CENTIMETER",
      "labels": {
        "en_US": "Square centimeter",
        "fr_FR": "Centimètre carré"
      },
      "convert_from_standard": [
        {
          "operator": "mul",
          "value": "0.0001"
        }
      ],
      "symbol": "cm²"
    },
    "SQUARE_METER": {
      "code": "SQUARE_METER",
      "labels": {
        "en_US": "Square meter",
        "fr_FR": "Mètre carré"
      },
      "convert_from_standard": [
        {
          "operator": "mul",
          "value": "1"
        }
      ],
      "symbol": "m²"
    }
  }
}