Update/create several measurement families

PATCH

/api/rest/v1/measurement-families

Measurement family

This endpoint allows you to update and/or create several measurement families at once.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/api/rest/v1/measurement-families' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "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²"
            }
        }
    }
]'

Response Example

200 - Example 1

[
  {
    "code": "string",
    "errors": [
      {
        "message": "string",
        "property": "string"
      }
    ],
    "message": "string",
    "status_code": 0
  }
]

Request

Body Params application/json

array of:

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

Examples

Responses

🟢200OK

application/json

Body

array of:

code

string

optional

Resource code

errors

array [object {2}]

optional

List of errors

message

string

optional

property

string

optional

message

string

optional

Message explaining the error

status_code

integer

optional

HTTP status code, see Client errors to understand the meaning of each code

🟠401Authentication required

🟠413Request Entity Too Large

🟠415Unsupported Media type

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

Get list of measurement families

Get a list of product media files