/AWS1/IF_SGM=>LISTTRIALS()

About ListTrials

Lists the trials in your account. Specify an experiment name to limit the list to the trials that are part of that experiment. Specify a trial component name to limit the list to the trials that associated with that trial component. The list can be filtered to show only trials that were created in a specific time range. The list can be sorted by trial name or creation time.

Method Signature

METHODS /AWS1/IF_SGM~LISTTRIALS
  IMPORTING
    !IV_EXPERIMENTNAME TYPE /AWS1/SGMEXPERIMENTENTITYNAME OPTIONAL
    !IV_TRIALCOMPONENTNAME TYPE /AWS1/SGMEXPERIMENTENTITYNAME OPTIONAL
    !IV_CREATEDAFTER TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IV_CREATEDBEFORE TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IV_SORTBY TYPE /AWS1/SGMSORTTRIALSBY OPTIONAL
    !IV_SORTORDER TYPE /AWS1/SGMSORTORDER OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/SGMMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/SGMNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgmlisttrialsresponse
  RAISING
    /AWS1/CX_SGMRESOURCENOTFOUND
    /AWS1/CX_SGMCLIENTEXC
    /AWS1/CX_SGMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_experimentname TYPE /AWS1/SGMEXPERIMENTENTITYNAME /AWS1/SGMEXPERIMENTENTITYNAME

A filter that returns only trials that are part of the specified experiment.

iv_trialcomponentname TYPE /AWS1/SGMEXPERIMENTENTITYNAME /AWS1/SGMEXPERIMENTENTITYNAME

A filter that returns only trials that are associated with the specified trial component.

iv_createdafter TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

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

iv_createdbefore TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

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

iv_sortby TYPE /AWS1/SGMSORTTRIALSBY /AWS1/SGMSORTTRIALSBY

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_maxresults TYPE /AWS1/SGMMAXRESULTS /AWS1/SGMMAXRESULTS

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

iv_nexttoken TYPE /AWS1/SGMNEXTTOKEN /AWS1/SGMNEXTTOKEN

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

RETURNING

oo_output TYPE REF TO /aws1/cl_sgmlisttrialsresponse /AWS1/CL_SGMLISTTRIALSRESPONSE

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->listtrials(
  iv_createdafter = '20150101000000.0000000'
  iv_createdbefore = '20150101000000.0000000'
  iv_experimentname = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_sortby = |string|
  iv_sortorder = |string|
  iv_trialcomponentname = |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_trialsummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_trialarn = lo_row_1->get_trialarn( ).
      lv_experimententityname = lo_row_1->get_trialname( ).
      lv_experimententityname = lo_row_1->get_displayname( ).
      lo_trialsource = lo_row_1->get_trialsource( ).
      IF lo_trialsource IS NOT INITIAL.
        lv_trialsourcearn = lo_trialsource->get_sourcearn( ).
        lv_sourcetype = lo_trialsource->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.