Get list of measurement families

GET

/api/rest/v1/measurement-families

Measurement family

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

Response Example

200 - Example 1

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

Request

None

Responses

🟢200Return the measurement families

application/json

Body

code

string

required

Measurement family code

labels

object

optional

Measurement family labels for each locale

Default:

{}

localeCode

string

optional

Measurement family label for the locale localeCode

standard_unit_code

string

required

Unit code used as the standard unit for this measurement family

units

object

required

Measurement units for this family with their conversion operations. More details here.

unitCode

object

optional

🟠401Authentication required

🟠406Not Acceptable

Modified at 2023-08-15 05:53:55

Get a measure family

Update/create several measurement families