Skip to content

/AWS1/IF_APF=>LISTCONNECTORENTITIES()

About ListConnectorEntities

Returns the list of available connector entities supported by Amazon AppFlow. For example, you can query Salesforce for Account and Opportunity entities, or query ServiceNow for the Incident entity.

Method Signature

METHODS /AWS1/IF_APF~LISTCONNECTORENTITIES
  IMPORTING
    !IV_CONNECTORPROFILENAME TYPE /AWS1/APFCONNECTORPROFILENAME OPTIONAL
    !IV_CONNECTORTYPE TYPE /AWS1/APFCONNECTORTYPE OPTIONAL
    !IV_ENTITIESPATH TYPE /AWS1/APFENTITIESPATH OPTIONAL
    !IV_APIVERSION TYPE /AWS1/APFAPIVERSION OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/APFLISTENTSMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/APFNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_apflistcnctorentsrsp
  RAISING
    /AWS1/CX_APFCNCTORAUTHNTCTNEX
    /AWS1/CX_APFCONNECTORSERVEREX
    /AWS1/CX_APFINTERNALSERVEREX
    /AWS1/CX_APFRESOURCENOTFOUNDEX
    /AWS1/CX_APFVALIDATIONEX
    /AWS1/CX_APFCLIENTEXC
    /AWS1/CX_APFSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_connectorprofilename TYPE /AWS1/APFCONNECTORPROFILENAME /AWS1/APFCONNECTORPROFILENAME

The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web Services account, and is used to query the downstream connector.

iv_connectortype TYPE /AWS1/APFCONNECTORTYPE /AWS1/APFCONNECTORTYPE

The type of connector, such as Salesforce, Amplitude, and so on.

iv_entitiespath TYPE /AWS1/APFENTITIESPATH /AWS1/APFENTITIESPATH

This optional parameter is specific to connector implementation. Some connectors support multiple levels or categories of entities. You can find out the list of roots for such providers by sending a request without the entitiesPath parameter. If the connector supports entities at different roots, this initial request returns the list of roots. Otherwise, this request returns all entities supported by the provider.

iv_apiversion TYPE /AWS1/APFAPIVERSION /AWS1/APFAPIVERSION

The version of the API that's used by the connector.

iv_maxresults TYPE /AWS1/APFLISTENTSMAXRESULTS /AWS1/APFLISTENTSMAXRESULTS

The maximum number of items that the operation returns in the response.

iv_nexttoken TYPE /AWS1/APFNEXTTOKEN /AWS1/APFNEXTTOKEN

A token that was provided by your prior ListConnectorEntities operation if the response was too big for the page size. You specify this token to get the next page of results in paginated response.

RETURNING

oo_output TYPE REF TO /aws1/cl_apflistcnctorentsrsp /AWS1/CL_APFLISTCNCTORENTSRSP

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->listconnectorentities(
  iv_apiversion = |string|
  iv_connectorprofilename = |string|
  iv_connectortype = |string|
  iv_entitiespath = |string|
  iv_maxresults = 123
  iv_nexttoken = |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_connectorentitymap( ) into ls_row.
    lv_key = ls_row-key.
    LOOP AT ls_row-value into lo_row_1.
      lo_row_2 = lo_row_1.
      IF lo_row_2 IS NOT INITIAL.
        lv_name = lo_row_2->get_name( ).
        lv_label = lo_row_2->get_label( ).
        lv_boolean = lo_row_2->get_hasnestedentities( ).
      ENDIF.
    ENDLOOP.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.