Step asset-creation

BPMN Diagram

Business Logic

This Integration API creates a new Asset.

System verifies Permission Required and starts the elaboration that is organized in steps.

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 in internal configuration because it’s forbidden to have multiple Assets with the same code.

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

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

STEP 3 - Address Existence

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

System uses a calculated Code for the Address ('ASSET_' + code) to manage the retry of the request.

If System can obtain the Output fields and targetId is valued → responds with error. Elaboration is stopped.

If System can obtain the Output fields and targetId is absent → continue to next step.

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

STEP 4 - Asset Type 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 5 - Asset Status 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 6 - Operation Center Validation

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

This step is skipped if Input fields are absent so Asset will be not related with an Operation Center.

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 - Work 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 8 - Country 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 9 - District Validation

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

This step is skipped if districtAcronym and districtCode are both 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 10 - Parent Asset Validation

System takes Input fields and checks if Parent Asset exists.

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 11 - Characteristic Class Validation

System takes Input fields and checks if characteristic class exists.

System transcode optional input field classType in classTypeId 1 for ASSET and classTypeId 2 for MATERIAL. Default value of classTypeId is 1.

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 12 - Characteristics Validation

System takes Input fields and checks if all characteristics in input exist.

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 13 - Characteristics Value Validation

System takes Input fields and checks if characteristic value exists.

This step is skipped if “dataTypeId“ fields retrieve from the STEP Characteristics Validation is absent or different from 7 (Combobox) or characteristic.value is absent or null.

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 14- Address Evaluation

System evaluates the response obtained from Address Existence STEP.

If addressId exists but targetId is absent → continue to step Address Update.

If addressId doesn’t exist → continue to step Address Creation.

STEP 14a - Address Creation

System takes Input fields and creates an Address in internal configuration.

System uses a calculated Code for the Address ('ASSET_' + code) to manage the retry of the request.

If Response State is SUCCESS → continue to step Address Normalization.

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

STEP 14b - Address Update

System takes Input fields and updates the entity.

If Response State is SUCCESS → continue to next step.

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

STEP 15 - Address Normalization

System evaluates input fields xCoordinate and yCoordinate to decide if Address Normalization is necessary.

This step is skipped if xCoordinate and yCoordinate are present.

If Response State is SUCCESS → continue to next step.

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

STEP 16 - Asset Creation

System takes Input fields, validate them and creates the Asset.

Furthermore system creates the link between Asset and its Address.

If Response State is SUCCESS → continue to next step.

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

STEP 17 - Asset-Parent Asset Relationship Creation

System takes Input fields and creates the relationship between asset and its parent.

This step is skipped if parentAssetId is absent and Asset will be a root (See Parent Asset Existence step).

If Response State is SUCCESS → continue to next step.

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

STEP 18 - Additional Information Providing

System uses field linear, obtained as Output from ‘Asset Type Validation’ STEP, to evaluate if Asset is Linear.

The step is skipped if linear=false.

If Response State is SUCCESS → elaboration is stopped. See continue to next step.

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

STEP 19 - Relationship Asset and Characteristics Creation

System uses the list of characteristicId, obtained from STEP Characteristics Validation, to associate Characteristics to the Asset.

This step is skipped if Input fields are absent.

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

{
  "extension": {},
  "asset": {
    "extension": {
        "myFieldName": "myValue"
    },
    "externalSystemCode": "SAP",
    "code": "Asset_'1",
    "typeCode": "GG_01_XX",
    "operationCenterCode": "NextGenOperationCenter",
    "parentAssetCode": "parentAsset",
    "description": "description of the asset",
    "note": "note of the asset",
    "statusCode": "OPEN",
    "externalCode": "Ext_Asset_01",
    "workCenterCode": "A01"
  },
  "address": {
     "extension": {
        "myFieldName": "myValue"
    },
    "streetNumber": 81,
    "toponym": "via",
    "street": "Bassi",
    "countryIsoAlphaCode": "IT",
    "postalCode": "33080",
    "municipality": "Fiume Veneto",
    "districtAcronym": "PN"
  },
  "characteristics": [
  {
   "extension": {},
   "code": "COLOUR",
   "value": "red"
  }]
}

Response documentation

Response payload fields

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

Extension fields:

Response example

{
  "id": 123456
}

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

Response error codes