LISTFORMS()`¶

About ListForms¶

Retrieves a list of forms for a specified Amplify app and backend environment.

Method Signature¶

METHODS /AWS1/IF_AMU~LISTFORMS
  IMPORTING
    !IV_APPID TYPE /AWS1/AMUSTRING OPTIONAL
    !IV_ENVIRONMENTNAME TYPE /AWS1/AMUSTRING OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/AMUSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/AMULISTENTITYLIMIT OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_amulistformsresponse
  RAISING
    /AWS1/CX_AMUINTERNALSERVEREX
    /AWS1/CX_AMUINVALIDPARAMETEREX
    /AWS1/CX_AMUCLIENTEXC
    /AWS1/CX_AMUSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_appid` `TYPE /AWS1/AMUSTRING` `/AWS1/AMUSTRING`¶

The unique ID for the Amplify app.

`iv_environmentname` `TYPE /AWS1/AMUSTRING` `/AWS1/AMUSTRING`¶

The name of the backend environment that is a part of the Amplify app.

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/AMUSTRING` `/AWS1/AMUSTRING`¶

The token to request the next page of results.

`iv_maxresults` `TYPE /AWS1/AMULISTENTITYLIMIT` `/AWS1/AMULISTENTITYLIMIT`¶

The maximum number of forms to retrieve.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_amulistformsresponse` `/AWS1/CL_AMULISTFORMSRESPONSE`¶

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->listforms(
  iv_appid = |string|
  iv_environmentname = |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_entities( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_appid( ).
      lo_formdatatypeconfig = lo_row_1->get_datatype( ).
      IF lo_formdatatypeconfig IS NOT INITIAL.
        lv_formdatasourcetype = lo_formdatatypeconfig->get_datasourcetype( ).
        lv_string = lo_formdatatypeconfig->get_datatypename( ).
      ENDIF.
      lv_string = lo_row_1->get_environmentname( ).
      lv_formactiontype = lo_row_1->get_formactiontype( ).
      lv_uuid = lo_row_1->get_id( ).
      lv_formname = lo_row_1->get_name( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_AMU=>LISTFORMS()¶