LISTBATCH()`¶

About ListBatch¶

Returns a list of run batches in your account, with optional filtering by status, name, or run group. Results are paginated. Only one filter per call is supported.

Method Signature¶

METHODS /AWS1/IF_OMX~LISTBATCH
  IMPORTING
    !IV_MAXITEMS TYPE /AWS1/OMXINTEGER OPTIONAL
    !IV_STARTINGTOKEN TYPE /AWS1/OMXLISTTOKEN OPTIONAL
    !IV_STATUS TYPE /AWS1/OMXBATCHSTATUS OPTIONAL
    !IV_NAME TYPE /AWS1/OMXBATCHNAME OPTIONAL
    !IV_RUNGROUPID TYPE /AWS1/OMXRUNGROUPID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_omxlistbatchresponse
  RAISING
    /AWS1/CX_OMXACCESSDENIEDEX
    /AWS1/CX_OMXINTERNALSERVEREX
    /AWS1/CX_OMXREQUESTTIMEOUTEX
    /AWS1/CX_OMXTHROTTLINGEX
    /AWS1/CX_OMXVALIDATIONEX
    /AWS1/CX_OMXCLIENTEXC
    /AWS1/CX_OMXSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_maxitems` `TYPE /AWS1/OMXINTEGER` `/AWS1/OMXINTEGER`¶

The maximum number of batches to return. If not specified, defaults to 100.

`iv_startingtoken` `TYPE /AWS1/OMXLISTTOKEN` `/AWS1/OMXLISTTOKEN`¶

A pagination token returned from a prior ListBatch call.

`iv_status` `TYPE /AWS1/OMXBATCHSTATUS` `/AWS1/OMXBATCHSTATUS`¶

Filter batches by status.

`iv_name` `TYPE /AWS1/OMXBATCHNAME` `/AWS1/OMXBATCHNAME`¶

Filter batches by name.

`iv_rungroupid` `TYPE /AWS1/OMXRUNGROUPID` `/AWS1/OMXRUNGROUPID`¶

Filter batches by run group ID.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_omxlistbatchresponse` `/AWS1/CL_OMXLISTBATCHRESPONSE`¶

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->listbatch(
  iv_maxitems = 123
  iv_name = |string|
  iv_rungroupid = |string|
  iv_startingtoken = |string|
  iv_status = |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_items( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_batchid = lo_row_1->get_id( ).
      lv_batchname = lo_row_1->get_name( ).
      lv_batchstatus = lo_row_1->get_status( ).
      lv_batchtimestamp = lo_row_1->get_createdat( ).
      lv_integer = lo_row_1->get_totalruns( ).
      lv_workflowid = lo_row_1->get_workflowid( ).
    ENDIF.
  ENDLOOP.
  lv_listtoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_OMX=>LISTBATCH()¶