Skip to content

/AWS1/CL_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

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