PUT /api/:space/unitofmeasure

Description:

Update a Unit Of Measure by Id.

The Unit Of Measure that needs to be updated its Id has to exist in the Request body field.

Any Put body Parameters that are excluded in the Request body field will be considered as empty and updated with an empty field

Resource URL:

https://<apphost>.competitionlabs.com/api/<your-space-name>/unitofmeasure

Request headers

Key	Value	Required
X-API-KEY	Your unique API key	Yes
Content-Type	application/json	Yes

Request URL parameters

Parameter	Type	Required	Description
space	String	Yes	This is the space name which is linked to the account

Put body parameters

Parameter	Type	Required	Description
name	String	Yes	The name of a unit of measure
key	String	Yes	The reference to the unit of measure in your system
description	String	Optional	The description of a unit of measure
isoCode	String	Optional	An alphabetical or numerical code to identify a unit of measure
symbol	String	Optional	The symbol of a unit of measure
multiplier	Double	Yes	Is used to multiply the value from the standardised one that is being used
unitOfMeasureType	String	Yes	A type of unit of measure, eg. Currency, Mass, Time and etc.
metadata	Array [Object]	Optional	A list of MetaData
Id	String	Yes	Unique system identifier of a Unit Of Measure

EXAMPLE

Request

curl
--header "X-API-KEY: <your-api-key>"
--header "Content-Type: application/json"
--request PUT https://app.competitionlabs.com/api/<your-space-name>/unitofmeasure
-d '{ "name": "test", "key": "test", "description": "test", "isoCode": "T", "symbol": "T", "multiplier": 1.0, "unitOfMeasureType": "Distance", "metadata": [{ "jsonClass": "Metadata", "key": "key", "value": "1" }], "id": "l-TwTW0BBZeE7Tj3bRM4", "translations": {}, "translatableFields": [ "name", "description" ]}'

Response

{
    "data": {
        "jsonClass": "UnitOfMeasure",
        "name": "test",
        "key": "test",
        "description": "test",
        "isoCode": "T",
        "symbol": "T",
        "multiplier": 1.0,
        "unitOfMeasureType": "Distance",
        "metadata": [
            {
                "jsonClass": "Metadata",
                "key": "key",
                "value": "1"
            }
        ],
        "accountId": "0sn4DmUBkPH_lz9GgxBM",
        "created": "2019-09-20T09:11:05.270+0000",
        "id": "l-TwTW0BBZeE7Tj3bRM4",
        "translations": {},
        "translatableFields": [
            "name",
            "description"
        ]
    }
}

ERROR CODES

Code	HTTP Status	Description	Example
	404	Inserting the Id in the Request URL parameter	Error Response 404 Expand source { "status": 404 }
	503	Updating without the `Id` parameter	Error Response 503 Expand source { "status": 503 }
1001	400	`Unit Of Measure Type` parameter was excluded; `Unit Of Measure Type` parameter was incorrect; `Multiplier` parameter was excluded; `Name` parameter was excluded; `Key` parameter was excluded;	Error Response 400 Expand source { "errors": [ { "message": "Malformed JSON body.", "code": 1001, "status": 400 } ] }
1007	404	A record with requested id for unit-of-measures was not found	Error Response 404 Expand source { "errors": [ { "message": "A record with requested id [l-TwTW0BBZeE7Tj3bRM4] for unit-of-measures was not found.", "code": 1007, "status": 404 } ] }
1002	404	The parameter `Name` can not be empty; The parameter `Key` can not be empty;	Error Response 404 Expand source { "errors": [ { "message": "Please enter a name for the unit of measure.", "code": 1002, "status": 404 } ] } Error Response 404 Expand source { "errors": [ { "message": "Please enter a key for the unit of measure.", "code": 1002, "status": 404 } ] }