Units

Create a new quantity value unit

Changed on

Create a new quantity value unit. The unit ID must be unique and not exceed 50 characters.

post/pimcore-studio/api/unit/quantity-value/units

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /pimcore-studio/api/unit/quantity-value/units
  • Auth: none declared

Request body

idstring required

Unique unit ID

abbreviationstring nullable

Abbreviation

longnamestring nullable

Long name

groupstring nullable

Group

baseunitstring nullable

Base unit ID

factornumber nullable

Conversion factor

conversionOffsetnumber nullable

Conversion offset

converterstring nullable

Converter service class

referencestring nullable

Reference

Example request

{
  "id": "mm",
  "abbreviation": "mm",
  "longname": "Millimeter",
  "group": "Length",
  "baseunit": "m",
  "factor": 0.001
}

Response

Created quantity value unit

additionalAttributesobject

AdditionalAttributes

idstring nullable required

ID

abbreviationstring nullable required

Abbreviation

groupstring nullable required

Group

longNamestring nullable required

Long Name

baseUnitstring nullable required

Base Unit

referencestring nullable required

Reference

factornumber float nullable required

Factor

conversionOffsetnumber float nullable required

Conversion Offset

converterstring nullable required

Converter

Example response

{
  "id": "mm",
  "abbreviation": "mm",
  "longName": "Millimeter",
  "baseUnit": "m"
}

Changes