POST /integration/assets/r1/asset-measuring-elements/measures

BPMN Diagram

Business Logic

This Integration API inserts, updates and validates a measure related to an asset measuring element.

At least one between assetCode and assetExternalCode must be specified.

At least one between identificationNumber and secondaryIdentificationNumber must be specified.

At least one between value and deltaValue must be specified.

STEP 1 - External System Validation

System takes Input fields and checks their existence in internal configuration.

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

STEP 2 - Asset Existence

System takes Input fields and checks their existence.

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

STEP 3 - Operation Center Validation

System takes Input fields and checks their existence in internal configuration.

This step is skipped if input fields are absent.

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

STEP 4 - Measuring Element Existence

System takes Input fields and checks their existence and their correct state.

System transcode status “WORKING” to statusId = 27001.

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

STEP 5 - Measure Existence

System takes Input fields and existing measures to validate

This step is skipped if input field are absent.

If System can obtain the Output fields and at least one measureId has statusId != 1 → responds with error. Elaboration is stopped.

If System can obtain the Output fields and no measureId has statusId != 1 → Continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

STEP 6 - Catalog Code Existence

System takes Input fields and checks their existence.

This step is skipped if input fields are absent.

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

STEP 7 - Resource Existence

System takes Input fields and checks their existence.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

If System can obtain the Output fields → system evaluates the operationCenterId in Input:

• if operationCenterId in Input is not present, system takes only the resource in output with loan=false → continue to next step.

• if operationCenterId in Input is present, System verifies that in output

  • if resource not exist → responds with error. Elaboration is stopped.

  • If a resource exists, the system verify if exists a resource with same operationCenter

    • if exists selects the one with loan=false→ continue to next step.

    • if not exist → responds with error. Elaboration is stopped.

STEP 8 - Measures Measure Creation or Update

System verifies the presence of existing measure to be updated from STEP Measure Existence

Step 8b - Measure Update

System takes Input fields and updates already existing entities.

If Response State is SUCCESS → continue to next step.

If Response State is ERROR → elaboration is stopped. See Response payload fields.

Step 8c - Measure Creation

System takes Input fields and creates the entity.

The system generates a unique identifier for each externalCode if not populated from external system.

If Response State is SUCCESS → continue to next step.

If Response State is ERROR → elaboration is stopped. See Response payload fields.

Step 9 - Measure Validation

System takes Input fields and validates measures.

This step is skipped if validateMeasures is false.

If Response State is SUCCESS → continue to next step.

If Response State is ERROR → elaboration is stopped. See Response payload fields.

Step 10 - Measure Retrieval

System takes Input fields and retrieves output fields.

If Response State is SUCCESS → elaboration is stopped. See Response payload fields.

If Response State is ERROR → elaboration is stopped. See Response payload fields.

Path Parameters

As their name suggests, they are included in the URL path of the endpoint.

Not applicable.

Query String Parameters

Start with a ? and includes parameters listed one after the another separated by &.

Not applicable.

Header Parameters

Parameters included in the request headers. Generally, request headers are used to keep authorization parameters.

Default.

Request Body Parameters

Request body parameters are used when clients send data to the API. They are shipped in a JSON Object only in POST, PUT, or PATCH requests.

The objects in input could have also the extension object that allows to add additional, customized data to this API. More info here How to use APIs: Custom data via Extension.

Request example

Insert

{
  "extension": {},
  "externalSystemCode": "SYS001",
  "assetCode": "ASSET123",
  "operationCenterCode": "OC-ROME",
  "measuringElementCode": "TEMP-SENSOR-001",
  "measure": [ {
    "extension": {},
    "externalCode": "1234",
    "resourceIdentificationNumber": "RESOURCE-XYZ-OC-ROME",
    "measuringDate": "2025-06-06T15:00:00Z",
    "value": 25.5,
    "rotations": 1200,
    "catalogCode": "CAT-A",
    "note": "Standard Temperature Registered.",
    "unfeasible": false
  } ]
}

Response documentation

Response payload fields

Compliant with RFC Standard https://www.rfc-editor.org/rfc/rfc9457.html

Extension fields:

Response example

[
  {
  "id": 123456,
  "externalCode":"1234"
  },
  {
  "id": 123457,
  "externalCode":"4567"
  }
]

{
  "type": "about:blank",
  "title": "Not Found",
  "status": 404,
  "detail": "External system string does not exist",
  "instance": "/integration/workforce/r1/resources",
  "code": "IA001_001"
}

Response error codes