GET /integration/assets/r1/assets

BPMN Diagram

Business Logic

This Integration API gets an Asset with its Address.

The API returns only Asset not dummy.

One of code or externalCode must be present. If code is provided it has the precedence among the other field. If externalCode is provided then externalSystemCode becomes mandatory.

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 Retrieve

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 Transcode

System takes Input fields and gets the resource.

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 - Asset Type Transcode

System takes Input fields and gets the resource.

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 - Parent Asset and Root Asset Transcode

System takes Input fields and gets the resource.

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 - Status Transcode

System takes Input fields and gets the resource.

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 - Address Retrieve

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 8 - Country Transcode

System takes Input fields and gets the resource.

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 Transcode

System takes Input fields and gets the resource.

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 - Work Center Transcode

System takes Input fields and gets the resource.

If System can obtain the Output fields → elaboration is stopped. See Response payload fields

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

STEP 11 -Asset Characteristics Retrieve

System takes Input fields and gets the resource.

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 Transcode

System takes Input fields and gets the resource as many times as needed .

If System can obtain the Output fields → elaboration is stopped. See Response payload fields

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

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 &.

Filter

Fields

The parameter _fields allows to choose output fields. More info here How to use APIs: Output fields selection.

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.

Default.

Request example

{baseUrl}/integration/assets/r1/assets?externalSystemCode=SAP&externalCode=ASS_001

Response documentation

Response payload fields

operationCenterObject

typeObject

parentObject

rootObject

statusObject

externalSystemObject

addressObject

workCenterObject

characteristicObject

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

Extension fields:

Response example

{
  "extension": {
     "myFieldName": "myValue"
  },
  "id": 123,
  "code": "ASS_001",
  "description": "ASSET 001",
  "note": "abcdefghif...",
  "externalCode": "EXT-01",
  "operationCenter": {
        "extension": {},
        "code": "OCGAS",
        "description": [
          {
            "lang": "en",
            "value": "Center Gass OC"
          }
        ]
      },
  "type": {
        "extension": {},
        "code": "EXT-EXCAV-IELBT",
        "description": [
          {
            "lang": "en",
            "value": "Extraordinary maintenance / Excavation / Electrical system LV"
          }
        ]
      },
  "parent": {
        "extension": {},
        "code": "ASS_002",
        "description": "ASSET 002"
          },
  "root": {
        "extension": {},
        "code": "ASS_003",
        "description": "ASSET 003"
          },
  "status": {
        "extension": {},
        "code": "5",
        "description": "Schedulable"
      },
  "externalSystem": {
        "extension": {},
        "code": "SAP",
        "description": "SAP"
      }, 
  "address": {
        "extension": {},
        "description": "INITIAL ADDRESS",
        "countryIsoAlphaCode": "IT",
        "districtAcronym": "MI",
        "municipality": "MILANO",
        "municipalityCode": "015146",
        "locality": "MILANO",
        "postalCode": "20161",
        "street": "FRATELLI BELTRAMI",
        "streetNumber": 21,
        "streetNumberExtension": "A",
        "yCoordinate": 0.1,
        "xCoordinate": 0.1,
        "toponym": "VIA"
      },
  "workCenter": {
    "extension": {},
    "code": "WC_01",
    "description": [
      {
        "lang": "it",
        "value": "Work Center 1"
      }
    ]
  },
  "characteristics": [
    {
      "extension": {},
      "code": "COLOUR",
      "value": "red"
    }
  ]
}

 Response error codes