Skip to content

/AWS1/IF_SGM=>LISTMODELS()

About ListModels

Lists models created with the CreateModel API.

Method Signature

METHODS /AWS1/IF_SGM~LISTMODELS
  IMPORTING
    !IV_SORTBY TYPE /AWS1/SGMMODELSORTKEY OPTIONAL
    !IV_SORTORDER TYPE /AWS1/SGMORDERKEY OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/SGMPAGINATIONTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/SGMMAXRESULTS OPTIONAL
    !IV_NAMECONTAINS TYPE /AWS1/SGMMODELNAMECONTAINS OPTIONAL
    !IV_CREATIONTIMEBEFORE TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IV_CREATIONTIMEAFTER TYPE /AWS1/SGMTIMESTAMP OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgmlistmodelsoutput
  RAISING
    /AWS1/CX_SGMCLIENTEXC
    /AWS1/CX_SGMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_sortby TYPE /AWS1/SGMMODELSORTKEY /AWS1/SGMMODELSORTKEY

Sorts the list of results. The default is CreationTime.

iv_sortorder TYPE /AWS1/SGMORDERKEY /AWS1/SGMORDERKEY

The sort order for results. The default is Descending.

iv_nexttoken TYPE /AWS1/SGMPAGINATIONTOKEN /AWS1/SGMPAGINATIONTOKEN

If the response to a previous ListModels request was truncated, the response includes a NextToken. To retrieve the next set of models, use the token in the next request.

iv_maxresults TYPE /AWS1/SGMMAXRESULTS /AWS1/SGMMAXRESULTS

The maximum number of models to return in the response.

iv_namecontains TYPE /AWS1/SGMMODELNAMECONTAINS /AWS1/SGMMODELNAMECONTAINS

A string in the model name. This filter returns only models whose name contains the specified string.

iv_creationtimebefore TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

A filter that returns only models created before the specified time (timestamp).

iv_creationtimeafter TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).

RETURNING

oo_output TYPE REF TO /aws1/cl_sgmlistmodelsoutput /AWS1/CL_SGMLISTMODELSOUTPUT

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->listmodels(
  iv_creationtimeafter = '20150101000000.0000000'
  iv_creationtimebefore = '20150101000000.0000000'
  iv_maxresults = 123
  iv_namecontains = |string|
  iv_nexttoken = |string|
  iv_sortby = |string|
  iv_sortorder = |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_models( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_modelname = lo_row_1->get_modelname( ).
      lv_modelarn = lo_row_1->get_modelarn( ).
      lv_timestamp = lo_row_1->get_creationtime( ).
    ENDIF.
  ENDLOOP.
  lv_paginationtoken = lo_result->get_nexttoken( ).
ENDIF.