UPDATEASSETMODEL()`¶

About UpdateAssetModel¶

Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide.

If you remove a property from an asset model, IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property.

To replace an existing asset model property with a new one with the same name, do the following:

Submit an UpdateAssetModel request with the entire existing property removed.
Submit a second UpdateAssetModel request that includes the new property. The new asset property will have the same name as the previous one and IoT SiteWise will generate a new unique id.

Method Signature¶

METHODS /AWS1/IF_IOS~UPDATEASSETMODEL
  IMPORTING
    !IV_ASSETMODELID TYPE /AWS1/IOSCUSTOMID OPTIONAL
    !IV_ASSETMODELEXTERNALID TYPE /AWS1/IOSEXTERNALID OPTIONAL
    !IV_ASSETMODELNAME TYPE /AWS1/IOSNAME OPTIONAL
    !IV_ASSETMODELDESCRIPTION TYPE /AWS1/IOSDESCRIPTION OPTIONAL
    !IT_ASSETMODELPROPERTIES TYPE /AWS1/CL_IOSASSETMODELPROPERTY=>TT_ASSETMODELPROPERTIES OPTIONAL
    !IT_ASSETMODELHIERARCHIES TYPE /AWS1/CL_IOSASTMODELHIERARCHY=>TT_ASSETMODELHIERARCHIES OPTIONAL
    !IT_ASSETMODELCOMPOSITEMODELS TYPE /AWS1/CL_IOSASTMDELCOMPOSITE01=>TT_ASSETMODELCOMPOSITEMODELS OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/IOSCLIENTTOKEN OPTIONAL
    !IV_IFMATCH TYPE /AWS1/IOSETAG OPTIONAL
    !IV_IFNONEMATCH TYPE /AWS1/IOSSELECTALL OPTIONAL
    !IV_MATCHFORVERSIONTYPE TYPE /AWS1/IOSASSETMODELVERSIONTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_iosupdassetmodelrsp
  RAISING
    /AWS1/CX_IOSCNFLCTOPERATIONEX
    /AWS1/CX_IOSINTERNALFAILUREEX
    /AWS1/CX_IOSINVALIDREQUESTEX
    /AWS1/CX_IOSLIMITEXCEEDEDEX
    /AWS1/CX_IOSPRECONDFAILEDEX
    /AWS1/CX_IOSRESRCALRDYEXISTSEX
    /AWS1/CX_IOSRESOURCENOTFOUNDEX
    /AWS1/CX_IOSTHROTTLINGEX
    /AWS1/CX_IOSCLIENTEXC
    /AWS1/CX_IOSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_assetmodelid` `TYPE /AWS1/IOSCUSTOMID` `/AWS1/IOSCUSTOMID`¶

The ID of the asset model to update. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

`iv_assetmodelname` `TYPE /AWS1/IOSNAME` `/AWS1/IOSNAME`¶

A unique name for the asset model.

Optional arguments:¶

`iv_assetmodelexternalid` `TYPE /AWS1/IOSEXTERNALID` `/AWS1/IOSEXTERNALID`¶

An external ID to assign to the asset model. The asset model must not already have an external ID. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.

`iv_assetmodeldescription` `TYPE /AWS1/IOSDESCRIPTION` `/AWS1/IOSDESCRIPTION`¶

A description for the asset model.

`it_assetmodelproperties` `TYPE /AWS1/CL_IOSASSETMODELPROPERTY=>TT_ASSETMODELPROPERTIES` `TT_ASSETMODELPROPERTIES`¶

The updated property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide.

You can specify up to 200 properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

`it_assetmodelhierarchies` `TYPE /AWS1/CL_IOSASTMODELHIERARCHY=>TT_ASSETMODELHIERARCHIES` `TT_ASSETMODELHIERARCHIES`¶

The updated hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

`it_assetmodelcompositemodels` `TYPE /AWS1/CL_IOSASTMDELCOMPOSITE01=>TT_ASSETMODELCOMPOSITEMODELS` `TT_ASSETMODELCOMPOSITEMODELS`¶

The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.

When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see Creating custom composite models (Components) in the IoT SiteWise User Guide.

`iv_clienttoken` `TYPE /AWS1/IOSCLIENTTOKEN` `/AWS1/IOSCLIENTTOKEN`¶

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

`iv_ifmatch` `TYPE /AWS1/IOSETAG` `/AWS1/IOSETAG`¶

The expected current entity tag (ETag) for the asset model’s latest or active version (specified using matchForVersionType).
The update request is rejected if the tag does not match the latest or active version's current entity tag. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.

`iv_ifnonematch` `TYPE /AWS1/IOSSELECTALL` `/AWS1/IOSSELECTALL`¶

Accepts * to reject the update request if an active version (specified using matchForVersionType as ACTIVE) already exists for the asset model.

`iv_matchforversiontype` `TYPE /AWS1/IOSASSETMODELVERSIONTYPE` `/AWS1/IOSASSETMODELVERSIONTYPE`¶

Specifies the asset model version type (LATEST or ACTIVE) used in conjunction with If-Match or If-None-Match headers to determine the target ETag for the update operation.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_iosupdassetmodelrsp` `/AWS1/CL_IOSUPDASSETMODELRSP`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->updateassetmodel(
  it_assetmodelcompositemodels = VALUE /aws1/cl_iosastmdelcomposite01=>tt_assetmodelcompositemodels(
    (
      new /aws1/cl_iosastmdelcomposite01(
        it_properties = VALUE /aws1/cl_iosassetmodelproperty=>tt_assetmodelproperties(
          (
            new /aws1/cl_iosassetmodelproperty(
              io_type = new /aws1/cl_iospropertytype(
                io_attribute = new /aws1/cl_iosattribute( |string| )
                io_measurement = new /aws1/cl_iosmeasurement( new /aws1/cl_iosmeasurementproci00( new /aws1/cl_iosforwardingconfig( |string| ) ) )
                io_metric = new /aws1/cl_iosmetric(
                  io_processingconfig = new /aws1/cl_iosmetricprocingcfg( |string| )
                  io_window = new /aws1/cl_iosmetricwindow(
                    io_tumbling = new /aws1/cl_iostumblingwindow(
                      iv_interval = |string|
                      iv_offset = |string|
                    )
                  )
                  it_variables = VALUE /aws1/cl_iosexpressionvariable=>tt_expressionvariables(
                    (
                      new /aws1/cl_iosexpressionvariable(
                        io_value = new /aws1/cl_iosvariablevalue(
                          it_propertypath = VALUE /aws1/cl_iosastmdelprppathse00=>tt_assetmodelpropertypath(
                            (
                              new /aws1/cl_iosastmdelprppathse00(
                                iv_id = |string|
                                iv_name = |string|
                              )
                            )
                          )
                          iv_hierarchyid = |string|
                          iv_propertyid = |string|
                        )
                        iv_name = |string|
                      )
                    )
                  )
                  iv_expression = |string|
                )
                io_transform = new /aws1/cl_iostransform(
                  io_processingconfig = new /aws1/cl_iostransformprocing00(
                    io_forwardingconfig = new /aws1/cl_iosforwardingconfig( |string| )
                    iv_computelocation = |string|
                  )
                  it_variables = VALUE /aws1/cl_iosexpressionvariable=>tt_expressionvariables(
                    (
                      new /aws1/cl_iosexpressionvariable(
                        io_value = new /aws1/cl_iosvariablevalue(
                          it_propertypath = VALUE /aws1/cl_iosastmdelprppathse00=>tt_assetmodelpropertypath(
                            (
                              new /aws1/cl_iosastmdelprppathse00(
                                iv_id = |string|
                                iv_name = |string|
                              )
                            )
                          )
                          iv_hierarchyid = |string|
                          iv_propertyid = |string|
                        )
                        iv_name = |string|
                      )
                    )
                  )
                  iv_expression = |string|
                )
              )
              it_path = VALUE /aws1/cl_iosastmdelprppathse00=>tt_assetmodelpropertypath(
                (
                  new /aws1/cl_iosastmdelprppathse00(
                    iv_id = |string|
                    iv_name = |string|
                  )
                )
              )
              iv_datatype = |string|
              iv_datatypespec = |string|
              iv_externalid = |string|
              iv_id = |string|
              iv_name = |string|
              iv_unit = |string|
            )
          )
        )
        iv_description = |string|
        iv_externalid = |string|
        iv_id = |string|
        iv_name = |string|
        iv_type = |string|
      )
    )
  )
  it_assetmodelhierarchies = VALUE /aws1/cl_iosastmodelhierarchy=>tt_assetmodelhierarchies(
    (
      new /aws1/cl_iosastmodelhierarchy(
        iv_childassetmodelid = |string|
        iv_externalid = |string|
        iv_id = |string|
        iv_name = |string|
      )
    )
  )
  it_assetmodelproperties = VALUE /aws1/cl_iosassetmodelproperty=>tt_assetmodelproperties(
    (
      new /aws1/cl_iosassetmodelproperty(
        io_type = new /aws1/cl_iospropertytype(
          io_attribute = new /aws1/cl_iosattribute( |string| )
          io_measurement = new /aws1/cl_iosmeasurement( new /aws1/cl_iosmeasurementproci00( new /aws1/cl_iosforwardingconfig( |string| ) ) )
          io_metric = new /aws1/cl_iosmetric(
            io_processingconfig = new /aws1/cl_iosmetricprocingcfg( |string| )
            io_window = new /aws1/cl_iosmetricwindow(
              io_tumbling = new /aws1/cl_iostumblingwindow(
                iv_interval = |string|
                iv_offset = |string|
              )
            )
            it_variables = VALUE /aws1/cl_iosexpressionvariable=>tt_expressionvariables(
              (
                new /aws1/cl_iosexpressionvariable(
                  io_value = new /aws1/cl_iosvariablevalue(
                    it_propertypath = VALUE /aws1/cl_iosastmdelprppathse00=>tt_assetmodelpropertypath(
                      (
                        new /aws1/cl_iosastmdelprppathse00(
                          iv_id = |string|
                          iv_name = |string|
                        )
                      )
                    )
                    iv_hierarchyid = |string|
                    iv_propertyid = |string|
                  )
                  iv_name = |string|
                )
              )
            )
            iv_expression = |string|
          )
          io_transform = new /aws1/cl_iostransform(
            io_processingconfig = new /aws1/cl_iostransformprocing00(
              io_forwardingconfig = new /aws1/cl_iosforwardingconfig( |string| )
              iv_computelocation = |string|
            )
            it_variables = VALUE /aws1/cl_iosexpressionvariable=>tt_expressionvariables(
              (
                new /aws1/cl_iosexpressionvariable(
                  io_value = new /aws1/cl_iosvariablevalue(
                    it_propertypath = VALUE /aws1/cl_iosastmdelprppathse00=>tt_assetmodelpropertypath(
                      (
                        new /aws1/cl_iosastmdelprppathse00(
                          iv_id = |string|
                          iv_name = |string|
                        )
                      )
                    )
                    iv_hierarchyid = |string|
                    iv_propertyid = |string|
                  )
                  iv_name = |string|
                )
              )
            )
            iv_expression = |string|
          )
        )
        it_path = VALUE /aws1/cl_iosastmdelprppathse00=>tt_assetmodelpropertypath(
          (
            new /aws1/cl_iosastmdelprppathse00(
              iv_id = |string|
              iv_name = |string|
            )
          )
        )
        iv_datatype = |string|
        iv_datatypespec = |string|
        iv_externalid = |string|
        iv_id = |string|
        iv_name = |string|
        iv_unit = |string|
      )
    )
  )
  iv_assetmodeldescription = |string|
  iv_assetmodelexternalid = |string|
  iv_assetmodelid = |string|
  iv_assetmodelname = |string|
  iv_clienttoken = |string|
  iv_ifmatch = |string|
  iv_ifnonematch = |string|
  iv_matchforversiontype = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_assetmodelstatus = lo_result->get_assetmodelstatus( ).
  IF lo_assetmodelstatus IS NOT INITIAL.
    lv_assetmodelstate = lo_assetmodelstatus->get_state( ).
    lo_errordetails = lo_assetmodelstatus->get_error( ).
    IF lo_errordetails IS NOT INITIAL.
      lv_errorcode = lo_errordetails->get_code( ).
      lv_errormessage = lo_errordetails->get_message( ).
      LOOP AT lo_errordetails->get_details( ) into lo_row.
        lo_row_1 = lo_row.
        IF lo_row_1 IS NOT INITIAL.
          lv_detailederrorcode = lo_row_1->get_code( ).
          lv_detailederrormessage = lo_row_1->get_message( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDIF.
ENDIF.

/AWS1/IF_IOS=>UPDATEASSETMODEL()¶

About UpdateAssetModel¶

Method Signature¶

IMPORTING¶

Required arguments:¶

iv_assetmodelid TYPE /AWS1/IOSCUSTOMID /AWS1/IOSCUSTOMID¶

iv_assetmodelname TYPE /AWS1/IOSNAME /AWS1/IOSNAME¶

Optional arguments:¶

iv_assetmodelexternalid TYPE /AWS1/IOSEXTERNALID /AWS1/IOSEXTERNALID¶

iv_assetmodeldescription TYPE /AWS1/IOSDESCRIPTION /AWS1/IOSDESCRIPTION¶

it_assetmodelproperties TYPE /AWS1/CL_IOSASSETMODELPROPERTY=>TT_ASSETMODELPROPERTIES TT_ASSETMODELPROPERTIES¶

it_assetmodelhierarchies TYPE /AWS1/CL_IOSASTMODELHIERARCHY=>TT_ASSETMODELHIERARCHIES TT_ASSETMODELHIERARCHIES¶

it_assetmodelcompositemodels TYPE /AWS1/CL_IOSASTMDELCOMPOSITE01=>TT_ASSETMODELCOMPOSITEMODELS TT_ASSETMODELCOMPOSITEMODELS¶

iv_clienttoken TYPE /AWS1/IOSCLIENTTOKEN /AWS1/IOSCLIENTTOKEN¶

iv_ifmatch TYPE /AWS1/IOSETAG /AWS1/IOSETAG¶

iv_ifnonematch TYPE /AWS1/IOSSELECTALL /AWS1/IOSSELECTALL¶

iv_matchforversiontype TYPE /AWS1/IOSASSETMODELVERSIONTYPE /AWS1/IOSASSETMODELVERSIONTYPE¶