LISTENTITIES()`¶

About ListEntities¶

Lists all entities in a workspace.

Method Signature¶

METHODS /AWS1/IF_IOM~LISTENTITIES
  IMPORTING
    !IV_WORKSPACEID TYPE /AWS1/IOMID OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_IOMLISTENTITIESFILTER=>TT_LISTENTITIESFILTERS OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/IOMMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/IOMNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_iomlistentsresponse
  RAISING
    /AWS1/CX_IOMINTERNALSERVEREX
    /AWS1/CX_IOMSERVICEQUOTAEXCDEX
    /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 ID of the workspace.

Optional arguments:¶

`it_filters` `TYPE /AWS1/CL_IOMLISTENTITIESFILTER=>TT_LISTENTITIESFILTERS` `TT_LISTENTITIESFILTERS`¶

A list of objects that filter the request.

Only one object is accepted as a valid input.

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

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

Valid Range: Minimum value of 1. Maximum value of 250.

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

The string that specifies the next page of results.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_iomlistentsresponse` `/AWS1/CL_IOMLISTENTSRESPONSE`¶

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->listentities(
  it_filters = VALUE /aws1/cl_iomlistentitiesfilter=>tt_listentitiesfilters(
    (
      new /aws1/cl_iomlistentitiesfilter(
        iv_componenttypeid = |string|
        iv_externalid = |string|
        iv_parententityid = |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_entitysummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_entityid = lo_row_1->get_entityid( ).
      lv_entityname = lo_row_1->get_entityname( ).
      lv_twinmakerarn = lo_row_1->get_arn( ).
      lv_parententityid = lo_row_1->get_parententityid( ).
      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_description = lo_row_1->get_description( ).
      lv_boolean = lo_row_1->get_haschildentities( ).
      lv_timestamp = lo_row_1->get_creationdatetime( ).
      lv_timestamp = lo_row_1->get_updatedatetime( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_IOM=>LISTENTITIES()¶