|
Http Verb |
POST |
|---|---|
|
Url |
/assets/r1/assets/{assetId}/measuring-elements/{measuringElementId}/measures |
|
Permissions required |
Technical Object: View (fsm.core.technicalobject.facility.view) or Technical Object: Edit (fsm.core.technicalobject.facility.edit) and Measuring Element: Edit (fsm.core.technicalobject.measure.edit) |
|
Personally Identifiable Information (PII) |
No |
|
Sensitive Information |
No |
|
Last Modified Version |
r1 - 2026 W2 (FSM 23.0) |
|
Released since |
2025 W2 (FSM 20.0) |
|
Deprecated since |
|
|
Removed since |
|
|
Tech Tags |
|
Business Logic
This API creates a new Measure for the selected asset. A measure is defined by the mandatory fields:
-
measuringDate
-
measuringUserId
A measure can be inserted only when its measuring element’s status is set to WORKING (27001).
In order to successfully call this api the user must follow one of the following scenario:
-
If the user sets to true the flag unfeasible then the only data that he can modify are: measuringDate, measuringUserId and notes, the other data set in input will be discarded and the data set to the measure will be the one of the previous measure with eventually the alignment if it is necessary
-
If the measuring element has a catalogGroup then the user can also specify a catalogCode, the catalogCode must exists
-
If the measuring element has a characteristic the scenario will be two:
-
Characteristic is of type meter: the user can also specify:
-
deltaValue, allowed only for this kind of characteristic, can’t valorise both value and deltaValue
-
rotations, it is needed if the counterOverflow reaches the max value, error: PROPERTY_REQUIRED
-
For FORWARD counters (counting up):
-
When the current value is less than the
previousValue -
Example: Previous reading was 995, new reading is 002 (counter rolled over)
-
-
For BACKWARD counters (counting down):
-
When the current value is greater than the
previousValue -
Example: Previous reading was 002, new reading is 995 (counter rolled over)
-
This handles counter overflow situations:
-
Forward counter: 999 → 000 (needs rotation count)
-
Backward counter: 000 → 999 (needs rotation count)
The user needs to specify rotations in these cases because the system can't automatically determine if the counter has completed one full rotation or if it's an error in the reading.
-
-
-
Characteristic is not of type meter:
-
value
-
-
Path parameters
|
Field |
Note |
|---|---|
|
assetId |
|
|
measuringElementId |
|
Header Parameters
Default.
Request Body Parameters
|
Field |
Validations |
Note |
|---|---|---|
|
measuringUserId |
Not null |
|
|
measuringDate |
Not null |
|
|
value |
|
Allowed only if the measuring element has a characteristic defined value and deltaValue can’t be simultaneously valued |
|
deltaValue |
|
Allowed only if the measuring element has a characteristic defined and this characteristic is of type meter value and deltaValue can’t be simultaneously valued |
|
rotations |
|
Allowed only if the measuring element has a characteristic defined and this characteristic is of type meter |
|
catalogCodeId |
|
Allowed only if the measuring element has a catalog group defined |
|
note |
|
|
|
unfeasible |
|
Set it to true if the measure was impossible to do and you want to create a new measure that gets the values from the previous measure |
|
externalCode |
Unique for the same Measuring Element |
Available since 2026 W2 (FSM 23.0) |
Response documentation
Response payload fields
|
Field |
Note |
|---|---|
|
payload |
|
Response error codes
BASE_0001, BASE_0003, BASE_0011, NOT_FOUND, ASSETS_ORCHESTRATOR_011, ASSETS_ORCHESTRATOR_012, ASSETS_ORCHESTRATOR_013, ASSETS_ORCHESTRATOR_014, ASSETS_ORCHESTRATOR_019, ASSETS_ORCHESTRATOR_022