Unit of measure API documentation version v1
https://APPLICATION_URL/rest/api/v1/uom/data
/dimensions
post
Creation of dimension
post /dimensions
Creation of dimension
Secured by basic
Headers
- x-csrf-token: required (string)
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"dimId": {
"type": "string",
"maxLength": 30,
"description": "Dimension Key"
},
"leng": {
"type": "number",
"description": "Length exponent"
},
"mass": {
"type": "number",
"description": "Mass exponent"
},
"timex": {
"type": "number",
"description": "Current exponent"
},
"ecurr": {
"type": "number",
"description": "Electric current exponent"
},
"temp": {
"type": "number",
"description": "Temperature exponent"
},
"molqu": {
"type": "number",
"description": "Mole quantity exponent"
},
"light": {
"type": "number",
"description": "Luminosity exponent"
},
"mssie": {
"type": "string",
"maxLength": 3,
"description": "SI Unit"
},
"temp_dep": {
"type": "string",
"maxLength": 1,
"description": "Indicator: Dimension has Unit with Temperature Specification"
},
"press_dep": {
"type": "string",
"maxLength": 1,
"description": "Indicator: Dimension has Units with Pressure Specification"
},
"dimensionLanguageList": {
"type": "array",
"properties": {
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": ["EN", "DE", "ZF", "CS", "FR",
"IT", "JA", "RU", "ES"
],
"maxLength": 5,
"description": "Language Key"
},
"txDim": {
"type": "string",
"maxLength": 200,
"description": "Dimension Text"
}
}
}
},
"unitPayload": {
"type": "array",
"properties": {
"unit": {
"type": "object",
"properties": {
"msehi": {
"type": "string",
"maxLength": 15,
"description": "Unit of Measurement"
},
"kzex3": {
"type": "string",
"maxLength": 1,
"description": "3-char indicator for external unit of measurement "
},
"kzex6": {
"type": "string",
"maxLength": 1,
"description": "6-char ID for external unit of measurement "
},
"andec": {
"type": "number",
"description": "No. of decimal places to which rounding should be performed"
},
"kzkeh": {
"type": "string",
"maxLength": 1,
"description": "Commercial Measurement unit ID"
},
"kzwob": {
"type": "string",
"maxLength": 1,
"description": "Value-based commitment indicator"
},
"kz1eh": {
"type": "string",
"maxLength": 1,
"description": "Indicator (1) unit (indicator not yet defined)"
},
"kz2eh": {
"type": "string",
"maxLength": 1,
"description": "Indicator (2) unit (indicator not yet defined)"
},
"zaehl": {
"type": "number",
"description": "Numerator for conversion to SI unit"
},
"nennr": {
"type": "number",
"description": "Denominator for conversion to SI unit"
},
"exp10": {
"type": "number",
"description": "base ten exponent for conversion to SI unit"
},
"addko": {
"type": "Decimal",
"length": "(9,6)",
"description": "Additive constant for conversion to SI unit"
},
"expon": {
"type": "number",
"description": "Base ten exponent for floating-point display"
},
"decan": {
"type": "number",
"description": "Number of decimal places for number display"
},
"isoCode": {
"type": "string",
"maxLength": 3,
"description": "ISO Code for unit of measure"
},
"primary": {
"type": "string",
"maxLength": 1,
"description": "Selection field for conversion from ISO code to int. code "
},
"temp_value": {
"type": "Double",
"description": "Temperature"
},
"temp_unit": {
"type": "string",
"maxLength": 3,
"description": "Temperature Unit "
},
"famunit": {
"type": "string",
"maxLength": 1,
"description": "Unit of measurement family"
},
"press_val": {
"type": "Double",
"description": "Pressure value"
},
"press_unit": {
"type": "string",
"maxLength": 3,
"description": "Unit of pressure"
}
}
},
"unitLanguage": {
"type": "array",
"properties": {
"language": {
"type": "string",
"enum": ["EN", "DE", "ZF", "CS", "FR",
"IT", "JA", "RU", "ES"
],
"maxLength": 5,
"description": "Language Key"
},
"msehi": {
"type": "string",
"maxLength": 15,
"description": "Unit of Measurement"
},
"mseh3": {
"type": "string",
"maxLength": 3,
"description": "External Unit of Measurement in Commercial Format(3 Char)"
},
"mseh6": {
"type": "string",
"maxLength": 30,
"description": "External Unit of Measurement in Technical Format(6 Char)"
},
"mseht": {
"type": "string",
"maxLength": 30,
"description": "Unit of Measurement text (Maximum 30 characters)"
},
"msehl": {
"type": "string",
"maxLength": 200,
"description": "Unit of Measurement text (Maximum 500 characters)"
}
}
}
}
}
}
}
Example:
{
"dimension": {
"dimId": "MASS",
"leng": 0,
"mass": 1,
"timex": 0,
"ecurr": 0,
"temp": 0,
"molqu": 0,
"light": 0,
"mssie": "KG",
"temp_dep": null,
"press_dep": null
},
"dimensionLanguageList": [
{
"language": "EN",
"txDim": "Mass"
}
],
"unitPayload": [
{
"unit": {
"msehi": "MG",
"kzex3": "X",
"kzex6": "X",
"andec": 3,
"kzkeh": "X",
"kzwob": " ",
"kz1eh": " ",
"kz2eh": " ",
"zaehl": 1,
"nennr": 1000000,
"exp10": 0,
"addko": 0,
"expon": 0,
"decan": 0,
"isoCode": "MGM",
"primary": "X",
"temp_value": 0,
"temp_unit": " ",
"famunit": " ",
"press_val": 0,
"press_unit": " "
},
"unitLanguage": [
{
"language": "EN",
"msehi": "MG",
"mseh3": "MG",
"mseh6": "mg",
"mseht": "mg",
"msehl": "Milligram"
}
]
}
]
}HTTP status code 201
Sucessfully creates dimesnion.
HTTP status code 400
The request could not be understood by the server due to malformed syntax.
Body
Media type: application/json
Type: object
Example:
{
"statusCode": 400,
"errorMessages": [
{
"severity": "ERROR",
"errorMessage": "Dimension already exists.",
"repeatedEntities": [],
"EntitiesNotFound": []
}
]
}Secured by basic
put
Update fields of a dimension.
get
To view a dimension.
delete
Delete a dimension.
put /dimensions/{dimensionID}
Update fields of a dimension.
Secured by basic
URI Parameters
- dimensionID: required (string)
Headers
- x-csrf:token: required (string)
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"dimId": {
"type": "string",
"maxLength": 30,
"description": "Dimension Key"
},
"leng": {
"type": "number",
"description": "Length exponent"
},
"mass": {
"type": "number",
"description": "Mass exponent"
},
"timex": {
"type": "number",
"description": "Current exponent"
},
"ecurr": {
"type": "number",
"description": "Electric current exponent"
},
"temp": {
"type": "number",
"description": "Temperature exponent"
},
"molqu": {
"type": "number",
"description": "Mole quantity exponent"
},
"light": {
"type": "number",
"description": "Luminosity exponent"
},
"mssie": {
"type": "string",
"maxLength": 3,
"description": "SI Unit"
},
"temp_dep": {
"type": "string",
"maxLength": 1,
"description": "Indicator: Dimension has Unit with Temperature Specification"
},
"press_dep": {
"type": "string",
"maxLength": 1,
"description": "Indicator: Dimension has Units with Pressure Specification"
}
}
}
Example:
{
"leng": "2",
"mass": "1",
"timex": "-3",
"ecurr": "0",
"temp": "0",
"molqu": "0",
"light": "0",
"mssie": "W",
"press_dep": null,
"temp_dep": null
}HTTP status code 200
Successfully updates the dimension.
HTTP status code 400
The request could not be understood by the server due to malformed syntax.
Body
Media type: application/json
Type: object
Example:
{
"statusCode": 400,
"errorMessages": [
{
"severity": "ERROR",
"errorMessage": "Property mssie cannot have more than 3 characters.",
"repeatedEntities": [],
"EntitiesNotFound": []
}
]
}Secured by basic
get /dimensions/{dimensionID}
To view a dimension.
Secured by basic
URI Parameters
- dimensionID: required (string)
HTTP status code 200
Successfully retrives the dimension details.
Body
Media type: application/json
Type: object
Example:
{
"dimensionId": "HYDROL",
"leng": 3,
"mass": 0,
"timex": -1,
"ecurr": 0,
"temp": 0,
"molqu": -1,
"light": 0,
"mssie": "LMS",
"temp_dep": "",
"press_dep": ""
}HTTP status code 204
No data found.
Secured by basic
delete /dimensions/{dimensionID}
Delete a dimension.
Secured by basic
URI Parameters
- dimensionID: required (string)
Headers
- x-csrf-token: required (string)
HTTP status code 200
Successfully deletes the dimension.
HTTP status code 400
The request could not be understood by the server due to malformed syntax.
Body
Media type: application/json
Type: object
Example:
{
"statusCode": 400,
"errorMessages": [
{
"severity": "ERROR",
"errorMessage": "Enter a valid dimension.",
"repeatedEntities": [],
"EntitiesNotFound": []
}
]
}Secured by basic
get
Retrieve all language descriptions for a dimension.
post
Create language description for dimension.
get /dimensions/{dimensionID}/languages
Retrieve all language descriptions for a dimension.
Secured by basic
URI Parameters
- dimensionID: required (string)
HTTP status code 200
Successfully retrieves language descriptions of dimension.
Body
Media type: application/json
Type: object
Example:
[
{
"Description": "水解速率",
"Language": "1",
"Dimension": "HYDROL"
},
{
"Description": "อัตราการไฮโดรไลซิส",
"Language": "2",
"Dimension": "HYDROL"
},
{
"Description": "가수분해율",
"Language": "3",
"Dimension": "HYDROL"
},
{
"Description": "Rată hidroliză",
"Language": "4",
"Dimension": "HYDROL"
}
]HTTP status code 204
No data found.
Secured by basic
post /dimensions/{dimensionID}/languages
Create language description for dimension.
Secured by basic
URI Parameters
- dimensionID: required (string)
Headers
- x-csrf-token: required (string)
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"language": {
"type": "string",
"enum": [
"EN",
"DE",
"ZF",
"CS",
"FR",
"IT",
"JA",
"RU",
"ES"
],
"maxLength": 5,
"description": "Language Key"
},
"txDim": {
"type": "string",
"maxLength": 200,
"description": "Dimension Text"
}
}
}
Example:
{
"language": "EN",
"txDim": "Hydrolysis rate"
}
HTTP status code 201
Successfully creates language description for dimension.
HTTP status code 400
The request could not be understood by the server due to malformed syntax.
Body
Media type: application/json
Type: object
Example:
{
"statusCode": 400,
"errorMessages": [
{
"severity": "ERROR",
"errorMessage": "Enter a valid dimension.",
"repeatedEntities": [],
"EntitiesNotFound": []
}
]
}Secured by basic
get
Retrieve the description for a particular language for a dimension.
delete
Delete the language description of a dimension.
get /dimensions/{dimensionID}/languages/{languageID}
Retrieve the description for a particular language for a dimension.
Secured by basic
URI Parameters
- dimensionID: required (string)
- languageID: required (string)
HTTP status code 200
Successfully retrieves language description.
Body
Media type: application/json
Type: object
Example:
[
{
"Description": "Hydrolysis rate",
"Language": "E",
"Dimension": "HYDROL"
}
]HTTP status code 204
No data found.
Secured by basic
delete /dimensions/{dimensionID}/languages/{languageID}
Delete the language description of a dimension.
Secured by basic
URI Parameters
- dimensionID: required (string)
- languageID: required (string)
HTTP status code 200
Successfully deletes dimension.
HTTP status code 400
The request could not be understood by the server due to malformed syntax.
Body
Media type: application/json
Type: object
Example:
{
"statusCode": 400,
"errorMessages": [
{
"severity": "ERROR",
"errorMessage": "Enter a valid dimension.",
"repeatedEntities": [],
"EntitiesNotFound": []
}
]
}