Skip to content

/AWS1/IF_SGM=>LISTEXPERIMENTS()

About ListExperiments

Lists all the experiments in your account. The list can be filtered to show only experiments that were created in a specific time range. The list can be sorted by experiment name or creation time.

Method Signature

METHODS /AWS1/IF_SGM~LISTEXPERIMENTS
  IMPORTING
    !IV_CREATEDAFTER TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IV_CREATEDBEFORE TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IV_SORTBY TYPE /AWS1/SGMSORTEXPERIMENTSBY OPTIONAL
    !IV_SORTORDER TYPE /AWS1/SGMSORTORDER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/SGMNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/SGMMAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgmlistexperimentsrsp
  RAISING
    /AWS1/CX_SGMCLIENTEXC
    /AWS1/CX_SGMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_createdafter TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

A filter that returns only experiments created after the specified time.

iv_createdbefore TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

A filter that returns only experiments created before the specified time.

iv_sortby TYPE /AWS1/SGMSORTEXPERIMENTSBY /AWS1/SGMSORTEXPERIMENTSBY

The property used to sort results. The default value is CreationTime.

iv_sortorder TYPE /AWS1/SGMSORTORDER /AWS1/SGMSORTORDER

The sort order. The default value is Descending.

iv_nexttoken TYPE /AWS1/SGMNEXTTOKEN /AWS1/SGMNEXTTOKEN

If the previous call to ListExperiments didn't return the full set of experiments, the call returns a token for getting the next set of experiments.

iv_maxresults TYPE /AWS1/SGMMAXRESULTS /AWS1/SGMMAXRESULTS

The maximum number of experiments to return in the response. The default value is 10.

RETURNING

oo_output TYPE REF TO /aws1/cl_sgmlistexperimentsrsp /AWS1/CL_SGMLISTEXPERIMENTSRSP

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->listexperiments(
  iv_createdafter = '20150101000000.0000000'
  iv_createdbefore = '20150101000000.0000000'
  iv_maxresults = 123
  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_experimentsummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_experimentarn = lo_row_1->get_experimentarn( ).
      lv_experimententityname = lo_row_1->get_experimentname( ).
      lv_experimententityname = lo_row_1->get_displayname( ).
      lo_experimentsource = lo_row_1->get_experimentsource( ).
      IF lo_experimentsource IS NOT INITIAL.
        lv_experimentsourcearn = lo_experimentsource->get_sourcearn( ).
        lv_sourcetype = lo_experimentsource->get_sourcetype( ).
      ENDIF.
      lv_timestamp = lo_row_1->get_creationtime( ).
      lv_timestamp = lo_row_1->get_lastmodifiedtime( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.