|
Http Verb |
POST |
|---|---|
|
Url |
/assets/r1/assets/{assetId}/measuring-elements |
|
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 |
|
Released since |
2025 W2 (FSM 20.0) |
|
Deprecated since |
|
|
Removed since |
|
|
Tech Tags |
|
Business Logic
This API creates a new Measuring Element for the selected asset. A measuring element is defined by the mandatory fields:
-
code
-
description
-
statusId
The measuring element must also be defined by a characteristic, a catalog group or both.
In order to associate a characteristic to a measuring element, the former must be active and have its usage set to ‘Measure’ or ‘Both’. When a characteristic is provided, the measuring unit and max-length are derived from the characteristic, unless different measuring unit and max-length values are provided.
If no characteristic is provided, the measuring unit, max-length, counter direction and counter overflow value properties are not allowed.
In order to associate a catalog group to a measuring element, the former must be active and be defined by the entity type ‘Measurements’.
Path parameters
|
Field |
Note |
|---|---|
|
assetId |
|
Header Parameters
Default.
Request Body Parameters
|
Field |
Validations |
Note |
|---|---|---|
|
code |
Not null Max Length: 40 |
|
|
description |
Not null Max Length: 40 |
|
|
order |
Max Length: 4 |
|
|
statusId |
Not null |
|
|
characteristicId |
|
|
|
counterDirectionId |
|
Allowed only if the characteristic has the ‘meter’ flag to true |
|
measurementUnitId |
|
Allowed only if a characteristic is provided |
|
maxLength |
|
Allowed only if a characteristic is provided |
|
catalogGroupId |
|
|
|
counterOverflowValue |
|
Allowed only if the characteristic has the ‘meter’ flag to true |
|
targetValue |
|
|
Response documentation
Response payload fields
|
Field |
Note |
|---|---|
|
payload |
|
Response error codes