LISTASSETRELATIONSHIPS()`¶

About ListAssetRelationships¶

Retrieves a paginated list of asset relationships for an asset. You can use this operation to identify an asset's root asset and all associated assets between that asset and its root.

Method Signature¶

METHODS /AWS1/IF_IOS~LISTASSETRELATIONSHIPS
  IMPORTING
    !IV_ASSETID TYPE /AWS1/IOSCUSTOMID OPTIONAL
    !IV_TRAVERSALTYPE TYPE /AWS1/IOSTRAVERSALTYPE OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/IOSNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/IOSMAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ioslstastrelationsh01
  RAISING
    /AWS1/CX_IOSINTERNALFAILUREEX
    /AWS1/CX_IOSINVALIDREQUESTEX
    /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_assetid` `TYPE /AWS1/IOSCUSTOMID` `/AWS1/IOSCUSTOMID`¶

The ID of the asset. 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_traversaltype` `TYPE /AWS1/IOSTRAVERSALTYPE` `/AWS1/IOSTRAVERSALTYPE`¶

The type of traversal to use to identify asset relationships. Choose the following option:

PATH_TO_ROOT – Identify the asset's parent assets up to the root asset. The asset that you specify in assetId is the first result in the list of assetRelationshipSummaries, and the root asset is the last result.

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/IOSNEXTTOKEN` `/AWS1/IOSNEXTTOKEN`¶

The token to be used for the next set of paginated results.

`iv_maxresults` `TYPE /AWS1/IOSMAXRESULTS` `/AWS1/IOSMAXRESULTS`¶

The maximum number of results to return for each paginated request.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ioslstastrelationsh01` `/AWS1/CL_IOSLSTASTRELATIONSH01`¶

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->listassetrelationships(
  iv_assetid = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_traversaltype = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_assetrelationshipsums( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lo_assethierarchyinfo = lo_row_1->get_hierarchyinfo( ).
      IF lo_assethierarchyinfo IS NOT INITIAL.
        lv_id = lo_assethierarchyinfo->get_parentassetid( ).
        lv_id = lo_assethierarchyinfo->get_childassetid( ).
      ENDIF.
      lv_assetrelationshiptype = lo_row_1->get_relationshiptype( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_IOS=>LISTASSETRELATIONSHIPS()¶