Skip to content

/AWS1/IF_OMX=>LISTRUNSINBATCH()

About ListRunsInBatch

Returns a paginated list of individual workflow runs within a specific batch. Use this operation to map each runSettingId to its HealthOmics-generated runId, and to check the submission status of each run. Only one filter per call is supported.

Method Signature

METHODS /AWS1/IF_OMX~LISTRUNSINBATCH
  IMPORTING
    !IV_BATCHID TYPE /AWS1/OMXBATCHID OPTIONAL
    !IV_MAXITEMS TYPE /AWS1/OMXINTEGER OPTIONAL
    !IV_STARTINGTOKEN TYPE /AWS1/OMXLISTTOKEN OPTIONAL
    !IV_SUBMISSIONSTATUS TYPE /AWS1/OMXSUBMISSIONSTATUS OPTIONAL
    !IV_RUNSETTINGID TYPE /AWS1/OMXSTRING OPTIONAL
    !IV_RUNID TYPE /AWS1/OMXSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_omxlistrunsinbatchrsp
  RAISING
    /AWS1/CX_OMXACCESSDENIEDEX
    /AWS1/CX_OMXCONFLICTEXCEPTION
    /AWS1/CX_OMXINTERNALSERVEREX
    /AWS1/CX_OMXREQUESTTIMEOUTEX
    /AWS1/CX_OMXRESOURCENOTFOUNDEX
    /AWS1/CX_OMXSERVICEQUOTAEXCDEX
    /AWS1/CX_OMXTHROTTLINGEX
    /AWS1/CX_OMXVALIDATIONEX
    /AWS1/CX_OMXCLIENTEXC
    /AWS1/CX_OMXSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_batchid TYPE /AWS1/OMXBATCHID /AWS1/OMXBATCHID

The identifier portion of the run batch ARN.

Optional arguments:

iv_maxitems TYPE /AWS1/OMXINTEGER /AWS1/OMXINTEGER

The maximum number of runs to return.

iv_startingtoken TYPE /AWS1/OMXLISTTOKEN /AWS1/OMXLISTTOKEN

A pagination token returned from a prior ListRunsInBatch call.

iv_submissionstatus TYPE /AWS1/OMXSUBMISSIONSTATUS /AWS1/OMXSUBMISSIONSTATUS

Filter runs by submission status.

iv_runsettingid TYPE /AWS1/OMXSTRING /AWS1/OMXSTRING

Filter runs by the customer-provided run setting ID.

iv_runid TYPE /AWS1/OMXSTRING /AWS1/OMXSTRING

Filter runs by the HealthOmics-generated run ID.

RETURNING

oo_output TYPE REF TO /aws1/cl_omxlistrunsinbatchrsp /AWS1/CL_OMXLISTRUNSINBATCHRSP

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->listrunsinbatch(
  iv_batchid = |string|
  iv_maxitems = 123
  iv_runid = |string|
  iv_runsettingid = |string|
  iv_startingtoken = |string|
  iv_submissionstatus = |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_runs( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_runsettingid = lo_row_1->get_runsettingid( ).
      lv_runid = lo_row_1->get_runid( ).
      lv_runuuid = lo_row_1->get_runinternaluuid( ).
      lv_runarn = lo_row_1->get_runarn( ).
      lv_submissionstatus = lo_row_1->get_submissionstatus( ).
      lv_submissionfailurereason = lo_row_1->get_submissionfailurereason( ).
      lv_submissionfailuremessag = lo_row_1->get_submissionfailuremessage( ).
    ENDIF.
  ENDLOOP.
  lv_listtoken = lo_result->get_nexttoken( ).
ENDIF.