LISTCOMPONENTS()`¶

About ListComponents¶

This API lists the components of an entity.

Method Signature¶

METHODS /AWS1/IF_IOM~LISTCOMPONENTS
  IMPORTING
    !IV_WORKSPACEID TYPE /AWS1/IOMID OPTIONAL
    !IV_ENTITYID TYPE /AWS1/IOMENTITYID OPTIONAL
    !IV_COMPONENTPATH TYPE /AWS1/IOMCOMPONENTPATH OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/IOMMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/IOMNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_iomlistcomponentsrsp
  RAISING
    /AWS1/CX_IOMACCESSDENIEDEX
    /AWS1/CX_IOMINTERNALSERVEREX
    /AWS1/CX_IOMRESOURCENOTFOUNDEX
    /AWS1/CX_IOMTHROTTLINGEX
    /AWS1/CX_IOMVALIDATIONEX
    /AWS1/CX_IOMCLIENTEXC
    /AWS1/CX_IOMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_workspaceid` `TYPE /AWS1/IOMID` `/AWS1/IOMID`¶

The workspace ID.

`iv_entityid` `TYPE /AWS1/IOMENTITYID` `/AWS1/IOMENTITYID`¶

The ID for the entity whose metadata (component/properties) is returned by the operation.

Optional arguments:¶

`iv_componentpath` `TYPE /AWS1/IOMCOMPONENTPATH` `/AWS1/IOMCOMPONENTPATH`¶

This string specifies the path to the composite component, starting from the top-level component.

`iv_maxresults` `TYPE /AWS1/IOMMAXRESULTS` `/AWS1/IOMMAXRESULTS`¶

The maximum number of results returned at one time. The default is 25.

`iv_nexttoken` `TYPE /AWS1/IOMNEXTTOKEN` `/AWS1/IOMNEXTTOKEN`¶

The string that specifies the next page of results.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_iomlistcomponentsrsp` `/AWS1/CL_IOMLISTCOMPONENTSRSP`¶

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->listcomponents(
  iv_componentpath = |string|
  iv_entityid = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_workspaceid = |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_componentsummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_name = lo_row_1->get_componentname( ).
      lv_componenttypeid = lo_row_1->get_componenttypeid( ).
      lv_string = lo_row_1->get_definedin( ).
      lv_description = lo_row_1->get_description( ).
      LOOP AT lo_row_1->get_propertygroups( ) into ls_row_2.
        lv_key = ls_row_2-key.
        lo_value = ls_row_2-value.
        IF lo_value IS NOT INITIAL.
          lv_grouptype = lo_value->get_grouptype( ).
          LOOP AT lo_value->get_propertynames( ) into lo_row_3.
            lo_row_4 = lo_row_3.
            IF lo_row_4 IS NOT INITIAL.
              lv_name = lo_row_4->get_value( ).
            ENDIF.
          ENDLOOP.
          lv_boolean = lo_value->get_isinherited( ).
        ENDIF.
      ENDLOOP.
      lo_status = lo_row_1->get_status( ).
      IF lo_status IS NOT INITIAL.
        lv_state = lo_status->get_state( ).
        lo_errordetails = lo_status->get_error( ).
        IF lo_errordetails IS NOT INITIAL.
          lv_errorcode = lo_errordetails->get_code( ).
          lv_errormessage = lo_errordetails->get_message( ).
        ENDIF.
      ENDIF.
      lv_syncsource = lo_row_1->get_syncsource( ).
      lv_componentpath = lo_row_1->get_componentpath( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_IOM=>LISTCOMPONENTS()¶